interfaces

Creates, updates, deletes, gets or lists an interfaces resource.

Overview

Name	interfaces
Type	Resource
Id	ovh.ovh_cloud_connect.interfaces

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Interface reference
device_display_name	string	Patch panel name (wire: deviceDisplayName)
device_rack_display_name	string	Equipment name in the rack (wire: deviceRackDisplayName)
interface_name	string	Port location (wire: interfaceName)
incoming_light_status	string	Status of the light received on the port (checked every 5 min) (down, unknown, up) (wire: incomingLightStatus)
incoming_light_value	number	Value of the light received on the port (checked every 5 min) (wire: incomingLightValue)
interface_status	string	Status of the interface (down, unknown, up) (wire: interfaceStatus)
interface_status_last_update	string (date-time)	Date of the last interface status change detected (wire: interfaceStatusLastUpdate)
interface_termination_type	string	Fiber termination type (LC/PC, SC/PC) (wire: interfaceTerminationType)
light_last_update	string (date-time)	Date of the last light change detected (wire: lightLastUpdate)
outgoing_light_status	string	Status of the light emitted on the port (checked every 5 min) (down, unknown, up) (wire: outgoingLightStatus)
outgoing_light_value	number	Value of the light emitted on the port (checked every 5 min) (wire: outgoingLightValue)
status	string	Status of the port (disabled, enabled, reserved)

list

OVHcloud Connect Interface

Name	Datatype	Description
id	integer	Interface reference
device_display_name	string	Patch panel name (wire: deviceDisplayName)
device_rack_display_name	string	Equipment name in the rack (wire: deviceRackDisplayName)
interface_name	string	Port location (wire: interfaceName)
incoming_light_status	string	Status of the light received on the port (checked every 5 min) (down, unknown, up) (wire: incomingLightStatus)
incoming_light_value	number	Value of the light received on the port (checked every 5 min) (wire: incomingLightValue)
interface_status	string	Status of the interface (down, unknown, up) (wire: interfaceStatus)
interface_status_last_update	string (date-time)	Date of the last interface status change detected (wire: interfaceStatusLastUpdate)
interface_termination_type	string	Fiber termination type (LC/PC, SC/PC) (wire: interfaceTerminationType)
light_last_update	string (date-time)	Date of the last light change detected (wire: lightLastUpdate)
outgoing_light_status	string	Status of the light emitted on the port (checked every 5 min) (down, unknown, up) (wire: outgoingLightStatus)
outgoing_light_value	number	Value of the light emitted on the port (checked every 5 min) (wire: outgoingLightValue)
status	string	Status of the port (disabled, enabled, reserved)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the port's location, patch panel, status, connector type and optical light levels.
list	select	service_name	x_pagination_mode	Returns the IDs of the service's physical ports.
lock	exec	id, serviceName		Blocks all traffic on the port until it is unlocked (async task).
unlock	exec	id, serviceName		Restores traffic on a locked port (async task).

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"}})
id	integer	Id
serviceName	string (uuid)	Service name
service_name	string (uuid)	Service name (wire: serviceName)
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

Returns the port's location, patch panel, status, connector type and optical light levels.

SELECT
id,
device_display_name,
device_rack_display_name,
interface_name,
incoming_light_status,
incoming_light_value,
interface_status,
interface_status_last_update,
interface_termination_type,
light_last_update,
outgoing_light_status,
outgoing_light_value,
status
FROM ovh.ovh_cloud_connect.interfaces
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the service's physical ports.

SELECT
id,
device_display_name,
device_rack_display_name,
interface_name,
incoming_light_status,
incoming_light_value,
interface_status,
interface_status_last_update,
interface_termination_type,
light_last_update,
outgoing_light_status,
outgoing_light_value,
status
FROM ovh.ovh_cloud_connect.interfaces
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

lock

Blocks all traffic on the port until it is unlocked (async task).

EXEC ovh.ovh_cloud_connect.interfaces.lock 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;

unlock

Restores traffic on a locked port (async task).

EXEC ovh.ovh_cloud_connect.interfaces.unlock 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;