[{"label":"Latest (v1.0)","version":"latest"}]
nsx-vmc-policy

Create NAT Rule

Description

Update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. 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

Request

URL

URL


put
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules/{nat-rule-id}
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PolicyNatRule of type(s) application/json
This response body class contains all of the following: PolicyConfigResource, InlinePolicyNatRule1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

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
$PolicyNatRule = Initialize-PolicyNatRule -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-CreateOrReplacePolicyNatRule -tier1Id "Mytier1Id" -natId "MynatId" -natRuleId "MynatRuleId" -policyNatRule $policyNatRule

cURL Command

curl -X PUT -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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create-nat-rule
x-vmw-nsx-module: PolicyNAT


Feedback

Was this page helpful?