virtual_network_interfaces

Creates, updates, deletes, gets or lists a virtual_network_interfaces resource.

Overview

Name	virtual_network_interfaces
Type	Resource
Id	ovh.dedicated_server.virtual_network_interfaces

Fields

The following fields are returned by SELECT queries:

get_by_uuid

successful operation

Name	Datatype	Description
name	string	User defined VirtualNetworkInterface name
server_name	string	Server bound to this VirtualNetworkInterface (wire: serverName)
enabled	boolean	VirtualNetworkInterface activation state
mode	string	VirtualNetworkInterface mode (public, public_aggregation, vrack, vrack_aggregation)
network_interface_controller	array	NetworkInterfaceControllers bound to this VirtualNetworkInterface (wire: networkInterfaceController)
uuid	string (uuid)	VirtualNetworkInterface unique id
vrack	string	vRack name

get

successful operation

Name	Datatype	Description
name	string	User defined VirtualNetworkInterface name
server_name	string	Server bound to this VirtualNetworkInterface (wire: serverName)
enabled	boolean	VirtualNetworkInterface activation state
mode	string	Available VirtualNetworkInterface modes (public, public_aggregation, vrack, vrack_aggregation)
network_interface_controller	array	NetworkInterfaceControllers bound to this VirtualNetworkInterface (wire: networkInterfaceController)
uuid	string (uuid)	VirtualNetworkInterface unique id
vrack	string	vRack name

list

Your VirtualNetworkInterface

Name	Datatype	Description
name	string	User defined VirtualNetworkInterface name
server_name	string	Server bound to this VirtualNetworkInterface (wire: serverName)
enabled	boolean	VirtualNetworkInterface activation state
mode	string	VirtualNetworkInterface mode (public, public_aggregation, vrack, vrack_aggregation)
network_interface_controller	array	NetworkInterfaceControllers bound to this VirtualNetworkInterface (wire: networkInterfaceController)
uuid	string (uuid)	VirtualNetworkInterface unique id
vrack	string	vRack name

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_uuid	select	service_name, uuid		Get a virtual network interface. Returns the name, mode, activation state and vRack of a virtual network interface, and the network interface controllers bound to it. (Beta version)
get	select	uuid		Returns a virtual network interface from its UUID alone, without the server name in the path. The response includes the server it is bound to, its mode, its vRack and its network interface controllers.
list	select	service_name	enabled, mode, name, vrack, x_pagination_mode	List virtual network interfaces. Returns the UUIDs of the virtual network interfaces of the server. Filter them by enabled, mode, vrack or name. (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"}})
service_name	string	The internal name of your dedicated server (wire: serviceName)
uuid	string (uuid)	Uuid
enabled	boolean	Filter the value of enabled property (=)
mode	string	Filter the value of mode property (=)
name	string	Filter the value of name property (=)
vrack	string	Filter the value of vrack property (=)
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_by_uuid

Get a virtual network interface. Returns the name, mode, activation state and vRack of a virtual network interface, and the network interface controllers bound to it. (Beta version)

SELECT
name,
server_name,
enabled,
mode,
network_interface_controller,
uuid,
vrack
FROM ovh.dedicated_server.virtual_network_interfaces
WHERE service_name = '{{ service_name }}' -- required
AND uuid = '{{ uuid }}' -- required
;

get

Returns a virtual network interface from its UUID alone, without the server name in the path. The response includes the server it is bound to, its mode, its vRack and its network interface controllers.

SELECT
name,
server_name,
enabled,
mode,
network_interface_controller,
uuid,
vrack
FROM ovh.dedicated_server.virtual_network_interfaces
WHERE uuid = '{{ uuid }}' -- required
;

list

List virtual network interfaces. Returns the UUIDs of the virtual network interfaces of the server. Filter them by enabled, mode, vrack or name. (Beta version)

SELECT
name,
server_name,
enabled,
mode,
network_interface_controller,
uuid,
vrack
FROM ovh.dedicated_server.virtual_network_interfaces
WHERE service_name = '{{ service_name }}' -- required
AND enabled = '{{ enabled }}'
AND mode = '{{ mode }}'
AND name = '{{ name }}'
AND vrack = '{{ vrack }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;