equinix.metal.plan_info_module.rst

equinix.metal.plan_info

Gather information about Equinix Metal plans

Version added: 1.4.0

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

Synopsis

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

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 plan ids.
names list / elements=string		One or more plan 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 plans
  hosts: localhost
  tasks:
    - equinix.metal.plan_info:


- name: Gather information about a particular plan using ID
  hosts: localhost
  tasks:
    - equinix.metal.plan_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
plans list	always	Information about each plan that was found 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" } ] } }]

Status

Authors

• Jason DeTiberus (@detiber) <[email protected]>