Get Networking
Get Networking information for all configured interfaces.
Request
URLURL
https://{api_host}/api/appliance/networking
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
NetworkingInfo of type application/json
The Map of network configuration info for all interfaces.
{
"dns": {
"hostname": "string",
"mode": "DHCP",
"servers": [
"string"
]
},
"interfaces": {
"key": {
"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"
}
}
}
interfaces
Required
Interface configuration as a key-value map where key is a network interface name, for example, “nic0”. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.appliance.networking.interfaces. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.appliance.networking.interfaces.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetNetworking
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/networking
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 6.7
