equinix.metal.getReservedIpBlock
Explore with Pulumi AI
Use this data source to find IP address blocks in Equinix Metal. You can use IP address or a block ID for lookup.
For backward compatibility, this data source can be also used for precreated (management) IP blocks.
See the Virtual Routing and Forwarding documentation for product details and API reference material.
Using getReservedIpBlock
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 getReservedIpBlock(args: GetReservedIpBlockArgs, opts?: InvokeOptions): Promise<GetReservedIpBlockResult>
function getReservedIpBlockOutput(args: GetReservedIpBlockOutputArgs, opts?: InvokeOptions): Output<GetReservedIpBlockResult>
def get_reserved_ip_block(id: Optional[str] = None,
ip_address: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetReservedIpBlockResult
def get_reserved_ip_block_output(id: Optional[pulumi.Input[str]] = None,
ip_address: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetReservedIpBlockResult]
func LookupReservedIpBlock(ctx *Context, args *LookupReservedIpBlockArgs, opts ...InvokeOption) (*LookupReservedIpBlockResult, error)
func LookupReservedIpBlockOutput(ctx *Context, args *LookupReservedIpBlockOutputArgs, opts ...InvokeOption) LookupReservedIpBlockResultOutput
> Note: This function is named LookupReservedIpBlock
in the Go SDK.
public static class GetReservedIpBlock
{
public static Task<GetReservedIpBlockResult> InvokeAsync(GetReservedIpBlockArgs args, InvokeOptions? opts = null)
public static Output<GetReservedIpBlockResult> Invoke(GetReservedIpBlockInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetReservedIpBlockResult> getReservedIpBlock(GetReservedIpBlockArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: equinix:metal/getReservedIpBlock:getReservedIpBlock
arguments:
# arguments dictionary
The following arguments are supported:
- id str
- UUID of the IP address block to look up.
- ip_
address str Block containing this IP address will be returned.
NOTE: You should pass either
id
, or bothproject_id
andip_address
.- project_
id str - UUID of the project where the searched block should be.
getReservedIpBlock Result
The following output properties are available:
- Address string
- Address
Family int - Cidr int
- Cidr
Notation string - Facility string
- Gateway string
- Global bool
- Id string
- Manageable bool
- Management bool
- Metro string
- Netmask string
- Network string
- Project
Id string - Public bool
- Quantity int
- Type string
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- Vrf
Id int - Ip
Address string
- Address string
- Address
Family int - Cidr int
- Cidr
Notation string - Facility string
- Gateway string
- Global bool
- Id string
- Manageable bool
- Management bool
- Metro string
- Netmask string
- Network string
- Project
Id string - Public bool
- Quantity int
- Type string
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- Vrf
Id int - Ip
Address string
- address String
- address
Family Integer - cidr Integer
- cidr
Notation String - facility String
- gateway String
- global Boolean
- id String
- manageable Boolean
- management Boolean
- metro String
- netmask String
- network String
- project
Id String - public_ Boolean
- quantity Integer
- type String
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- vrf
Id Integer - ip
Address String
- address string
- address
Family number - cidr number
- cidr
Notation string - facility string
- gateway string
- global boolean
- id string
- manageable boolean
- management boolean
- metro string
- netmask string
- network string
- project
Id string - public boolean
- quantity number
- type string
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- vrf
Id number - ip
Address string
- address str
- address_
family int - cidr int
- cidr_
notation str - facility str
- gateway str
- global_ bool
- id str
- manageable bool
- management bool
- metro str
- netmask str
- network str
- project_
id str - public bool
- quantity int
- type str
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- vrf_
id int - ip_
address str
- address String
- address
Family Number - cidr Number
- cidr
Notation String - facility String
- gateway String
- global Boolean
- id String
- manageable Boolean
- management Boolean
- metro String
- netmask String
- network String
- project
Id String - public Boolean
- quantity Number
- type String
- One of
global_ipv4
,public_ipv4
,private_ipv4
,public_ipv6
,orvrf
- vrf
Id Number - ip
Address String
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.