NSX-T Data Center REST API

IpAddressBlockUsage (type)

{
  "additionalProperties": false,
  "description": "Shows used IP ranges and available IP ranges statistics of an IpAddressBlock.",
  "id": "IpAddressBlockUsage",
  "module_id": "PolicyIpam",
  "properties": {
    "address_type": {
      "description": "Represents the type of Ip Address for all CIDRs and ranges within the Ip Address Block",
      "enum": [
        "IPV4",
        "IPV6"
      ],
      "nsx_feature": "IPSpaces",
      "title": "IpAddress Type",
      "type": "string"
    },
    "available_ip_ranges": {
      "description": "This represents available ip ranges of an IpAddressBlock.",
      "items": {
        "type": "string"
      },
      "readonly": true,
      "title": "Available IP ranges in an IpAddressBlock",
      "type": "array"
    },
    "available_ips_count": {
      "description": "This represents total count of IPs which are not assigned to any subnet.",
      "readonly": true,
      "title": "Available IPs count in IpAddressBlock",
      "type": "string"
    },
    "cidr_usage": {
      "description": "This represents Usage details for each CIDR of IpAddressBlock",
      "items": {
        "$ref": "CidrUsageDetails"
      },
      "nsx_feature": "IPSpaces",
      "title": "CIDR usage details",
      "type": "array"
    },
    "description": {
      "nsx_feature": "IPSpaces",
      "type": "string"
    },
    "display_name": {
      "nsx_feature": "IPSpaces",
      "type": "string"
    },
    "intent_path": {
      "description": "This represents policy path of IpAddressBlock",
      "nsx_feature": "IPSpaces",
      "title": "IpAddressBlock policy path",
      "type": "string"
    },
    "overall_ips_count": {
      "description": "This represents total count of IPs which are present in this block.",
      "nsx_feature": "IPSpaces",
      "readonly": true,
      "title": "Total IPs count in IpAddressBlock",
      "type": "string"
    },
    "range_usage": {
      "description": "This represents Usage details for each IPRange of IpAddressBlock",
      "items": {
        "$ref": "RangeUsageDetails"
      },
      "nsx_feature": "IPSpaces",
      "title": "Range usage details",
      "type": "array"
    },
    "used_ip_ranges": {
      "description": "This represents used ip ranges of an IpAddressBlock.",
      "items": {
        "type": "string"
      },
      "readonly": true,
      "title": "Used IP ranges in an IpAddressBlock",
      "type": "array"
    },
    "used_ips_count": {
      "description": "This represents total count of IPs which are assigned to subnets from this block.",
      "readonly": true,
      "title": "Used IPs count in IpAddressBlock",
      "type": "string"
    },
    "visibility": {
      "description": "Represents visibility or scope of IpAddressBlock and expected consumption of IpAddressBlock with same scope.",
      "enum": [
        "PRIVATE",
        "EXTERNAL"
      ],
      "nsx_feature": "IPSpaces",
      "title": "Visibility of IpAddressBlock",
      "type": "string"
    }
  },
  "title": "IP usage statistics of an IpAddressBlock.",
  "type": "object"
}