REST API - get

appliance techpreview networking ipv4: get

Get IPv4 network configuration for interfaces.

Request:

HTTP request

POST https://{server}/rest/appliance/techpreview/networking/ipv4/get

Request Body Structure:

{
    "interfaces" : [
        "string",
        "string"
    ]
}

Request Body Parameters:

Name	Type	Description
bold = required
interfaces	string[]	Network interfaces to query, for example, "nic0".

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "mode" : "dhcp",
            "default_gateway" : "string",
            "updateable" : true,
            "address" : "string",
            "prefix" : 1,
            "interface_name" : "string"
        },
        {
            "mode" : "dhcp",
            "default_gateway" : "string",
            "updateable" : true,
            "address" : "string",
            "prefix" : 1,
            "interface_name" : "string"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	I_pv4_config_read_only[]	IPv4 configuration for each queried interface.
value[].interface_name	string	Interface name, for example, "nic0", "nic1".
value[].mode	string	Address assignment mode. Defines different IPv4 modes. Value is one of: dhcp: IPv4 address is automatically assigned by a DHCP server. is_static: IPv4 address is static. unconfigured: The IPv4 protocol is not configured.
value[].address	string	IPv4 address, for example, "10.20.80.191". Set this argument to an empty string "", if the mode is "unconfigured" or "dhcp".
value[].prefix	long	IPv4 CIDR prefix, for example , 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. Set this argument to 0 if the mode is "unconfigured" or "dhcp".
value[].default_gateway	string	IPv4 address of the default gateway. This default gateway value is used if the mode argument is set to "static" 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.
value[].updateable	boolean	This indicates if the network configuration can be updated for the interface.

Errors:

HTTP Status Code	Type	Description
500	error	Generic error