equinix.metal.facility_info_module.rst

equinix.metal.facility_info

Gather information about Equinix Metal facilities

Version added: 1.4.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Gather information about Equinix Metal facilities.
• API is documented at https://metal.equinix.com/developers/api/facilities/.

Requirements

The below requirements are needed on the host that executes this module.

• packet-python >= 1.43.1

Parameters

Parameter	Choices/Defaults	Comments
api_token string / required		The Equinix Metal API token to use If not set, then the value of the METAL_API_TOKEN, PACKET_API_TOKEN, or PACKET_TOKEN environment variable is used. aliases: auth_token
codes list / elements=string		One or more facility codes.
ids list / elements=string		One or more facility ids.

Examples

# All the examples assume that you have your Equinix Metal API token in env var METAL_API_TOKEN.
# You can also pass it to the api_token parameter of the module instead.

- name: Gather information about all facilities
  hosts: localhost
  tasks:
    - equinix.metal.facility_info:


- name: Gather information about a particular facility using ID
  hosts: localhost
  tasks:
    - equinix.metal.facility_info:
      ids:
        - 173d7f11-f7b9-433e-ac40-f1571a38037a

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
facilities list	always	Information about each facility that was found Sample: [{ 'id': '8e6470b3-b75e-47d1-bb93-45b225750975', 'name': 'Amsterdam, NL', 'code': 'ams1', 'features': [ 'baremetal', 'storage', 'global_ipv4', 'backend_transfer', 'layer_2' ], 'address': { 'href': '#0688e909-647e-4b21-bdf2-fc056d993fc5' } }]

Status

Authors

• Jason DeTiberus (@detiber) <jdetiberus@equinix.com>