[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
Update NAT Rule
DescriptionIf a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>, create a new NAT Rule. If it already exists, update the NAT Rule. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Path Parameters
Path Parameters
string
tier-1-id
Required
Tier-1 ID
string
nat-id
Required
NAT id
string
nat-rule-id
Required
Rule ID
Request Body
Request Body
PolicyNatRule
of type(s) application/json
Required
This request body class requires all of the following:
PolicyConfigResource, InlinePolicyNatRule1
Authentication
This operation uses the following authentication methods.
Errors
Errors
ApiError
400
Bad Request
ApiError
403
Forbidden
ApiError
404
Not Found
ApiError
412
Precondition Failed
ApiError
500
Internal Server Error
ApiError
503
Service Unavailable
Code Samples
PowerCLI Client SDK Example
$ResourceLink = Initialize-nullResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$SelfResourceLink = Initialize-nullSelfResourceLink -Action "MyAction" -Href "MyHref" -Rel "MyRel"
$Tag = Initialize-nullTag -Scope "MyScope" -_Tag "My_Tag"
$PolicyRequestParameter = Initialize-nullPolicyRequestParameter -ResourceType "MyResourceType"
$ChildPolicyConfigResource = Initialize-nullChildPolicyConfigResource -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
$PolicyNatRule = Initialize-nullPolicyNatRule -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 -Action "SNAT" -DestinationNetwork "MyDestinationNetwork" -Enabled $false -FirewallMatch "MATCH_EXTERNAL_ADDRESS" -Logging $false -PolicyBasedVpnMode "BYPASS" -Scope "MyScope" -SequenceNumber 0 -Service "MyService" -SourceNetwork "MySourceNetwork" -TranslatedNetwork "MyTranslatedNetwork" -TranslatedPorts "MyTranslatedPorts"
Invoke-PatchPolicyNatRule -tier1Id "Mytier1Id" -natId "MynatId" -natRuleId "MynatRuleId" -policyNatRule $policyNatRule
cURL Command
curl -X PATCH -H "Content-Type: application/json" -d '{}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update-nat-rule
x-vmw-nsx-module: PolicyNAT
[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy
On This Page
Tier 1s Operations
put
delete
get
get
patch
