1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudFloatingIp
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

    Use this data source to retrieve information about a floating IP in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const ip = ovh.getCloudFloatingIp({
        serviceName: "<public cloud project ID>",
        id: "<floating IP address>",
    });
    export const floatingIpStatus = ip.then(ip => ip.resourceStatus);
    
    import pulumi
    import pulumi_ovh as ovh
    
    ip = ovh.get_cloud_floating_ip(service_name="<public cloud project ID>",
        id="<floating IP address>")
    pulumi.export("floatingIpStatus", ip.resource_status)
    
    package main
    
    import (
    	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		ip, err := ovh.LookupCloudFloatingIp(ctx, &ovh.LookupCloudFloatingIpArgs{
    			ServiceName: pulumi.StringRef("<public cloud project ID>"),
    			Id:          "<floating IP address>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("floatingIpStatus", ip.ResourceStatus)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var ip = Ovh.GetCloudFloatingIp.Invoke(new()
        {
            ServiceName = "<public cloud project ID>",
            Id = "<floating IP address>",
        });
    
        return new Dictionary<string, object?>
        {
            ["floatingIpStatus"] = ip.Apply(getCloudFloatingIpResult => getCloudFloatingIpResult.ResourceStatus),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ovh.OvhFunctions;
    import com.pulumi.ovh.inputs.GetCloudFloatingIpArgs;
    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 ip = OvhFunctions.getCloudFloatingIp(GetCloudFloatingIpArgs.builder()
                .serviceName("<public cloud project ID>")
                .id("<floating IP address>")
                .build());
    
            ctx.export("floatingIpStatus", ip.resourceStatus());
        }
    }
    
    variables:
      ip:
        fn::invoke:
          function: ovh:getCloudFloatingIp
          arguments:
            serviceName: <public cloud project ID>
            id: <floating IP address>
    outputs:
      floatingIpStatus: ${ip.resourceStatus}
    
    Example coming soon!
    

    Using getCloudFloatingIp

    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 getCloudFloatingIp(args: GetCloudFloatingIpArgs, opts?: InvokeOptions): Promise<GetCloudFloatingIpResult>
    function getCloudFloatingIpOutput(args: GetCloudFloatingIpOutputArgs, opts?: InvokeOptions): Output<GetCloudFloatingIpResult>
    def get_cloud_floating_ip(id: Optional[str] = None,
                              service_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCloudFloatingIpResult
    def get_cloud_floating_ip_output(id: pulumi.Input[Optional[str]] = None,
                              service_name: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudFloatingIpResult]
    func LookupCloudFloatingIp(ctx *Context, args *LookupCloudFloatingIpArgs, opts ...InvokeOption) (*LookupCloudFloatingIpResult, error)
    func LookupCloudFloatingIpOutput(ctx *Context, args *LookupCloudFloatingIpOutputArgs, opts ...InvokeOption) LookupCloudFloatingIpResultOutput

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

    public static class GetCloudFloatingIp 
    {
        public static Task<GetCloudFloatingIpResult> InvokeAsync(GetCloudFloatingIpArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudFloatingIpResult> Invoke(GetCloudFloatingIpInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudFloatingIpResult> getCloudFloatingIp(GetCloudFloatingIpArgs args, InvokeOptions options)
    public static Output<GetCloudFloatingIpResult> getCloudFloatingIp(GetCloudFloatingIpArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudFloatingIp:getCloudFloatingIp
      arguments:
        # arguments dictionary
    data "ovh_get_cloud_floating_ip" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    IP address of the floating IP.
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Id string
    IP address of the floating IP.
    ServiceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    id string
    IP address of the floating IP.
    service_name string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    id String
    IP address of the floating IP.
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    id string
    IP address of the floating IP.
    serviceName string
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    id str
    IP address of the floating IP.
    service_name str
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    id String
    IP address of the floating IP.
    serviceName String
    Service name of the resource representing the id of the cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    getCloudFloatingIp Result

    The following output properties are available:

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the floating IP.
    CurrentState GetCloudFloatingIpCurrentState
    Current state of the floating IP:
    CurrentTasks List<GetCloudFloatingIpCurrentTask>
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    Description string
    Description of the floating IP.
    Id string
    Identifier of the current task.
    Location GetCloudFloatingIpLocation
    Location details:
    ResourceStatus string
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    UpdatedAt string
    Last update date of the floating IP.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the floating IP.
    CurrentState GetCloudFloatingIpCurrentState
    Current state of the floating IP:
    CurrentTasks []GetCloudFloatingIpCurrentTask
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    Description string
    Description of the floating IP.
    Id string
    Identifier of the current task.
    Location GetCloudFloatingIpLocation
    Location details:
    ResourceStatus string
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    UpdatedAt string
    Last update date of the floating IP.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the floating IP.
    current_state object
    Current state of the floating IP:
    current_tasks list(object)
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    description string
    Description of the floating IP.
    id string
    Identifier of the current task.
    location object
    Location details:
    resource_status string
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    updated_at string
    Last update date of the floating IP.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the floating IP.
    currentState GetCloudFloatingIpCurrentState
    Current state of the floating IP:
    currentTasks List<GetCloudFloatingIpCurrentTask>
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    description String
    Description of the floating IP.
    id String
    Identifier of the current task.
    location GetCloudFloatingIpLocation
    Location details:
    resourceStatus String
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    updatedAt String
    Last update date of the floating IP.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the floating IP.
    currentState GetCloudFloatingIpCurrentState
    Current state of the floating IP:
    currentTasks GetCloudFloatingIpCurrentTask[]
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    description string
    Description of the floating IP.
    id string
    Identifier of the current task.
    location GetCloudFloatingIpLocation
    Location details:
    resourceStatus string
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    updatedAt string
    Last update date of the floating IP.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the floating IP.
    current_state GetCloudFloatingIpCurrentState
    Current state of the floating IP:
    current_tasks Sequence[GetCloudFloatingIpCurrentTask]
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    description str
    Description of the floating IP.
    id str
    Identifier of the current task.
    location GetCloudFloatingIpLocation
    Location details:
    resource_status str
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    updated_at str
    Last update date of the floating IP.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the floating IP.
    currentState Property Map
    Current state of the floating IP:
    currentTasks List<Property Map>
    Ongoing asynchronous tasks related to the floating IP. Each element exports:
    description String
    Description of the floating IP.
    id String
    Identifier of the current task.
    location Property Map
    Location details:
    resourceStatus String
    Floating IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    updatedAt String
    Last update date of the floating IP.

    Supporting Types

    GetCloudFloatingIpCurrentState

    AssociatedResource GetCloudFloatingIpCurrentStateAssociatedResource
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    Description string
    Description of the floating IP.
    Id string
    IP address of the floating IP.
    Ip string
    IP address of the floating IP.
    Location GetCloudFloatingIpCurrentStateLocation
    Location details:
    Network GetCloudFloatingIpCurrentStateNetwork
    External network the floating IP belongs to:
    Status string
    Current global status of the current task.
    AssociatedResource GetCloudFloatingIpCurrentStateAssociatedResource
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    Description string
    Description of the floating IP.
    Id string
    IP address of the floating IP.
    Ip string
    IP address of the floating IP.
    Location GetCloudFloatingIpCurrentStateLocation
    Location details:
    Network GetCloudFloatingIpCurrentStateNetwork
    External network the floating IP belongs to:
    Status string
    Current global status of the current task.
    associated_resource object
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    description string
    Description of the floating IP.
    id string
    IP address of the floating IP.
    ip string
    IP address of the floating IP.
    location object
    Location details:
    network object
    External network the floating IP belongs to:
    status string
    Current global status of the current task.
    associatedResource GetCloudFloatingIpCurrentStateAssociatedResource
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    description String
    Description of the floating IP.
    id String
    IP address of the floating IP.
    ip String
    IP address of the floating IP.
    location GetCloudFloatingIpCurrentStateLocation
    Location details:
    network GetCloudFloatingIpCurrentStateNetwork
    External network the floating IP belongs to:
    status String
    Current global status of the current task.
    associatedResource GetCloudFloatingIpCurrentStateAssociatedResource
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    description string
    Description of the floating IP.
    id string
    IP address of the floating IP.
    ip string
    IP address of the floating IP.
    location GetCloudFloatingIpCurrentStateLocation
    Location details:
    network GetCloudFloatingIpCurrentStateNetwork
    External network the floating IP belongs to:
    status string
    Current global status of the current task.
    associated_resource GetCloudFloatingIpCurrentStateAssociatedResource
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    description str
    Description of the floating IP.
    id str
    IP address of the floating IP.
    ip str
    IP address of the floating IP.
    location GetCloudFloatingIpCurrentStateLocation
    Location details:
    network GetCloudFloatingIpCurrentStateNetwork
    External network the floating IP belongs to:
    status str
    Current global status of the current task.
    associatedResource Property Map
    Resource the floating IP is currently attached to. Null when the floating IP is not attached to any resource:
    description String
    Description of the floating IP.
    id String
    IP address of the floating IP.
    ip String
    IP address of the floating IP.
    location Property Map
    Location details:
    network Property Map
    External network the floating IP belongs to:
    status String
    Current global status of the current task.

    GetCloudFloatingIpCurrentStateAssociatedResource

    Id string
    IP address of the floating IP.
    Type string
    Type of the current task.
    Id string
    IP address of the floating IP.
    Type string
    Type of the current task.
    id string
    IP address of the floating IP.
    type string
    Type of the current task.
    id String
    IP address of the floating IP.
    type String
    Type of the current task.
    id string
    IP address of the floating IP.
    type string
    Type of the current task.
    id str
    IP address of the floating IP.
    type str
    Type of the current task.
    id String
    IP address of the floating IP.
    type String
    Type of the current task.

    GetCloudFloatingIpCurrentStateLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.

    GetCloudFloatingIpCurrentStateNetwork

    Id string
    IP address of the floating IP.
    Id string
    IP address of the floating IP.
    id string
    IP address of the floating IP.
    id String
    IP address of the floating IP.
    id string
    IP address of the floating IP.
    id str
    IP address of the floating IP.
    id String
    IP address of the floating IP.

    GetCloudFloatingIpCurrentTask

    Errors List<GetCloudFloatingIpCurrentTaskError>
    Errors that occurred on the task:
    Id string
    IP address of the floating IP.
    Link string
    Link to the task details.
    Status string
    Current global status of the current task.
    Type string
    Type of the current task.
    Errors []GetCloudFloatingIpCurrentTaskError
    Errors that occurred on the task:
    Id string
    IP address of the floating IP.
    Link string
    Link to the task details.
    Status string
    Current global status of the current task.
    Type string
    Type of the current task.
    errors list(object)
    Errors that occurred on the task:
    id string
    IP address of the floating IP.
    link string
    Link to the task details.
    status string
    Current global status of the current task.
    type string
    Type of the current task.
    errors List<GetCloudFloatingIpCurrentTaskError>
    Errors that occurred on the task:
    id String
    IP address of the floating IP.
    link String
    Link to the task details.
    status String
    Current global status of the current task.
    type String
    Type of the current task.
    errors GetCloudFloatingIpCurrentTaskError[]
    Errors that occurred on the task:
    id string
    IP address of the floating IP.
    link string
    Link to the task details.
    status string
    Current global status of the current task.
    type string
    Type of the current task.
    errors Sequence[GetCloudFloatingIpCurrentTaskError]
    Errors that occurred on the task:
    id str
    IP address of the floating IP.
    link str
    Link to the task details.
    status str
    Current global status of the current task.
    type str
    Type of the current task.
    errors List<Property Map>
    Errors that occurred on the task:
    id String
    IP address of the floating IP.
    link String
    Link to the task details.
    status String
    Current global status of the current task.
    type String
    Type of the current task.

    GetCloudFloatingIpCurrentTaskError

    Message string
    Error description.
    Message string
    Error description.
    message string
    Error description.
    message String
    Error description.
    message string
    Error description.
    message str
    Error description.
    message String
    Error description.

    GetCloudFloatingIpLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial