1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. getReservedIpBlock
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

equinix.metal.getReservedIpBlock

Explore with Pulumi AI

equinix logo
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

    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 string
    UUID of the IP address block to look up.
    IpAddress string

    Block containing this IP address will be returned.

    NOTE: You should pass either id, or both project_id and ip_address.

    ProjectId string
    UUID of the project where the searched block should be.
    Id string
    UUID of the IP address block to look up.
    IpAddress string

    Block containing this IP address will be returned.

    NOTE: You should pass either id, or both project_id and ip_address.

    ProjectId string
    UUID of the project where the searched block should be.
    id String
    UUID of the IP address block to look up.
    ipAddress String

    Block containing this IP address will be returned.

    NOTE: You should pass either id, or both project_id and ip_address.

    projectId String
    UUID of the project where the searched block should be.
    id string
    UUID of the IP address block to look up.
    ipAddress string

    Block containing this IP address will be returned.

    NOTE: You should pass either id, or both project_id and ip_address.

    projectId string
    UUID of the project where the searched block should be.
    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 both project_id and ip_address.

    project_id str
    UUID of the project where the searched block should be.
    id String
    UUID of the IP address block to look up.
    ipAddress String

    Block containing this IP address will be returned.

    NOTE: You should pass either id, or both project_id and ip_address.

    projectId String
    UUID of the project where the searched block should be.

    getReservedIpBlock Result

    The following output properties are available:

    Address string
    AddressFamily int
    Cidr int
    CidrNotation string
    Facility string

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    Gateway string
    Global bool
    Id string
    Manageable bool
    Management bool
    Metro string
    Netmask string
    Network string
    ProjectId string
    Public bool
    Quantity int
    Type string
    One of global_ipv4, public_ipv4, private_ipv4, public_ipv6,or vrf
    VrfId int
    IpAddress string
    Address string
    AddressFamily int
    Cidr int
    CidrNotation string
    Facility string

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    Gateway string
    Global bool
    Id string
    Manageable bool
    Management bool
    Metro string
    Netmask string
    Network string
    ProjectId string
    Public bool
    Quantity int
    Type string
    One of global_ipv4, public_ipv4, private_ipv4, public_ipv6,or vrf
    VrfId int
    IpAddress string
    address String
    addressFamily Integer
    cidr Integer
    cidrNotation String
    facility String

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    gateway String
    global Boolean
    id String
    manageable Boolean
    management Boolean
    metro String
    netmask String
    network String
    projectId String
    public_ Boolean
    quantity Integer
    type String
    One of global_ipv4, public_ipv4, private_ipv4, public_ipv6,or vrf
    vrfId Integer
    ipAddress String
    address string
    addressFamily number
    cidr number
    cidrNotation string
    facility string

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    gateway string
    global boolean
    id string
    manageable boolean
    management boolean
    metro string
    netmask string
    network string
    projectId string
    public boolean
    quantity number
    type string
    One of global_ipv4, public_ipv4, private_ipv4, public_ipv6,or vrf
    vrfId number
    ipAddress string
    address str
    address_family int
    cidr int
    cidr_notation str
    facility str

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    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,or vrf
    vrf_id int
    ip_address str
    address String
    addressFamily Number
    cidr Number
    cidrNotation String
    facility String

    Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

    gateway String
    global Boolean
    id String
    manageable Boolean
    management Boolean
    metro String
    netmask String
    network String
    projectId String
    public Boolean
    quantity Number
    type String
    One of global_ipv4, public_ipv4, private_ipv4, public_ipv6,or vrf
    vrfId Number
    ipAddress String

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix