ON THIS PAGE
GET /system/servers/{server_id}/network_interfaces/ethernet
SUMMARY Retrieves a list of the ethernet network interfaces based on the supplied server ID.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
server_id |
path |
Required |
Number (Integer) |
text/plain |
Required - The id of the server. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
A list of the ethernet network interfaces were retrieved. |
|
404 |
1002 |
The requested server with the given server ID cannot be found. |
422 |
1005 |
One or more parameters are invalid in request. |
500 |
1020 |
An error occurred while trying to retrieve the ethernet interfaces on the server with the given ID. |
500 |
1022 |
Timeout while performing the task. |
Response Description
- device_name - String - The name of the network interface.
- desc - String - The description of the network interface.
- role - String - The role of the network interface. One of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled.
- ipversion - String - The verson of the IP address that is configured on the network interface. One of: ipv4, ipv6.
- ip - String - The IP that is configured on the network interface.
- mask - String - The netmask that is configured on the network interface
- is_auto_ip - Boolean - Is the IP auto-configured?
- is_cable_linked - String - Is the network interface cable linked? One of: true, false, unknown.
- is_moving_config_with_active_ha - Boolean -Applies the same settings to a new active HA server during failover.
- hacrossover_params - String - A map of key-value pairs of HA crossover parameters if the network interface is used for HA crossover.
Response Sample
[ { "desc": "String", "device_name": "String", "hacrossover_params": { "String": "String" }, "ip": "String", "ipversion": "String <one of: ipv4, ipv6>", "is_auto_ip": true, "is_cable_linked": "String <one of: true, false, unknown>", "is_moving_config_with_active_ha": true, "mask": "String", "role": "String <one of: regular, management, hacrossover, hacrossover_disabled, monitor, disabled, slave, slave_disabled>" } ]