network_interface_controllers
Creates, updates, deletes, gets or lists a network_interface_controllers resource.
Overview​
| Name | network_interface_controllers |
| Type | Resource |
| Id | ovh.dedicated_server.network_interface_controllers |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
link_type | string | NetworkInterfaceController linkType (isolated, private, private_lag, provisioning, provisioning_lag, public, public_lag) (wire: linkType) |
mac | string (mac-address) | NetworkInterfaceController mac (example: 00:00:5e:00:53:01) |
virtual_network_interface | string (uuid) | VirtualNetworkInterface bound to this NetworkInterfaceController (wire: virtualNetworkInterface) |
Your networkInterfaceController
| Name | Datatype | Description |
|---|---|---|
link_type | string | NetworkInterfaceController linkType (isolated, private, private_lag, provisioning, provisioning_lag, public, public_lag) (wire: linkType) |
mac | string (mac-address) | NetworkInterfaceController mac (example: 00:00:5e:00:53:01) |
virtual_network_interface | string (uuid) | VirtualNetworkInterface bound to this NetworkInterfaceController (wire: virtualNetworkInterface) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | mac, service_name | Get a network interface controller. Returns the MAC address of a network interface controller, its link type, such as public, private or isolated, and the virtual network interface bound to it. (Beta version) | |
list | select | service_name | link_type, x_pagination_mode | List network interface controllers. Returns the MAC addresses of the network interface controllers of the server. Filter them by link type with the linkType parameter. (Beta version) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
mac | string (mac-address) | NetworkInterfaceController mac |
service_name | string | The internal name of your dedicated server (wire: serviceName) |
link_type | string | Filter the value of linkType property (=) (wire: linkType) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a network interface controller. Returns the MAC address of a network interface controller, its link type, such as public, private or isolated, and the virtual network interface bound to it. (Beta version)
SELECT
link_type,
mac,
virtual_network_interface
FROM ovh.dedicated_server.network_interface_controllers
WHERE mac = '{{ mac }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List network interface controllers. Returns the MAC addresses of the network interface controllers of the server. Filter them by link type with the linkType parameter. (Beta version)
SELECT
link_type,
mac,
virtual_network_interface
FROM ovh.dedicated_server.network_interface_controllers
WHERE service_name = '{{ service_name }}' -- required
AND link_type = '{{ link_type }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;