appliance techpreview networking ipv4: list
Get IPv4 network configuration for all configured interfaces.
Request:
HTTP request
GET https://{server}/rest/appliance/techpreview/networking/ipv4
No request parameters
Response:
HTTP Status Code: 200
Representations:
{
"value": [
{
"address": "string",
"default_gateway": "string",
"interface_name": "string",
"mode": "dhcp",
"prefix": 1,
"updateable": true
},
{
"address": "string",
"default_gateway": "string",
"interface_name": "string",
"mode": "dhcp",
"prefix": 1,
"updateable": true
}
]
}
"value": [
{
"address": "string",
"default_gateway": "string",
"interface_name": "string",
"mode": "dhcp",
"prefix": 1,
"updateable": true
},
{
"address": "string",
"default_gateway": "string",
"interface_name": "string",
"mode": "dhcp",
"prefix": 1,
"updateable": true
}
]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/appliance/techpreview/networking/ipv4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value-array>
<array-item>
<updateable>true</updateable>
<address>string</address>
<prefix>1</prefix>
<interface_name>string</interface_name>
<default_gateway>string</default_gateway>
<mode>dhcp</mode>
</array-item>
<array-item>
<updateable>true</updateable>
<address>string</address>
<prefix>1</prefix>
<interface_name>string</interface_name>
<default_gateway>string</default_gateway>
<mode>dhcp</mode>
</array-item>
</value-array>
</ns0:List-Result>
<ns0:List-Result xmlns:ns0="http://vmware.com/appliance/techpreview/networking/ipv4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value-array>
<array-item>
<updateable>true</updateable>
<address>string</address>
<prefix>1</prefix>
<interface_name>string</interface_name>
<default_gateway>string</default_gateway>
<mode>dhcp</mode>
</array-item>
<array-item>
<updateable>true</updateable>
<address>string</address>
<prefix>1</prefix>
<interface_name>string</interface_name>
<default_gateway>string</default_gateway>
<mode>dhcp</mode>
</array-item>
</value-array>
</ns0:List-Result>
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | I_pv4_config_read_only[] | IPv4 configuration for each 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 |