Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. getPrecreatedIpBlock
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

equinix.metal.getPrecreatedIpBlock

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix

Use this data source to get CIDR expression for precreated (management) IPv6 and IPv4 blocks in Equinix Metal. You can then use the cidrsubnet TF builtin function to derive subnets.

For backward compatibility, this data source will also return reserved (elastic) IP blocks.

Precreated (management) IP blocks for a metro will not be available until first device is created in that metro.

Public IPv4 blocks auto-assigned (management) to a device cannot be retrieved. If you need that information, consider using the equinix.metal.Device data source instead.

Using getPrecreatedIpBlock

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPrecreatedIpBlock(args: GetPrecreatedIpBlockArgs, opts?: InvokeOptions): Promise<GetPrecreatedIpBlockResult>
function getPrecreatedIpBlockOutput(args: GetPrecreatedIpBlockOutputArgs, opts?: InvokeOptions): Output<GetPrecreatedIpBlockResult>
Copy
def get_precreated_ip_block(address_family: Optional[int] = None,
                            facility: Optional[str] = None,
                            global_: Optional[bool] = None,
                            metro: Optional[str] = None,
                            project_id: Optional[str] = None,
                            public: Optional[bool] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPrecreatedIpBlockResult
def get_precreated_ip_block_output(address_family: Optional[pulumi.Input[int]] = None,
                            facility: Optional[pulumi.Input[str]] = None,
                            global_: Optional[pulumi.Input[bool]] = None,
                            metro: Optional[pulumi.Input[str]] = None,
                            project_id: Optional[pulumi.Input[str]] = None,
                            public: Optional[pulumi.Input[bool]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPrecreatedIpBlockResult]
Copy
func GetPrecreatedIpBlock(ctx *Context, args *GetPrecreatedIpBlockArgs, opts ...InvokeOption) (*GetPrecreatedIpBlockResult, error)
func GetPrecreatedIpBlockOutput(ctx *Context, args *GetPrecreatedIpBlockOutputArgs, opts ...InvokeOption) GetPrecreatedIpBlockResultOutput
Copy

> Note: This function is named GetPrecreatedIpBlock in the Go SDK.

public static class GetPrecreatedIpBlock 
{
    public static Task<GetPrecreatedIpBlockResult> InvokeAsync(GetPrecreatedIpBlockArgs args, InvokeOptions? opts = null)
    public static Output<GetPrecreatedIpBlockResult> Invoke(GetPrecreatedIpBlockInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrecreatedIpBlockResult> getPrecreatedIpBlock(GetPrecreatedIpBlockArgs args, InvokeOptions options)
public static Output<GetPrecreatedIpBlockResult> getPrecreatedIpBlock(GetPrecreatedIpBlockArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: equinix:metal/getPrecreatedIpBlock:getPrecreatedIpBlock
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AddressFamily This property is required. int
4 or 6, depending on which block you are looking for.
ProjectId This property is required. string
ID of the project where the searched block should be.
Public This property is required. bool
Whether to look for public or private block.
Facility string
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
Global bool
Whether to look for global block. Default is false for backward compatibility.
Metro string
Metro of the searched block (for non-global blocks).
AddressFamily This property is required. int
4 or 6, depending on which block you are looking for.
ProjectId This property is required. string
ID of the project where the searched block should be.
Public This property is required. bool
Whether to look for public or private block.
Facility string
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
Global bool
Whether to look for global block. Default is false for backward compatibility.
Metro string
Metro of the searched block (for non-global blocks).
addressFamily This property is required. Integer
4 or 6, depending on which block you are looking for.
projectId This property is required. String
ID of the project where the searched block should be.
public_ This property is required. Boolean
Whether to look for public or private block.
facility String
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
global Boolean
Whether to look for global block. Default is false for backward compatibility.
metro String
Metro of the searched block (for non-global blocks).
addressFamily This property is required. number
4 or 6, depending on which block you are looking for.
projectId This property is required. string
ID of the project where the searched block should be.
public This property is required. boolean
Whether to look for public or private block.
facility string
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
global boolean
Whether to look for global block. Default is false for backward compatibility.
metro string
Metro of the searched block (for non-global blocks).
address_family This property is required. int
4 or 6, depending on which block you are looking for.
project_id This property is required. str
ID of the project where the searched block should be.
public This property is required. bool
Whether to look for public or private block.
facility str
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
global_ bool
Whether to look for global block. Default is false for backward compatibility.
metro str
Metro of the searched block (for non-global blocks).
addressFamily This property is required. Number
4 or 6, depending on which block you are looking for.
projectId This property is required. String
ID of the project where the searched block should be.
public This property is required. Boolean
Whether to look for public or private block.
facility String
Facility of the searched block. (for non-global blocks). Use metro instead; read the facility to metro migration guide
global Boolean
Whether to look for global block. Default is false for backward compatibility.
metro String
Metro of the searched block (for non-global blocks).

getPrecreatedIpBlock Result

The following output properties are available:

Address string
AddressFamily int
Cidr int
CidrNotation string
CIDR notation of the looked up block.
Gateway string
Id string
The provider-assigned unique ID for this managed resource.
Manageable bool
Management bool
Netmask string
Network string
ProjectId string
Public bool
Quantity int
Type string
VrfId string
Facility string
Global bool
Metro string
Address string
AddressFamily int
Cidr int
CidrNotation string
CIDR notation of the looked up block.
Gateway string
Id string
The provider-assigned unique ID for this managed resource.
Manageable bool
Management bool
Netmask string
Network string
ProjectId string
Public bool
Quantity int
Type string
VrfId string
Facility string
Global bool
Metro string
address String
addressFamily Integer
cidr Integer
cidrNotation String
CIDR notation of the looked up block.
gateway String
id String
The provider-assigned unique ID for this managed resource.
manageable Boolean
management Boolean
netmask String
network String
projectId String
public_ Boolean
quantity Integer
type String
vrfId String
facility String
global Boolean
metro String
address string
addressFamily number
cidr number
cidrNotation string
CIDR notation of the looked up block.
gateway string
id string
The provider-assigned unique ID for this managed resource.
manageable boolean
management boolean
netmask string
network string
projectId string
public boolean
quantity number
type string
vrfId string
facility string
global boolean
metro string
address str
address_family int
cidr int
cidr_notation str
CIDR notation of the looked up block.
gateway str
id str
The provider-assigned unique ID for this managed resource.
manageable bool
management bool
netmask str
network str
project_id str
public bool
quantity int
type str
vrf_id str
facility str
global_ bool
metro str
address String
addressFamily Number
cidr Number
cidrNotation String
CIDR notation of the looked up block.
gateway String
id String
The provider-assigned unique ID for this managed resource.
manageable Boolean
management Boolean
netmask String
network String
projectId String
public Boolean
quantity Number
type String
vrfId String
facility String
global Boolean
metro String

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix
equinix/pulumi-equinix