This API has a deprecated equivalent from v7.0U1.
Get Interfaces
Get information about a particular network interface.
Request
URLURL
https://{api_host}/api/appliance/networking/interfaces/{interface_name}
Path Parameters
Path Parameters
string
interface_name
Required
Network interface, 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
NetworkingInterfacesInterfaceInfo
of type application/json
Network interface information.
{
"ipv4": {
"address": "string",
"configurable": false,
"default_gateway": "string",
"mode": "DHCP",
"prefix": 0
},
"ipv6": {
"addresses": [
{
"address": "string",
"origin": "DHCP",
"prefix": 0,
"status": "TENTATIVE"
}
],
"autoconf": false,
"configurable": false,
"default_gateway": "string",
"dhcp": false
},
"mac": "string",
"name": "string",
"status": "down"
}
string
mac
Required
MAC address. For example 00:0C:29:94:BB:5A.
string
name
Required
Interface name, for example, “nic0”, “nic1”.
status
Required
Interfaces.InterfaceStatus enumerated type Defines interface status
down : The interface is down.
up : The interface is up.
Possible values are: down , up
ipv4
Optional
IPv4 Address information. ipv4 This field will be unset if IPv4 is not enabled.
ipv6
Optional
IPv6 Address information. ipv6 This field will be unset if IPv6 is not enabled.
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}
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}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Interfaces Operations
get
get
