NSX-T Data Center REST API
IpMappingsListRequestParameters (schema)
These paramaters will be used to filter the list of IP allocation mappings.
Multiple parameters can be given as input to 'AND' them.
Name | Description | Type | Notes |
---|---|---|---|
cloud_account_id | Cloud Account ID ID of the Cloud Account in which the IPs are allocated. |
string | |
cursor | Opaque cursor to be used for getting next page of records (supplied by current result page) | string | |
display_name | Name of IP Mappings Name of IP Mappings. |
string | |
included_fields | Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
string | |
ip_allocation_type | IP allocation type Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT. |
string | Enum: PAS, NAT Default: "PAS" |
mapping_id | Mapping ID ID of the mapping returned in IP allocation request. |
string | |
page_size | Maximum number of results to return in this page (server may return fewer) | integer | Minimum: 0 Maximum: 1000 Default: "1000" |
sort_ascending | boolean | ||
sort_by | Field by which records are sorted | string |