Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 2.31 KB

metal_vrf.md

File metadata and controls

78 lines (50 loc) · 2.31 KB
Raw

metal_vrf

Create a VRF in a metro, with IP ranges that you want the VRF to route and forward.

Examples

- name: Create new Equinix Metal VRF
  hosts: localhost
  tasks:
    - equinix.cloud.metal_vrf:
        name: "example-vrf"
        description: "VRF with ASN 65000 and a pool of address space that includes 192.168.100.0/25"
        metro: "da"
        local_asn: 65000
        ip_ranges:
          - "192.168.100.0/25"
          - "192.168.200.0/25"
        project_id: "your_project_id_here"

Parameters

Field Type Required Description
id str Optional UUID of the VRF.
description str Optional Description of the VRF.
name str Optional User-supplied name of the VRF, unique to the project.
metro str Optional Metro ID or Code where the VRF will be deployed.
local_asn int Optional The 4-byte ASN set on the VRF. (Updatable)
ip_ranges list Optional All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF. (Updatable)
project_id str Optional Project ID where the VRF will be deployed.

Return Values

Sample Response for metal_vrf

{
  "changed": false,
  "description": "Test VRF with ASN 65000",
  "id": "f4a7863c-fcbf-419c-802c-3c6d3ad9529e",
  "ip_ranges": [
    "192.168.100.0/25",
    "192.168.200.0/25"
  ],
  "local_asn": 65000,
  "metro": {
    "href": "/metal/v1/locations/metros/108b2cfb-246b-45e3-885a-bf3e82fce1a0",
    "id": "108b2cfb-246b-45e3-885a-bf3e82fce1a0"
  },
  "name": "ansible-integration-test-vrf-6yww6pyz",
  "project_id": "9934e474-04a1-46a3-842b-5f3dc0ed0eba"
}