Vcenter NamespaceManagement Networks IPManagement

Vcenter NamespaceManagement Networks IPManagement
Vcenter NamespaceManagement Networks IPManagement

Vcenter NamespaceManagement Networks IPManagement schema dictates IP addressing configuration for the network that hosts the Supervisor.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "dhcp_enabled": false,
    "gateway_address": "string",
    "ip_assignments": [
        {
            "assignee": "string",
            "ranges": [
                {
                    "address": "string",
                    "count": 0
                }
            ]
        }
    ]
}
boolean
dhcp_enabled
Optional

Vcenter NamespaceManagement Networks IPManagement.dhcp_enabled If set true, configures IP address using the DHCP server on the broadcast domain unless the corresponding Vcenter NamespaceManagement Networks IPManagement.ip_assignments are set.

This property was added in vSphere API 8.0.0.1.

If missing or null this field defaults to true.

string
gateway_address
Optional

Vcenter NamespaceManagement Networks IPManagement.gateway_address is the IP address combined with the subnet prefix length (e.g. 192.168.1.1/24) of the default gateway of this network.

This property was added in vSphere API 8.0.0.1.

If Vcenter NamespaceManagement Networks IPManagement.dhcp_enabled is not set, or this is an NSX network, this address must be set.

ip_assignments
Optional

Vcenter NamespaceManagement Networks IPManagement.ip_assignments are a list of roles that can be allocated to IP addresses. If Vcenter NamespaceManagement Networks IPManagement.gateway_address is specified, these assignments must be on the same subnet.

This property was added in vSphere API 8.0.0.1.

These assignments are optional when using DHCP.