Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 3.13 KB

metal_reserved_ip_block.md

File metadata and controls

91 lines (61 loc) · 3.13 KB
Raw

metal_reserved_ip_block

When a user provisions first device in a facility, Equinix Metal API automatically allocates IPv6/56 and private IPv4/25 blocks. The new device then gets IPv6 and private IPv4 addresses from those block. It also gets a public IPv4/31 address. Every new device in the project and facility will automatically get IPv6 and private IPv4 addresses from these pre-allocated blocks. The IPv6 and private IPv4 blocks can't be created, only imported. With this resource, it's possible to create either public IPv4 blocks or global IPv4 blocks.

Examples

- name: Create a new reserved IP block in metro "sv"
  hosts: localhost
  tasks:
  - equinix.cloud.metal_reserved_ip_block:
      project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7
      type: public_ipv4
      quantity: 1
      metro: "sv"

- name: Create a new global reserved IP block (no metro)
  hosts: localhost
  tasks:
  - equinix.cloud.metal_reserved_ip_block:
      project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7
      type: global_ipv4
      quantity: 1

Parameters

Field Type Required Description
id str Optional UUID of the reserved IP block
type str Optional The type of IP address to list (Choices: public_ipv4, public_ipv6, private_ipv4, global_ipv4, vrf)
quantity int Optional The number of IP addresses to reserve
details str Optional Details about the reserved IP block
metro str Optional The metro where the reserved IP block will be created
customdata str Optional Custom data to associate with the reserved IP block
comments str Optional Comments to associate with the reserved IP block
vrf_id str Optional The ID of the VRF in which this VRF IP Reservation is created. The VRF must have an existing IP Range that contains the requested subnet.
project_id str Optional The ID of the project to which the reserved IP block will be assigned
tags list Optional Tags to associate with the reserved IP block

Return Values

Sample Response for metal_reserved_ip_block

{
  "address_family": 4,
  "changed": true,
  "customdata": {},
  "details": "",
  "id": "6d94f567-6cf5-4536-8216-7dc96e1585dd",
  "management": false,
  "metro": "sv",
  "netmask": "255.255.255.255",
  "network": "145.40.67.3",
  "project_id": "fd554070-70b6-420d-b3f8-7ed8438862d5",
  "public": true,
  "quantity": 1,
  "tags": [
    "t1",
    "t2"
  ],
  "type": "public_ipv4"
}