equinix.metal.plan_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 plans.

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

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 plans
  hosts: localhost
  tasks:
    - equinix.metal.plan_info:

Scanned by Steampunk Spotter

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

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

Inputs

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

names:
    description:
    - One or more plan 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

plans:
  description: Information about each plan that was found
  returned: always
  sample: '[{ "id": "e69c0169-4726-46ea-98f1-939c9e8a3607", "name": "t1.small.x86",
    "description": "Our Type 0 configuration is a general use "cloud killer" server,
    with a Intel Atom 2.4Ghz processor and 8GB of RAM.", "available_in":[ "ams1",
    "ewr1", "sjc1", "nrt1", ], "line": "baremetal", "pricing": { "hour": 0.07 }, "slug":
    "baremetal_0", "specs": { "cpus": [ { "count": 1, "type": "Intel Atom C2550 @
    2.4Ghz" } ], "drives": [ { "count": 1, "size": "80GB", "type": "SSD" } ], "features":
    { "raid": false, "txt": true }, "memory": { "total": "8GB" }, "nics": [ { "count":
    2, "type": "1Gbps" } ] } }]'
  type: list