This API has a deprecated equivalent from v7.0U1.
Get Interfaces IPv4
Get IPv4 network configuration for specific NIC.
Request
URLURL
https://{api_host}/api/appliance/networking/interfaces/{interface_name}/ipv4
Path Parameters
Path Parameters
string
interface_name
Required
The Network interface to query, for example, “nic0”. The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NetworkingInterfacesIpv4Info
of type application/json
The IPv4 configuration for the queried NIC.
{
"address": "string",
"configurable": false,
"default_gateway": "string",
"mode": "DHCP",
"prefix": 0
}
boolean
configurable
Required
The specified network interface is configurable or not.
mode
Required
The Ipv4.Mode enumerated type defines different IPv4 address assignment modes.
DHCP : The IPv4 address is automatically assigned by a DHCP server.
STATIC : The IPv4 address is static.
UNCONFIGURED : The IPv4 protocol is not configured.
Possible values are: DHCP , STATIC , UNCONFIGURED
string
address
Optional
The IPv4 address, for example, “10.20.80.191”. This field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.
string
default_gateway
Optional
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 field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.
integer
prefix
Optional
The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. This field is optional and it is only relevant when the value of Ipv4.Info.mode is one of STATIC or DHCP.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/networking/interfaces/{interface_name}/ipv4
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/networking/interfaces/{interface_name}/ipv4
x-vmw-doc-operation: get
Availability
Added in 7.0U2
