network_interface_controller_mrtgs

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

Overview

Name	network_interface_controller_mrtgs
Type	Resource
Id	ovh.dedicated_server.network_interface_controller_mrtgs

Fields

The following fields are returned by SELECT queries:

list

A timestamp associated to a value

Name	Datatype	Description
timestamp	integer
value	object	A numeric value tagged with its unit

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	mac, period, service_name, type		Get interface traffic statistics. Returns timestamped values for one network interface controller, for the requested type and period. Types cover traffic, packets and errors, for download and upload. (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
period	string	mrtg period
service_name	string	The internal name of your dedicated server (wire: serviceName)
type	string	mrtg type

SELECT examples

list

Get interface traffic statistics. Returns timestamped values for one network interface controller, for the requested type and period. Types cover traffic, packets and errors, for download and upload. (Beta version)

SELECT
timestamp,
value
FROM ovh.dedicated_server.network_interface_controller_mrtgs
WHERE mac = '{{ mac }}' -- required
AND period = '{{ period }}' -- required
AND service_name = '{{ service_name }}' -- required
AND type = '{{ type }}' -- required
;