equinix.metal.operating_system_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 operating_systems.

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

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

Scanned by Steampunk Spotter

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

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

Inputs

    
slugs:
    description:
    - One or more operating_system slugs.
    elements: str
    type: list

distros:
    description:
    - One or more operating_system distros.
    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

operating_systems:
  description: Information about each operating_system that was found
  returned: always
  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" }]'
  type: list