NSX-T Data Center REST API

IpMappingsListRequestParameters (type)

{
  "additionalProperties": false, 
  "description": "These paramaters will be used to filter the list of IP allocation mappings. Multiple parameters can be given as input to 'AND' them.", 
  "extends": {
    "$ref": "ListRequestParameters
  }, 
  "id": "IpMappingsListRequestParameters", 
  "module_id": "CloudServiceManager", 
  "properties": {
    "cloud_account_id": {
      "description": "ID of the Cloud Account in which the IPs are allocated.", 
      "required": false, 
      "title": "Cloud Account ID", 
      "type": "string"
    }, 
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "display_name": {
      "description": "Name of IP Mappings.", 
      "required": false, 
      "title": "Name of IP Mappings", 
      "type": "string"
    }, 
    "included_fields": {
      "description": "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.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "ip_allocation_type": {
      "default": "PAS", 
      "description": "Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.", 
      "enum": [
        "PAS", 
        "NAT"
      ], 
      "required": false, 
      "title": "IP allocation type", 
      "type": "string"
    }, 
    "mapping_id": {
      "description": "ID of the mapping returned in IP allocation request.", 
      "required": false, 
      "title": "Mapping ID", 
      "type": "string"
    }, 
    "page_size": {
      "default": 1000, 
      "maximum": 1000, 
      "minimum": 0, 
      "title": "Maximum number of results to return in this page (server may return fewer)", 
      "type": "integer"
    }, 
    "sort_ascending": {
      "type": "boolean"
    }, 
    "sort_by": {
      "title": "Field by which records are sorted", 
      "type": "string"
    }
  }, 
  "type": "object"
}