equinix.metal.org_info_module.rst

equinix.metal.org_info

Gather information about Equinix Metal organizations

Version added: 1.4.0

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

Synopsis

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

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
ids list / elements=string		One or more organization ids.
names list / elements=string		One or more organization names.

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 organizations
  hosts: localhost
  tasks:
    - equinix.metal.org_info:


- name: Gather information about a particular organization using ID
  hosts: localhost
  tasks:
    - equinix.metal.org_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
organizations list	always	Information about each organization that was found Sample: [{"name": "my-org", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7"}]

Status

Authors

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