Vcenter Namespaces Networks Nsx VpcConnectivityProfileInfo

The Vcenter Namespaces Networks Nsx VpcConnectivityProfileInfo provides information of NSX VPC Connectivity Profile.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "profile": "string",
    "name": "string",
    "nsx_path": "string",
    "description": "string",
    "default_profile": false,
    "transit_gateway": {
        "nsx_path": "string",
        "network_stack": "string"
    },
    "external_ip_blocks": [
        {
            "path": "string",
            "name": "string",
            "cidr": {
                "address": "string",
                "prefix": 0
            },
            "cidrs": [
                {
                    "address": "string",
                    "prefix": 0
                }
            ],
            "ranges": [
                {
                    "address": "string",
                    "count": 0
                }
            ],
            "available_ip_ranges": [
                {
                    "address": "string",
                    "count": 0
                }
            ],
            "cidr_usages": [
                {
                    "cidr": "string",
                    "available_ip_ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ]
                }
            ],
            "range_usages": [
                {
                    "ip_range": "string",
                    "available_ip_ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ]
                }
            ],
            "used_ip_count": 0,
            "available_ip_count": 0
        }
    ],
    "privatetgw_ip_blocks": [
        {
            "path": "string",
            "name": "string",
            "cidr": {
                "address": "string",
                "prefix": 0
            },
            "cidrs": [
                {
                    "address": "string",
                    "prefix": 0
                }
            ],
            "ranges": [
                {
                    "address": "string",
                    "count": 0
                }
            ],
            "available_ip_ranges": [
                {
                    "address": "string",
                    "count": 0
                }
            ],
            "cidr_usages": [
                {
                    "cidr": "string",
                    "available_ip_ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ]
                }
            ],
            "range_usages": [
                {
                    "ip_range": "string",
                    "available_ip_ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ]
                }
            ],
            "used_ip_count": 0,
            "available_ip_count": 0
        }
    ]
}

string

profile

Required

Identifier of the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.VpcConnectivityProfile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.VpcConnectivityProfile.

string

name

Required

Name of the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

string

nsx_path

Required

NSX path of the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

string

description

Optional

Description of the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

If missing or null, no description is added to the VPC Connectivity Profile.

boolean

default_profile

Required

true if this profile is the default connectivity profile in NSX project, false otherwise.

This property was added in vSphere API 9.0.0.0.

transit_gateway

Optional

Transit gateway currently configured with the VPC Connectivity Profile.

This property was added in vSphere API 9.1.1.0.

This property is optional because it was added in a newer version than its parent node.

array of Vcenter Namespaces Networks Nsx IPBlockInfo

external_ip_blocks

Optional

List of NSX External IP Blocks currently configured with the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

If missing or null, no external IP blocks are defined in the VPC Connectivity Profile.

array of Vcenter Namespaces Networks Nsx IPBlockInfo

privatetgw_ip_blocks

Optional

List of NSX Private (Transit Gateway) IP Blocks currently configured with the VPC Connectivity Profile.

This property was added in vSphere API 9.0.0.0.

If missing or null, no private TGW IP blocks are defined in the VPC Connectivity Profile.