Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 3.75 KB

metal_connection.md

File metadata and controls

88 lines (58 loc) · 3.75 KB
Raw

metal_connection

Manage an Interconnection in Equinix Metal. You can use connection_id to lookup the resource. If you want to create a new resource, you must provide project_id, name, type, redundancy, and speed.

Examples

- name: Create new connection
  hosts: localhost
  tasks:
  - equinix.cloud.metal_connection:
      project_id: "Bhf47603-7a09-4ca1-af67-4087c13ab5b6"
      name: "new connection"
      type: "dedicated"
      redundancy: "primary"
      speed: "50Mbps"
      metro: "am"

- name: Fetch the connection
  hosts: localhost
  tasks:
  - equinix.cloud.metal_connection:
        project_id: "Bhf47603-7a09-4ca1-af67-4087c13ab5b6"
        name: "new connection"
        connection_id: "3113c6bf-b0e8-4985-8f35-3c987a0ed46e"

Parameters

Field Type Required Description
id str Optional UUID of the connection.
connection_id str Optional UUID of the connection, used for GET.
project_id str Optional ID of the project where the connection is scoped to. Required for shared connections.
organization_id str Optional ID of the organization where the connection is scoped to. Used with dedicated connections
contact_email str Optional Email of the person to contact for inquiries. (Updatable)
description str Optional Description of the connection. (Updatable)
metro str Optional Metro where the connection will be created
mode str Optional Mode for connections in IBX facilities with the dedicated type - standard or tunnel (Choices: standard, tunnel; Updatable)
name str Optional Name of the connection resource (Updatable)
redundancy str Optional Connection redundancy - redundant or primary (Choices: redundant, primary; Updatable)
service_token_type str Optional Only used with shared connection. Type of service token to use for the connection, a_side or z_side (Choices: a_side, z_side)
speed str Optional Port speed. Required for a_side connections. Allowed values are ['50Mbps', '200Mbps', '500Mbps', '1Gbps', '2Gbps', '5Gbps', '10Gbps']
tags list Optional Tags attached to the connection (Updatable)
type str Optional Connection type - dedicated or shared (Choices: dedicated, shared)
vlans list Optional Only used with shared connection. VLANs to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection
vrfs list Optional Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection

Return Values

Sample Response for metal_resource

{
  "metro": "am",
  "name": "new connection",
  "project_id": "Bhf47603-7a09-4ca1-af67-4087c13ab5b6",
  "redundancy": "primary",
  "speed": "50Mbps",
  "type": "dedicated"
}