equinix.metal.capacity_info_module.rst

equinix.metal.capacity_info

Gather information about Equinix Metal capacity

Version added: 1.4.0

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

Synopsis

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

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
include_legacy boolean	Choices: no yes	Include legacy facilities.

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
capacity dictionary	always	Information about capacity that was found 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" } }, }

Status

Authors

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