REST API - set
  1. Operations
  2. appliance
  3. networking
  4. interfaces
  5. ipv4

appliance networking interfaces ipv4: set

Set IPv4 network configuration for specific network interface. This operation was added in vSphere API 6.7.

Request:

HTTP request

PUT https://{server}/rest/appliance/networking/interfaces/{interface_name}/ipv4

Path Parameters

Name Type Description
Required
interface_name string Network interface to update, for example, "nic0".

Request Body Structure:

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

Request Body Parameters:

Name Type Description
bold = required
config config The IPv4 Network configuration to set.
config.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.
config.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. This field is optional and it is only relevant when the value of mode is STATIC.
config.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. This field is optional and it is only relevant when the value of mode is STATIC.
config.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. If unset, the defaultGateway was never set.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
404 not_found if the specified NIC is not found.
400 not_allowed_in_current_state if the IP is used as PNID
500 resource_busy if the specified NIC is busy.
500 error Generic error.