1. Types
  2. appliance
  3. networking
  4. interfaces
  5. ipv4

appliance networking interfaces ipv4: info

The info structure defines current IPv4 configuration state of a network interface. This structure was added in vSphere API 6.7.

Representation:

{
    "mode" : "DHCP",
    "default_gateway" : "string",
    "address" : "string",
    "prefix" : 1,
    "configurable" : true
}

Attributes:

Name Type Description
Required
configurable boolean The specified network interface is configurable or not. This attribute was added in vSphere API 6.7.
mode string The Address assignment mode. This attribute was added in vSphere API 6.7.

Defines different IPv4 address assignment modes. This enumeration was added in vSphere API 6.7. Value is one of:
DHCP: The IPv4 address is automatically assigned by a DHCP server. This constant was added in vSphere API 6.7.
STATIC: The IPv4 address is static. This constant was added in vSphere API 6.7.
UNCONFIGURED: The IPv4 protocol is not configured. This constant was added in vSphere API 6.7.
Optional
address string The IPv4 address, for example, "10.20.80.191". This attribute was added in vSphere API 6.7.

Optional. It is only relevant when mode has value [STATIC, DHCP]. This field is optional and it is only relevant when the value of mode is one of STATIC or DHCP.
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 6.7.

Optional. It is only relevant when mode has value [STATIC, DHCP]. This field is optional and it is only relevant when the value of mode is one of STATIC or DHCP.
default_gateway string The IPv4 address of the default gateway. This configures the global default gateway on the appliance with the specified gateway address and interface. This gateway replaces the existing default gateway configured on the appliance. However, if the gateway address is link-local, then it is added for that interface. This does not support configuration of multiple global default gateways through different interfaces. This attribute was added in vSphere API 6.7.

Optional. It is only relevant when mode has value [STATIC, DHCP]. This field is optional and it is only relevant when the value of mode is one of STATIC or DHCP.