1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsFloatingIps
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIsFloatingIps

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve an information of VPC floating IPs on IBM Cloud. For more information, about floating IP, see about floating IP.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsFloatingIps({
        name: "example-floating-ips",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_floating_ips(name="example-floating-ips")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetIsFloatingIps(ctx, &ibm.GetIsFloatingIpsArgs{
    			Name: pulumi.StringRef("example-floating-ips"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Ibm.GetIsFloatingIps.Invoke(new()
        {
            Name = "example-floating-ips",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetIsFloatingIpsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = IbmFunctions.getIsFloatingIps(GetIsFloatingIpsArgs.builder()
                .name("example-floating-ips")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsFloatingIps
          arguments:
            name: example-floating-ips
    

    Using getIsFloatingIps

    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 getIsFloatingIps(args: GetIsFloatingIpsArgs, opts?: InvokeOptions): Promise<GetIsFloatingIpsResult>
    function getIsFloatingIpsOutput(args: GetIsFloatingIpsOutputArgs, opts?: InvokeOptions): Output<GetIsFloatingIpsResult>
    def get_is_floating_ips(id: Optional[str] = None,
                            name: Optional[str] = None,
                            resource_group: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetIsFloatingIpsResult
    def get_is_floating_ips_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            resource_group: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetIsFloatingIpsResult]
    func GetIsFloatingIps(ctx *Context, args *GetIsFloatingIpsArgs, opts ...InvokeOption) (*GetIsFloatingIpsResult, error)
    func GetIsFloatingIpsOutput(ctx *Context, args *GetIsFloatingIpsOutputArgs, opts ...InvokeOption) GetIsFloatingIpsResultOutput

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

    public static class GetIsFloatingIps 
    {
        public static Task<GetIsFloatingIpsResult> InvokeAsync(GetIsFloatingIpsArgs args, InvokeOptions? opts = null)
        public static Output<GetIsFloatingIpsResult> Invoke(GetIsFloatingIpsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsFloatingIpsResult> getIsFloatingIps(GetIsFloatingIpsArgs args, InvokeOptions options)
    public static Output<GetIsFloatingIpsResult> getIsFloatingIps(GetIsFloatingIpsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsFloatingIps:getIsFloatingIps
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    ResourceGroup string
    The ID of the Resource group this floating ips belongs to.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    ResourceGroup string
    The ID of the Resource group this floating ips belongs to.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    resourceGroup String
    The ID of the Resource group this floating ips belongs to.
    id string
    (String) The unique identifier for this network interface.
    name string
    The unique user-defined name for this floating IP.
    resourceGroup string
    The ID of the Resource group this floating ips belongs to.
    id str
    (String) The unique identifier for this network interface.
    name str
    The unique user-defined name for this floating IP.
    resource_group str
    The ID of the Resource group this floating ips belongs to.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    resourceGroup String
    The ID of the Resource group this floating ips belongs to.

    getIsFloatingIps Result

    The following output properties are available:

    FloatingIps List<GetIsFloatingIpsFloatingIp>
    (List) Collection of floating IPs.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    (String) The globally unique name for this zone.
    ResourceGroup string
    (List) The resource group object, for this floating IP.
    FloatingIps []GetIsFloatingIpsFloatingIp
    (List) Collection of floating IPs.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    (String) The globally unique name for this zone.
    ResourceGroup string
    (List) The resource group object, for this floating IP.
    floatingIps List<GetIsFloatingIpsFloatingIp>
    (List) Collection of floating IPs.
    id String
    (String) The unique identifier for this network interface.
    name String
    (String) The globally unique name for this zone.
    resourceGroup String
    (List) The resource group object, for this floating IP.
    floatingIps GetIsFloatingIpsFloatingIp[]
    (List) Collection of floating IPs.
    id string
    (String) The unique identifier for this network interface.
    name string
    (String) The globally unique name for this zone.
    resourceGroup string
    (List) The resource group object, for this floating IP.
    floating_ips Sequence[GetIsFloatingIpsFloatingIp]
    (List) Collection of floating IPs.
    id str
    (String) The unique identifier for this network interface.
    name str
    (String) The globally unique name for this zone.
    resource_group str
    (List) The resource group object, for this floating IP.
    floatingIps List<Property Map>
    (List) Collection of floating IPs.
    id String
    (String) The unique identifier for this network interface.
    name String
    (String) The globally unique name for this zone.
    resourceGroup String
    (List) The resource group object, for this floating IP.

    Supporting Types

    GetIsFloatingIpsFloatingIp

    AccessTags List<string>
    (String) Access management tags associated for the floating ip.
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    CreatedAt string
    (String) The date and time that the floating IP was created.
    Crn string
    (String) The CRN for this public gateway.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    ResourceGroups List<GetIsFloatingIpsFloatingIpResourceGroup>
    The ID of the Resource group this floating ips belongs to.
    Status string
    (String) The status of the floating IP.
    Targets List<GetIsFloatingIpsFloatingIpTarget>
    (List) The target of this floating IP.
    Zones List<GetIsFloatingIpsFloatingIpZone>
    (List) The zone this floating IP resides in.
    AccessTags []string
    (String) Access management tags associated for the floating ip.
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    CreatedAt string
    (String) The date and time that the floating IP was created.
    Crn string
    (String) The CRN for this public gateway.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    ResourceGroups []GetIsFloatingIpsFloatingIpResourceGroup
    The ID of the Resource group this floating ips belongs to.
    Status string
    (String) The status of the floating IP.
    Targets []GetIsFloatingIpsFloatingIpTarget
    (List) The target of this floating IP.
    Zones []GetIsFloatingIpsFloatingIpZone
    (List) The zone this floating IP resides in.
    accessTags List<String>
    (String) Access management tags associated for the floating ip.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    createdAt String
    (String) The date and time that the floating IP was created.
    crn String
    (String) The CRN for this public gateway.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    resourceGroups List<GetIsFloatingIpsFloatingIpResourceGroup>
    The ID of the Resource group this floating ips belongs to.
    status String
    (String) The status of the floating IP.
    targets List<GetIsFloatingIpsFloatingIpTarget>
    (List) The target of this floating IP.
    zones List<GetIsFloatingIpsFloatingIpZone>
    (List) The zone this floating IP resides in.
    accessTags string[]
    (String) Access management tags associated for the floating ip.
    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    createdAt string
    (String) The date and time that the floating IP was created.
    crn string
    (String) The CRN for this public gateway.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this network interface.
    name string
    The unique user-defined name for this floating IP.
    resourceGroups GetIsFloatingIpsFloatingIpResourceGroup[]
    The ID of the Resource group this floating ips belongs to.
    status string
    (String) The status of the floating IP.
    targets GetIsFloatingIpsFloatingIpTarget[]
    (List) The target of this floating IP.
    zones GetIsFloatingIpsFloatingIpZone[]
    (List) The zone this floating IP resides in.
    access_tags Sequence[str]
    (String) Access management tags associated for the floating ip.
    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    created_at str
    (String) The date and time that the floating IP was created.
    crn str
    (String) The CRN for this public gateway.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this network interface.
    name str
    The unique user-defined name for this floating IP.
    resource_groups Sequence[GetIsFloatingIpsFloatingIpResourceGroup]
    The ID of the Resource group this floating ips belongs to.
    status str
    (String) The status of the floating IP.
    targets Sequence[GetIsFloatingIpsFloatingIpTarget]
    (List) The target of this floating IP.
    zones Sequence[GetIsFloatingIpsFloatingIpZone]
    (List) The zone this floating IP resides in.
    accessTags List<String>
    (String) Access management tags associated for the floating ip.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    createdAt String
    (String) The date and time that the floating IP was created.
    crn String
    (String) The CRN for this public gateway.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    resourceGroups List<Property Map>
    The ID of the Resource group this floating ips belongs to.
    status String
    (String) The status of the floating IP.
    targets List<Property Map>
    (List) The target of this floating IP.
    zones List<Property Map>
    (List) The zone this floating IP resides in.

    GetIsFloatingIpsFloatingIpResourceGroup

    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this network interface.
    name string
    The unique user-defined name for this floating IP.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this network interface.
    name str
    The unique user-defined name for this floating IP.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.

    GetIsFloatingIpsFloatingIpTarget

    Crn string
    (String) The CRN for this public gateway.
    Deleteds List<GetIsFloatingIpsFloatingIpTargetDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    PrimaryIps List<GetIsFloatingIpsFloatingIpTargetPrimaryIp>
    (List) The reserved ip reference.
    PrimaryIpv4Address string
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN for this public gateway.
    Deleteds []GetIsFloatingIpsFloatingIpTargetDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    Href string
    (String) The URL for this zone.
    Id string
    (String) The unique identifier for this network interface.
    Name string
    The unique user-defined name for this floating IP.
    PrimaryIps []GetIsFloatingIpsFloatingIpTargetPrimaryIp
    (List) The reserved ip reference.
    PrimaryIpv4Address string
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN for this public gateway.
    deleteds List<GetIsFloatingIpsFloatingIpTargetDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    primaryIps List<GetIsFloatingIpsFloatingIpTargetPrimaryIp>
    (List) The reserved ip reference.
    primaryIpv4Address String
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN for this public gateway.
    deleteds GetIsFloatingIpsFloatingIpTargetDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href string
    (String) The URL for this zone.
    id string
    (String) The unique identifier for this network interface.
    name string
    The unique user-defined name for this floating IP.
    primaryIps GetIsFloatingIpsFloatingIpTargetPrimaryIp[]
    (List) The reserved ip reference.
    primaryIpv4Address string
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN for this public gateway.
    deleteds Sequence[GetIsFloatingIpsFloatingIpTargetDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href str
    (String) The URL for this zone.
    id str
    (String) The unique identifier for this network interface.
    name str
    The unique user-defined name for this floating IP.
    primary_ips Sequence[GetIsFloatingIpsFloatingIpTargetPrimaryIp]
    (List) The reserved ip reference.
    primary_ipv4_address str
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    resource_type str
    (String) The resource type.
    crn String
    (String) The CRN for this public gateway.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
    href String
    (String) The URL for this zone.
    id String
    (String) The unique identifier for this network interface.
    name String
    The unique user-defined name for this floating IP.
    primaryIps List<Property Map>
    (List) The reserved ip reference.
    primaryIpv4Address String
    (String) The primary IPv4 address. If the address has not yet been selected, the value will be 0.0.0.0. Same as primary_ip.0.address
    resourceType String
    (String) The resource type.

    GetIsFloatingIpsFloatingIpTargetDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.

    GetIsFloatingIpsFloatingIpTargetPrimaryIp

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Href string
    (String) The URL for this zone.
    Name string
    The unique user-defined name for this floating IP.
    ReservedIp string
    (String) The unique identifier for this reserved IP
    ResourceType string
    (String) The resource type.
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Href string
    (String) The URL for this zone.
    Name string
    The unique user-defined name for this floating IP.
    ReservedIp string
    (String) The unique identifier for this reserved IP
    ResourceType string
    (String) The resource type.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href String
    (String) The URL for this zone.
    name String
    The unique user-defined name for this floating IP.
    reservedIp String
    (String) The unique identifier for this reserved IP
    resourceType String
    (String) The resource type.
    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href string
    (String) The URL for this zone.
    name string
    The unique user-defined name for this floating IP.
    reservedIp string
    (String) The unique identifier for this reserved IP
    resourceType string
    (String) The resource type.
    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href str
    (String) The URL for this zone.
    name str
    The unique user-defined name for this floating IP.
    reserved_ip str
    (String) The unique identifier for this reserved IP
    resource_type str
    (String) The resource type.
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    href String
    (String) The URL for this zone.
    name String
    The unique user-defined name for this floating IP.
    reservedIp String
    (String) The unique identifier for this reserved IP
    resourceType String
    (String) The resource type.

    GetIsFloatingIpsFloatingIpZone

    Href string
    (String) The URL for this zone.
    Name string
    The unique user-defined name for this floating IP.
    Href string
    (String) The URL for this zone.
    Name string
    The unique user-defined name for this floating IP.
    href String
    (String) The URL for this zone.
    name String
    The unique user-defined name for this floating IP.
    href string
    (String) The URL for this zone.
    name string
    The unique user-defined name for this floating IP.
    href str
    (String) The URL for this zone.
    name str
    The unique user-defined name for this floating IP.
    href String
    (String) The URL for this zone.
    name String
    The unique user-defined name for this floating IP.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud