[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Create Or Replace Gateway Policy Rule
DescriptionUpdate the gateway rule. Create new rule if a rule with the rule-id is not already present.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Path Parameters
Path Parameters
string
domain-id
Required
string
gateway-policy-id
Required
string
rule-id
Required
Request Body
Request Body
Rule
of type(s) application/json
Required
This request body class requires all of the following:
BaseRule, InlineRule1
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
Rule
of type(s) application/json
This response body class contains all of the following:
BaseRule, InlineRule1
Errors
Code Samples
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-ResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-SelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-Tag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-PolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-ChildPolicyConfigResource -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -MarkForOverride $false -MarkedForDelete $false -RequestParameter $PolicyRequestParameter
$ServiceEntry = Initialize-ServiceEntry -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "IPProtocolServiceEntry" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false
$Rule = Initialize-Rule -Links $ResourceLink -Schema "MySchema" -Self $SelfResourceLink -Revision 0 -CreateTime 0 -CreateUser "MyCreateUser" -LastModifiedTime 0 -LastModifiedUser "MyLastModifiedUser" -Protection "MyProtection" -SystemOwned $false -Description "MyDescription" -DisplayName "MyDisplayName" -Id "MyId" -ResourceType "MyResourceType" -Tags $Tag -ParentPath "MyParentPath" -Path "MyPath" -RealizationId "MyRealizationId" -RelativePath "MyRelativePath" -UniqueId "MyUniqueId" -Children $ChildPolicyConfigResource -MarkedForDelete $false -Overridden $false -DestinationGroups "MyDestinationGroups" -DestinationsExcluded $false -Direction "IN" -Disabled $false -IpProtocol "IPV4" -IsDefault $false -Logged $false -Notes "MyNotes" -Profiles "MyProfiles" -RuleId 0 -Scope "MyScope" -SequenceNumber 0 -ServiceEntries $ServiceEntry -Services "MyServices" -SourceGroups "MySourceGroups" -SourcesExcluded $false -Tag "MyTag" -Action "ALLOW"
Invoke-CreateOrReplaceGatewayRule -domainId "MydomainId" -gatewayPolicyId "MygatewayPolicyId" -ruleId "MyruleId" -rule $rule
cURL Command
curl -X PUT -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/gateway-policies/{gateway-policy-id}/rules/{rule-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-or-replace-gateway-policy-rule
x-vmw-nsx-module: PolicyEdgeFirewall
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Domains Operations
delete
delete
