appliance networking interfaces: get
Get information about a particular network interface.
Request:
HTTP request
GET https://{server}/rest/appliance/networking/interfaces/{interface_name}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| interface_name | string | Network interface, for example, "nic0". |
Response:
HTTP Status Code: 200
Representations:
{
"value": {
"mac": "string",
"name": "string",
"status": "down"
}
}
"value": {
"mac": "string",
"name": "string",
"status": "down"
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/networking/interfaces" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<status>down</status>
<name>string</name>
<mac>string</mac>
</value>
</ns0:Get-Result>
<ns0:Get-Result xmlns:ns0="http://vmware.com/appliance/networking/interfaces" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<status>down</status>
<name>string</name>
<mac>string</mac>
</value>
</ns0:Get-Result>
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | interface_info | Network interface information. |
| value.name | string | Interface name, for example, "nic0", "nic1". |
| value.status | string | Interface status. Defines interface status Value is one of: down: The interface is down. up: The interface is up. |
| value.mac | string | MAC address. For example 00:0C:29:94:BB:5A. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | Generic error |