REST API - IP_settings

vcenter guest: IP settings

The IP_settings structure specifies the IP settings for a virtual network adapter. This structure was added in vSphere API 7.0.0.0.

Representation:

JSON

{
    "ipv4" : {
        "gateways" : [
            "string",
            "string"
        ],
        "prefix" : 1,
        "ip_address" : "string",
        "type" : "DHCP"
    },
    "ipv6" : {
        "gateways" : [
            "string",
            "string"
        ],
        "ipv6" : [
            {
                "prefix" : 1,
                "ip_address" : "string"
            },
            {
                "prefix" : 1,
                "ip_address" : "string"
            }
        ],
        "type" : "DHCP"
    },
    "windows" : {
        "dns_domain" : "string",
        "wins_servers" : [
            "string",
            "string"
        ],
        "net_BIOS_mode" : "USE_DHCP",
        "dns_servers" : [
            "string",
            "string"
        ]
    }
}

Attributes:

Name	Type	Description
Required
ipv4.type	string	The type of the IPv4 configuration. This attribute was added in vSphere API 7.0.0.0. Specifies different types of the IPv4 configuration. This enumeration was added in vSphere API 7.0.0.0. Value is one of: DHCP: DHCP configuration. This constant was added in vSphere API 7.0.0.0. STATIC: Static configuration. This constant was added in vSphere API 7.0.0.0. USER_INPUT_REQUIRED: Indicates that the IPv4 settings are not specified in advance. The user must provide a valid value when the actual customization spec is applied to a virtual machine. This constant was added in vSphere API 7.0.0.0.
ipv6.type	string	The IPv6 configuration type. This attribute was added in vSphere API 7.0.0.0. Specifies different types of the IPv6 configuration. This enumeration was added in vSphere API 7.0.0.0. Value is one of: DHCP: DHCP IPv6 configuration. This constant was added in vSphere API 7.0.0.0. STATIC: Static IPv6 configuration. This constant was added in vSphere API 7.0.0.0. USER_INPUT_REQUIRED: Indicates that the IPv6 settings are not specified in advance. The user must provide a valid value when the actual customization spec is applied to a virtual machine. This constant was added in vSphere API 7.0.0.0.
Optional
ipv4	ipv4	Specification to configure IPv4 address, subnet mask and gateway info for this virtual network adapter. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no IPv4 addresses are set.
ipv4.ip_address	string	The static IPv4 address. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when type has value STATIC. This field is optional and it is only relevant when the value of `type` is STATIC.
ipv4.prefix	long	The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when type has value STATIC. This field is optional and it is only relevant when the value of `type` is STATIC.
ipv4.gateways	string[]	Gateways for the IPv4 address. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no gateways are set.
ipv6	ipv6	Specification to configure IPv6 address, subnet mask and gateway info for this virtual network adapter. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no IPv6 addresses are set.
ipv6.ipv6	ipv6_address[]	IPv6 address. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when type has value STATIC. This field is optional and it is only relevant when the value of `type` is STATIC.
ipv6.gateways	string[]	gateways for the IPv6 address. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no gateways are set.
windows	windows_network_adapter_settings	Windows settings to be configured for this specific virtual Network adapter. This is valid only for Windows guest operating systems. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no specific Windows settings are set.
windows.dns_servers	string[]	A list of server IP addresses to use for DNS lookup in a Windows guest operating system. These servers should be specified in the order of preference. If this list is not empty, and if a DHCP IP address is used, then these settings override the DHCP settings. . This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no DNS servers are set.
windows.dns_domain	string	A DNS domain suffix such as vmware.com. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no DNS domain is set.
windows.wins_servers	string[]	List of WINS Servers to set for the Windows guest operating system. A Maximum of two IP addresses can be specified in this list. The first IP address will be set as the primary WINS server. The second IP address will be set as the secondary WINS server. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, no WINS Servers are set.
windows.net_BIOS_mode	string	NetBIOS setting for Windows. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, existing NetBIOS mode will be retained.