device_interfaces
Creates, updates, deletes, gets or lists a device_interfaces
resource.
Overview
Name | device_interfaces |
Type | Resource |
Id | datadog.infrastructure.device_interfaces |
Fields
The following fields are returned by SELECT
queries:
- get_interfaces
Name | Datatype | Description |
---|---|---|
id | string | The interface ID (example: example:1.2.3.4:99) |
attributes | object | The interface attributes |
type | string | The type of the resource. The value should always be interface. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_interfaces | select | device_id , region | get_ip_addresses | Get the list of interfaces of the device. |
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 |
---|---|---|
device_id | string | The ID of the device to get interfaces from. (example: example:1.2.3.4) |
region | string | (default: datadoghq.com) |
get_ip_addresses | boolean | Whether to get the IP addresses of the interfaces. (example: true) |
SELECT
examples
- get_interfaces
Get the list of interfaces of the device.
SELECT
id,
attributes,
type
FROM datadog.infrastructure.device_interfaces
WHERE device_id = '{{ device_id }}' -- required
AND region = '{{ region }}' -- required
AND get_ip_addresses = '{{ get_ip_addresses }}'
;