equinix.metal.operating_system_info_module.rst

equinix.metal.operating_system_info

Gather information about Equinix Metal operating_systems

Version added: 1.4.0

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

Synopsis

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

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
distros list / elements=string		One or more operating_system distros.
slugs list / elements=string		One or more operating_system slugs.

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 operating_systems
  hosts: localhost
  tasks:
    - equinix.metal.operating_system_info:


- name: Gather information about a particular operating_system using slug
  hosts: localhost
  tasks:
    - equinix.metal.operating_system_info:
      slugs:
        - ubuntu_20_10

Return Values

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

Key	Returned	Description
operating_systems list	always	Information about each operating_system that was found Sample: [{ "distro": "ubuntu", "name": "Ubuntu 20.10", "provisionable_on": [ "c1.small.x86", "baremetal_1", "c2.medium.x86", "c3.medium.x86", "c3.small.x86", "g2.large.x86", "m1.xlarge.x86", "baremetal_2", "m2.xlarge.x86", "m3.large.x86", "n2.xlarge.x86", "s1.large.x86", "baremetal_s", "s3.xlarge.x86", "t1.small.x86", "baremetal_0", "x1.small.x86", "baremetal_1e", "x2.xlarge.x86", "x3.xlarge.x86" ], "slug": "ubuntu_20_10", "version": "20.10" }]

Status

Authors

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