1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsFloatingIps
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIsFloatingIps

Explore with Pulumi AI

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";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsFloatingIps({
    name: "example-floating-ips",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_floating_ips(name="example-floating-ips")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsFloatingIps
      arguments:
        name: example-floating-ips
Copy

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>
Copy
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]
Copy
func GetIsFloatingIps(ctx *Context, args *GetIsFloatingIpsArgs, opts ...InvokeOption) (*GetIsFloatingIpsResult, error)
func GetIsFloatingIpsOutput(ctx *Context, args *GetIsFloatingIpsOutputArgs, opts ...InvokeOption) GetIsFloatingIpsResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetIsFloatingIpsResult> getIsFloatingIps(GetIsFloatingIpsArgs args, InvokeOptions options)
public static Output<GetIsFloatingIpsResult> getIsFloatingIps(GetIsFloatingIpsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsFloatingIps:getIsFloatingIps
  arguments:
    # arguments dictionary
Copy

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 This property is required. List<string>
(String) Access management tags associated for the floating ip.
Address This property is required. 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 This property is required. string
(String) The date and time that the floating IP was created.
Crn This property is required. string
(String) The CRN for this public gateway.
Href This property is required. string
(String) The URL for this zone.
Id This property is required. string
(String) The unique identifier for this network interface.
Name This property is required. string
The unique user-defined name for this floating IP.
ResourceGroups This property is required. List<GetIsFloatingIpsFloatingIpResourceGroup>
The ID of the Resource group this floating ips belongs to.
Status This property is required. string
(String) The status of the floating IP.
Targets This property is required. List<GetIsFloatingIpsFloatingIpTarget>
(List) The target of this floating IP.
Zones This property is required. List<GetIsFloatingIpsFloatingIpZone>
(List) The zone this floating IP resides in.
AccessTags This property is required. []string
(String) Access management tags associated for the floating ip.
Address This property is required. 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 This property is required. string
(String) The date and time that the floating IP was created.
Crn This property is required. string
(String) The CRN for this public gateway.
Href This property is required. string
(String) The URL for this zone.
Id This property is required. string
(String) The unique identifier for this network interface.
Name This property is required. string
The unique user-defined name for this floating IP.
ResourceGroups This property is required. []GetIsFloatingIpsFloatingIpResourceGroup
The ID of the Resource group this floating ips belongs to.
Status This property is required. string
(String) The status of the floating IP.
Targets This property is required. []GetIsFloatingIpsFloatingIpTarget
(List) The target of this floating IP.
Zones This property is required. []GetIsFloatingIpsFloatingIpZone
(List) The zone this floating IP resides in.
accessTags This property is required. List<String>
(String) Access management tags associated for the floating ip.
address This property is required. 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 This property is required. String
(String) The date and time that the floating IP was created.
crn This property is required. String
(String) The CRN for this public gateway.
href This property is required. String
(String) The URL for this zone.
id This property is required. String
(String) The unique identifier for this network interface.
name This property is required. String
The unique user-defined name for this floating IP.
resourceGroups This property is required. List<GetIsFloatingIpsFloatingIpResourceGroup>
The ID of the Resource group this floating ips belongs to.
status This property is required. String
(String) The status of the floating IP.
targets This property is required. List<GetIsFloatingIpsFloatingIpTarget>
(List) The target of this floating IP.
zones This property is required. List<GetIsFloatingIpsFloatingIpZone>
(List) The zone this floating IP resides in.
accessTags This property is required. string[]
(String) Access management tags associated for the floating ip.
address This property is required. 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 This property is required. string
(String) The date and time that the floating IP was created.
crn This property is required. string
(String) The CRN for this public gateway.
href This property is required. string
(String) The URL for this zone.
id This property is required. string
(String) The unique identifier for this network interface.
name This property is required. string
The unique user-defined name for this floating IP.
resourceGroups This property is required. GetIsFloatingIpsFloatingIpResourceGroup[]
The ID of the Resource group this floating ips belongs to.
status This property is required. string
(String) The status of the floating IP.
targets This property is required. GetIsFloatingIpsFloatingIpTarget[]
(List) The target of this floating IP.
zones This property is required. GetIsFloatingIpsFloatingIpZone[]
(List) The zone this floating IP resides in.
access_tags This property is required. Sequence[str]
(String) Access management tags associated for the floating ip.
address This property is required. 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 This property is required. str
(String) The date and time that the floating IP was created.
crn This property is required. str
(String) The CRN for this public gateway.
href This property is required. str
(String) The URL for this zone.
id This property is required. str
(String) The unique identifier for this network interface.
name This property is required. str
The unique user-defined name for this floating IP.
resource_groups This property is required. Sequence[GetIsFloatingIpsFloatingIpResourceGroup]
The ID of the Resource group this floating ips belongs to.
status This property is required. str
(String) The status of the floating IP.
targets This property is required. Sequence[GetIsFloatingIpsFloatingIpTarget]
(List) The target of this floating IP.
zones This property is required. Sequence[GetIsFloatingIpsFloatingIpZone]
(List) The zone this floating IP resides in.
accessTags This property is required. List<String>
(String) Access management tags associated for the floating ip.
address This property is required. 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 This property is required. String
(String) The date and time that the floating IP was created.
crn This property is required. String
(String) The CRN for this public gateway.
href This property is required. String
(String) The URL for this zone.
id This property is required. String
(String) The unique identifier for this network interface.
name This property is required. String
The unique user-defined name for this floating IP.
resourceGroups This property is required. List<Property Map>
The ID of the Resource group this floating ips belongs to.
status This property is required. String
(String) The status of the floating IP.
targets This property is required. List<Property Map>
(List) The target of this floating IP.
zones This property is required. List<Property Map>
(List) The zone this floating IP resides in.

GetIsFloatingIpsFloatingIpResourceGroup

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

GetIsFloatingIpsFloatingIpTarget

Crn This property is required. string
(String) The CRN for this public gateway.
Deleteds This property is required. List<GetIsFloatingIpsFloatingIpTargetDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
Href This property is required. string
(String) The URL for this zone.
Id This property is required. string
(String) The unique identifier for this network interface.
Name This property is required. string
The unique user-defined name for this floating IP.
PrimaryIps This property is required. List<GetIsFloatingIpsFloatingIpTargetPrimaryIp>
(List) The reserved ip reference.
PrimaryIpv4Address This property is required. 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 This property is required. string
(String) The resource type.
Crn This property is required. string
(String) The CRN for this public gateway.
Deleteds This property is required. []GetIsFloatingIpsFloatingIpTargetDeleted
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
Href This property is required. string
(String) The URL for this zone.
Id This property is required. string
(String) The unique identifier for this network interface.
Name This property is required. string
The unique user-defined name for this floating IP.
PrimaryIps This property is required. []GetIsFloatingIpsFloatingIpTargetPrimaryIp
(List) The reserved ip reference.
PrimaryIpv4Address This property is required. 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 This property is required. string
(String) The resource type.
crn This property is required. String
(String) The CRN for this public gateway.
deleteds This property is required. List<GetIsFloatingIpsFloatingIpTargetDeleted>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
href This property is required. String
(String) The URL for this zone.
id This property is required. String
(String) The unique identifier for this network interface.
name This property is required. String
The unique user-defined name for this floating IP.
primaryIps This property is required. List<GetIsFloatingIpsFloatingIpTargetPrimaryIp>
(List) The reserved ip reference.
primaryIpv4Address This property is required. 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 This property is required. String
(String) The resource type.
crn This property is required. string
(String) The CRN for this public gateway.
deleteds This property is required. GetIsFloatingIpsFloatingIpTargetDeleted[]
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
href This property is required. string
(String) The URL for this zone.
id This property is required. string
(String) The unique identifier for this network interface.
name This property is required. string
The unique user-defined name for this floating IP.
primaryIps This property is required. GetIsFloatingIpsFloatingIpTargetPrimaryIp[]
(List) The reserved ip reference.
primaryIpv4Address This property is required. 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 This property is required. string
(String) The resource type.
crn This property is required. str
(String) The CRN for this public gateway.
deleteds This property is required. Sequence[GetIsFloatingIpsFloatingIpTargetDeleted]
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
href This property is required. str
(String) The URL for this zone.
id This property is required. str
(String) The unique identifier for this network interface.
name This property is required. str
The unique user-defined name for this floating IP.
primary_ips This property is required. Sequence[GetIsFloatingIpsFloatingIpTargetPrimaryIp]
(List) The reserved ip reference.
primary_ipv4_address This property is required. 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 This property is required. str
(String) The resource type.
crn This property is required. String
(String) The CRN for this public gateway.
deleteds This property is required. List<Property Map>
(List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information.
href This property is required. String
(String) The URL for this zone.
id This property is required. String
(String) The unique identifier for this network interface.
name This property is required. String
The unique user-defined name for this floating IP.
primaryIps This property is required. List<Property Map>
(List) The reserved ip reference.
primaryIpv4Address This property is required. 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 This property is required. String
(String) The resource type.

GetIsFloatingIpsFloatingIpTargetDeleted

MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
MoreInfo This property is required. string
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.
moreInfo This property is required. string
(String) Link to documentation about deleted resources.
more_info This property is required. str
(String) Link to documentation about deleted resources.
moreInfo This property is required. String
(String) Link to documentation about deleted resources.

GetIsFloatingIpsFloatingIpTargetPrimaryIp

Address This property is required. 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 This property is required. string
(String) The URL for this zone.
Name This property is required. string
The unique user-defined name for this floating IP.
ReservedIp This property is required. string
(String) The unique identifier for this reserved IP
ResourceType This property is required. string
(String) The resource type.
Address This property is required. 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 This property is required. string
(String) The URL for this zone.
Name This property is required. string
The unique user-defined name for this floating IP.
ReservedIp This property is required. string
(String) The unique identifier for this reserved IP
ResourceType This property is required. string
(String) The resource type.
address This property is required. 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 This property is required. String
(String) The URL for this zone.
name This property is required. String
The unique user-defined name for this floating IP.
reservedIp This property is required. String
(String) The unique identifier for this reserved IP
resourceType This property is required. String
(String) The resource type.
address This property is required. 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 This property is required. string
(String) The URL for this zone.
name This property is required. string
The unique user-defined name for this floating IP.
reservedIp This property is required. string
(String) The unique identifier for this reserved IP
resourceType This property is required. string
(String) The resource type.
address This property is required. 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 This property is required. str
(String) The URL for this zone.
name This property is required. str
The unique user-defined name for this floating IP.
reserved_ip This property is required. str
(String) The unique identifier for this reserved IP
resource_type This property is required. str
(String) The resource type.
address This property is required. 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 This property is required. String
(String) The URL for this zone.
name This property is required. String
The unique user-defined name for this floating IP.
reservedIp This property is required. String
(String) The unique identifier for this reserved IP
resourceType This property is required. String
(String) The resource type.

GetIsFloatingIpsFloatingIpZone

Href This property is required. string
(String) The URL for this zone.
Name This property is required. string
The unique user-defined name for this floating IP.
Href This property is required. string
(String) The URL for this zone.
Name This property is required. string
The unique user-defined name for this floating IP.
href This property is required. String
(String) The URL for this zone.
name This property is required. String
The unique user-defined name for this floating IP.
href This property is required. string
(String) The URL for this zone.
name This property is required. string
The unique user-defined name for this floating IP.
href This property is required. str
(String) The URL for this zone.
name This property is required. str
The unique user-defined name for this floating IP.
href This property is required. String
(String) The URL for this zone.
name This property is required. 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.