Equinix Ansible Collection

This is repository for Ansible collection registered in Ansible Galaxy as equinix.cloud. The collection contains various plugins for managing Equinix services.

For users transitioning from the equinix.metal collection, please refer to our Migration Guide for detailed instructions on migrating to this collection (equinix.cloud).

Ansible version compatibility

This collection has been tested against following Ansible version 6.7.0, core version 2.13.8.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Modules

Modules for managing Equinix infrastructure.

Name	Description
equinix.cloud.metal_bgp_session	Manage BGP sessions in Equinix Metal
equinix.cloud.metal_connection	Manage an Interconnection in Equinix Metal
equinix.cloud.metal_device	Create, update, or delete Equinix Metal devices
equinix.cloud.metal_gateway	Manage Metal Gateway in Equinix Metal
equinix.cloud.metal_hardware_reservation	Lookup a single hardware_reservation by ID in Equinix Metal
equinix.cloud.metal_ip_assignment	Manage Equinix Metal IP assignments
equinix.cloud.metal_organization	Lookup a single organization by ID in Equinix Metal
equinix.cloud.metal_project	Manage Projects in Equinix Metal
equinix.cloud.metal_project_bgp_config	Manage BGP Config for Equinix Metal Project
equinix.cloud.metal_project_ssh_key	Manage a project ssh key in Equinix Metal
equinix.cloud.metal_reserved_ip_block	Create/delete blocks of reserved IP addresses in a project.
equinix.cloud.metal_ssh_key	Manage personal SSH keys in Equinix Metal
equinix.cloud.metal_virtual_circuit	Manage a Virtual Circuit in Equinix Metal
equinix.cloud.metal_vlan	Manage a VLAN resource in Equinix Metal
equinix.cloud.metal_vrf	Manage a VRF resource in Equinix Metal

Info Modules

Modules for retrieving information about existing Equinix infrastructure.

Name	Description
equinix.cloud.metal_available_ips_info	Get list of avialable IP addresses from a reserved IP block
equinix.cloud.metal_bgp_session_info	Gather information BGP sessions in Equinix Metal
equinix.cloud.metal_connection_info	Gather information about Interconnections
equinix.cloud.metal_device_info	Select list of Equinix Metal devices
equinix.cloud.metal_gateway_info	Gather information about Metal Gateways
equinix.cloud.metal_hardware_reservation_info	Gather information about Equinix Metal hardware_reservations
equinix.cloud.metal_ip_assignment_info	Gather IP address assignments for a device
equinix.cloud.metal_metro_info	Gather information about Equinix Metal metros
equinix.cloud.metal_operating_system_info	Gather information about Operating Systems available for devices in Equinix Metal
equinix.cloud.metal_organization_info	Gather information about Equinix Metal organizations
equinix.cloud.metal_plan_info	Gather information about Equinix Metal plans
equinix.cloud.metal_project_info	Gather information about Equinix Metal projects
equinix.cloud.metal_project_ssh_key_info	Gather project SSH keys.
equinix.cloud.metal_reserved_ip_block_info	Gather list of reserved IP blocks
equinix.cloud.metal_ssh_key_info	Gather personal SSH keys
equinix.cloud.metal_virtual_circuit_info	Gather information about Equinix Metal Virtual Circuits
equinix.cloud.metal_vlan_info	Gather VLANs.
equinix.cloud.metal_vrf_info	Gather VRFs

Inventory Plugins

Dynamically add Equinix infrastructure to an Ansible inventory.

Name
equinix.cloud.metal_device

Installation

You can install the Equinix collection with the Ansible Galaxy CLI:

ansible-galaxy collection install equinix.cloud

The Python module dependencies are not installed by ansible-galaxy. They can be manually installed using pip:

pip install -r https://raw.githubusercontent.com/equinix-labs/ansible-collection-equinix/v0.6.0/requirements.txt

Usage

Once the Equinix Ansible collection is installed, it can be referenced by its Fully Qualified Collection Namespace (FQCN): equinix.cloud.module_name.

In order to use this collection, you should have account in the relevant Equinix service. For example you should have an account in Equinix Metal to use the metal_* modules.

You can authenticate either by exporting auth token in an environment variable, or by supplying *_api_token attributes to modules. For example, to use metal_device, you can export METAL_AUTH_TOKEN (or METAL_API_TOKEN), or you can supply the metal_api_token attribute.

Example Playbook

---
- name: create Equinix Metal device
  hosts: localhost
  tasks:
    - equinix.cloud.metal_device:
        project_id: "3b516842-c8b1-485e-9f76-c891bd804c5e"
        hostname: "my new device"
        operating_system: ubuntu_20_04
        plan: c3.small.x86
        metro: sv

For more information on Ansible collection usage, see Ansible's official usage guide.

Examples

Use-case examples for this collection can be found here.

Development

See DEVELOPMENT.md.

Releasing

Go to https://github.com/equinix-labs/ansible-collection-equinix/releases/new and create a new release from main. Don't choose an existing tag. Put version to the field for "Release title", for example v0.1.2. Don't add collection number to the Makefile.

Add release notes in format of Terraform Provider Equinix, with at least one of the sections (NOTES, FEATURES, BUG FIXES, ENHANCEMENTS).

Click "Publish release", and the manual part should be over.

The release will create a tag, and we have a Github action in place that should create an Ansible Galaxy release. The script that creates tarball for Galay removes the first "v", so releasing v0.1.2 should upload collection equinix.cloud version 0.1.2.

Verify that the releasing Github action succeeded.

Verify that new version of equinix.cloud is available in Ansible Galaxy.

Licensing

GNU General Public License v3.0.

See COPYING to see the full text.