appliance networking interfaces: list
Get list of available network interfaces, including those that are not yet configured.
Request:
HTTP request
GET https://{server}/rest/appliance/networking/interfaces
No request parameters
Response:
HTTP Status Code: 200
Representations:
{
"value": [
{
"mac": "string",
"name": "string",
"status": "down"
},
{
"mac": "string",
"name": "string",
"status": "down"
}
]
}
"value": [
{
"mac": "string",
"name": "string",
"status": "down"
},
{
"mac": "string",
"name": "string",
"status": "down"
}
]
}
<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/appliance/networking/interfaces" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value-array>
<array-item>
<status>down</status>
<name>string</name>
<mac>string</mac>
</array-item>
<array-item>
<status>down</status>
<name>string</name>
<mac>string</mac>
</array-item>
</value-array>
</ns0:List-Result>
<ns0:List-Result xmlns:ns0="http://vmware.com/appliance/networking/interfaces" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value-array>
<array-item>
<status>down</status>
<name>string</name>
<mac>string</mac>
</array-item>
<array-item>
<status>down</status>
<name>string</name>
<mac>string</mac>
</array-item>
</value-array>
</ns0:List-Result>
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | interface_info[] | List of InterfaceInfo structures. |
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 |