equinix.metal.capacity_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 capacity.

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

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 capacity
  hosts: localhost
  tasks:
    - equinix.metal.capacity_info:

Inputs

    
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

include_legacy:
    description:
    - Include legacy facilities.
    type: bool

Outputs

capacity:
  description: Information about capacity that was found
  returned: always
  sample: '{ "da11": { "c3.medium.x86": { "level": "normal" }, "c3.small.x86": { "level":
    "normal" }, "m3.large.x86": { "level": "normal" }, "n2.xlarge.x86": { "level":
    "unavailable" }, "s3.xlarge.x86": { "level": "normal" } }, }'
  type: dict