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

List NAT Rules

Description

List NAT Rules from 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


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

Path Parameters

Path Parameters

string
tier-1-id Required

Tier-1 ID


string
nat-id Required

NAT id


Query Parameters

Query Parameters

string
cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)


boolean
include_mark_for_delete_objects Optional

Include objects that are marked for deletion in results


string
included_fields Optional

Comma separated list of fields that should be included in query result


integer
page_size Optional

Maximum number of results to return in this page (server may return fewer)


boolean
sort_ascending Optional

string
sort_by Optional

Field by which records are sorted


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PolicyNatRuleListResult of type(s) application/json
This response body class contains all of the following: ListResult, InlinePolicyNatRuleListResult1
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

Invoke-ListPolicyNatRules -tier1Id "Mytier1Id" -natId "MynatId" -cursor "Mycursor" -includeMarkForDeleteObjects $true -includedFields "MyincludedFields" -pageSize 789 -sortAscending $true -sortBy "MysortBy"

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/nat/{nat-id}/nat-rules
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?