Skip to content
This repository has been archived by the owner on Sep 10, 2024. It is now read-only.

Latest commit

 

History

History
164 lines (129 loc) · 5.16 KB

equinix.metal.project_info_module.rst

File metadata and controls

164 lines (129 loc) · 5.16 KB

equinix.metal.project_info

Gather information about Equinix Metal projects

Version added: 1.2.0

The below requirements are needed on the host that executes this module.

  • packet-python >= 1.43.1
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 project ids.
names
list / elements=string
One or more project names.

# 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 projects
  hosts: localhost
  tasks:
    - equinix.metal.project_info:


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

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

Key Returned Description
projects
list
always
Information about each project that was found

Sample:
[{"name": "my-project", "id": "2a5122b9-c323-4d5c-b53c-9ad3f54273e7"}]


Authors