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

List Forwarding Rules

Description

List rules

Request

Request

URL

URL


get
https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules
Copy

Path Parameters

Path Parameters

string
domain-id Required

Domain id


string
forwarding-policy-id Required

Forwarding map 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 ForwardingRuleListResult of type(s) application/json
This response body class contains all of the following: BaseRuleListResult, InlineForwardingRuleListResult1
Errors

Errors

400

Bad Request


403

Forbidden


404

Not Found


412

Precondition Failed


500

Internal Server Error


503

Service Unavailable

Code Samples

Code Samples

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/domains/{domain-id}/forwarding-policies/{forwarding-policy-id}/rules
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?