equinix.metal.org_info (1.4.1) — module

Install collection

Install with ansible-galaxy collection install equinix.metal:==1.4.1

Add to requirements.yml

  collections:
    - name: equinix.metal
      version: 1.4.1

Description

Gather information about Equinix Metal organizations.

API is documented at U(https://metal.equinix.com/developers/api/organizations/).

Requirements

• packet-python >= 1.43.1

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
ids:
    description:
    - One or more organization ids.
    elements: str
    type: list

names:
    description:
    - One or more organization names.
    elements: str
    type: list

api_token:
    aliases:
    - auth_token
    description:
    - 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.
    required: true
    type: str

Outputs

organizations:
  description: Information about each organization that was found
  returned: always
  sample: '[{"name": "my-org", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7"}]'
  type: list