metal_plan_info.md

metal_plan_info

Gather information about Equinix Metal plans

• Examples
• Parameters
• Return Values

Examples

- name: Gather information about all plans
  hosts: localhost
  tasks:
      - equinix.cloud.metal_plan_info

- name: Gather information for plans with storage category
  hosts: localhost
  tasks:
      - equinix.cloud.metal_plan_info:
          categories: ['storage']

- name: Gather information for plans with slug c3.medium
  hosts: localhost
  tasks:
      - equinix.cloud.metal_plan_info:
          slug: c3.medium

- name: Gather information for plans with a standard plan
  hosts: localhost
  tasks:
      - equinix.cloud.metal_plan_info:
          type: standard

Parameters

Field	Type	Required	Description
categories	list	Optional	Filter plans by categories.
type	str	Optional	Filter plans by type.
slug	str	Optional	Filter plans by slug.

Return Values

Sample Response for resources

{
  "available_in": [],
  "available_in_metros": [],
  "category": [
    "compute",
    "current_gen"
  ],
  "class": "a3.large.opt-m3a2",
  "deployment_types": [],
  "description": "a3.large.opt-m3a2.x86",
  "id": "8c04950a-87ab-5e52-a112-5a90bbca8868",
  "legacy": false,
  "line": "baremetal",
  "name": "a3.large.opt-m3a2.x86",
  "pricing_hour": 8.2,
  "pricing_month": null,
  "slug": "a3.large.opt-m3a2"
}