NSX-T Data Center REST API

ContainerIpPool (type)

{
  "description": "Details of Container Ip Pool.", 
  "extends": {
    "$ref": "DiscoveredResource
  }, 
  "id": "ContainerIpPool", 
  "module_id": "InventoryContainerObj", 
  "properties": {
    "_last_sync_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "container_cluster_id": {
      "description": "Specifies identifier of the container cluster this container ip pool belongs to.", 
      "readonly": false, 
      "required": false, 
      "title": "Identifier of the container cluster", 
      "type": "string"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "external_id": {
      "description": "Specifies identifier of the container ip pool.", 
      "readonly": false, 
      "required": true, 
      "title": "External identifier of the container ip pool", 
      "type": "string"
    }, 
    "ip_ranges": {
      "description": "Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.", 
      "items": {
        "$ref": "SubnetIpRange
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of IP ranges with subnet details", 
      "type": "array"
    }, 
    "ip_version": {
      "description": "Specifies IP version of container IP pool.", 
      "enum": [
        4, 
        6
      ], 
      "readonly": false, 
      "required": false, 
      "title": "IP version of ContainerIpPool", 
      "type": "integer"
    }, 
    "origin_properties": {
      "description": "Array of additional specific properties of container ip pool in key-value format.", 
      "items": {
        "$ref": "KeyValuePair
      }, 
      "readonly": false, 
      "required": false, 
      "title": "Origin properties", 
      "type": "array"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "required": true, 
      "type": "string"
    }, 
    "scope": {
      "description": "Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.", 
      "items": {
        "$ref": "DiscoveredResourceScope
      }, 
      "readonly": false, 
      "required": false, 
      "title": "List of scopes for discovered resource", 
      "type": "array"
    }, 
    "spec": {
      "description": "This specifies yaml definition of ContainerIpPool resource.", 
      "readonly": false, 
      "required": false, 
      "title": "Container ip pool specification", 
      "type": "string"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }
  }, 
  "title": "Container Ip Pool", 
  "type": "object"
}