1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudExtNetIp
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 an external network IP in a public cloud project. External network IPs are created and deleted through the lifecycle of other products (typically instances attached to the public network), so this data source is a read-only view.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const ip = ovh.getCloudExtNetIp({
        serviceName: "<public cloud project ID>",
        id: "<external network IP address>",
    });
    export const extNetIpStatus = ip.then(ip => ip.resourceStatus);
    
    import pulumi
    import pulumi_ovh as ovh
    
    ip = ovh.get_cloud_ext_net_ip(service_name="<public cloud project ID>",
        id="<external network IP address>")
    pulumi.export("extNetIpStatus", 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.GetCloudExtNetIp(ctx, &ovh.GetCloudExtNetIpArgs{
    			ServiceName: pulumi.StringRef("<public cloud project ID>"),
    			Id:          "<external network IP address>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("extNetIpStatus", ip.ResourceStatus)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ovh = Pulumi.Ovh;
    
    return await Deployment.RunAsync(() => 
    {
        var ip = Ovh.GetCloudExtNetIp.Invoke(new()
        {
            ServiceName = "<public cloud project ID>",
            Id = "<external network IP address>",
        });
    
        return new Dictionary<string, object?>
        {
            ["extNetIpStatus"] = ip.Apply(getCloudExtNetIpResult => getCloudExtNetIpResult.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.GetCloudExtNetIpArgs;
    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.getCloudExtNetIp(GetCloudExtNetIpArgs.builder()
                .serviceName("<public cloud project ID>")
                .id("<external network IP address>")
                .build());
    
            ctx.export("extNetIpStatus", ip.resourceStatus());
        }
    }
    
    variables:
      ip:
        fn::invoke:
          function: ovh:getCloudExtNetIp
          arguments:
            serviceName: <public cloud project ID>
            id: <external network IP address>
    outputs:
      extNetIpStatus: ${ip.resourceStatus}
    
    Example coming soon!
    

    Using getCloudExtNetIp

    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 getCloudExtNetIp(args: GetCloudExtNetIpArgs, opts?: InvokeOptions): Promise<GetCloudExtNetIpResult>
    function getCloudExtNetIpOutput(args: GetCloudExtNetIpOutputArgs, opts?: InvokeOptions): Output<GetCloudExtNetIpResult>
    def get_cloud_ext_net_ip(id: Optional[str] = None,
                             service_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCloudExtNetIpResult
    def get_cloud_ext_net_ip_output(id: pulumi.Input[Optional[str]] = None,
                             service_name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCloudExtNetIpResult]
    func GetCloudExtNetIp(ctx *Context, args *GetCloudExtNetIpArgs, opts ...InvokeOption) (*GetCloudExtNetIpResult, error)
    func GetCloudExtNetIpOutput(ctx *Context, args *GetCloudExtNetIpOutputArgs, opts ...InvokeOption) GetCloudExtNetIpResultOutput

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

    public static class GetCloudExtNetIp 
    {
        public static Task<GetCloudExtNetIpResult> InvokeAsync(GetCloudExtNetIpArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudExtNetIpResult> Invoke(GetCloudExtNetIpInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudExtNetIpResult> getCloudExtNetIp(GetCloudExtNetIpArgs args, InvokeOptions options)
    public static Output<GetCloudExtNetIpResult> getCloudExtNetIp(GetCloudExtNetIpArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudExtNetIp:getCloudExtNetIp
      arguments:
        # arguments dictionary
    data "ovh_get_cloud_ext_net_ip" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    IP address of the external network 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 external network 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 external network 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 external network 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 external network 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 external network 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 external network 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.

    getCloudExtNetIp Result

    The following output properties are available:

    Checksum string
    Checksum field of the API envelope. Always empty for this read-only IP type.
    CreatedAt string
    Creation date of the external network IP.
    CurrentState GetCloudExtNetIpCurrentState
    Current state of the external network IP:
    CurrentTasks List<GetCloudExtNetIpCurrentTask>
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    Id string
    Identifier of the current task.
    ResourceStatus string
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    UpdatedAt string
    Last update date of the external network IP.
    Checksum string
    Checksum field of the API envelope. Always empty for this read-only IP type.
    CreatedAt string
    Creation date of the external network IP.
    CurrentState GetCloudExtNetIpCurrentState
    Current state of the external network IP:
    CurrentTasks []GetCloudExtNetIpCurrentTask
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    Id string
    Identifier of the current task.
    ResourceStatus string
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    UpdatedAt string
    Last update date of the external network IP.
    checksum string
    Checksum field of the API envelope. Always empty for this read-only IP type.
    created_at string
    Creation date of the external network IP.
    current_state object
    Current state of the external network IP:
    current_tasks list(object)
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    id string
    Identifier of the current task.
    resource_status string
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    updated_at string
    Last update date of the external network IP.
    checksum String
    Checksum field of the API envelope. Always empty for this read-only IP type.
    createdAt String
    Creation date of the external network IP.
    currentState GetCloudExtNetIpCurrentState
    Current state of the external network IP:
    currentTasks List<GetCloudExtNetIpCurrentTask>
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    id String
    Identifier of the current task.
    resourceStatus String
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    updatedAt String
    Last update date of the external network IP.
    checksum string
    Checksum field of the API envelope. Always empty for this read-only IP type.
    createdAt string
    Creation date of the external network IP.
    currentState GetCloudExtNetIpCurrentState
    Current state of the external network IP:
    currentTasks GetCloudExtNetIpCurrentTask[]
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    id string
    Identifier of the current task.
    resourceStatus string
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    updatedAt string
    Last update date of the external network IP.
    checksum str
    Checksum field of the API envelope. Always empty for this read-only IP type.
    created_at str
    Creation date of the external network IP.
    current_state GetCloudExtNetIpCurrentState
    Current state of the external network IP:
    current_tasks Sequence[GetCloudExtNetIpCurrentTask]
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    id str
    Identifier of the current task.
    resource_status str
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    updated_at str
    Last update date of the external network IP.
    checksum String
    Checksum field of the API envelope. Always empty for this read-only IP type.
    createdAt String
    Creation date of the external network IP.
    currentState Property Map
    Current state of the external network IP:
    currentTasks List<Property Map>
    Ongoing asynchronous tasks related to the external network IP. Each element exports:
    id String
    Identifier of the current task.
    resourceStatus String
    External network IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    updatedAt String
    Last update date of the external network IP.

    Supporting Types

    GetCloudExtNetIpCurrentState

    AssociatedResource GetCloudExtNetIpCurrentStateAssociatedResource
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    Id string
    IP address of the external network IP.
    Ip string
    IP address of the external network IP.
    Location GetCloudExtNetIpCurrentStateLocation
    Location details:
    AssociatedResource GetCloudExtNetIpCurrentStateAssociatedResource
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    Id string
    IP address of the external network IP.
    Ip string
    IP address of the external network IP.
    Location GetCloudExtNetIpCurrentStateLocation
    Location details:
    associated_resource object
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    id string
    IP address of the external network IP.
    ip string
    IP address of the external network IP.
    location object
    Location details:
    associatedResource GetCloudExtNetIpCurrentStateAssociatedResource
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    id String
    IP address of the external network IP.
    ip String
    IP address of the external network IP.
    location GetCloudExtNetIpCurrentStateLocation
    Location details:
    associatedResource GetCloudExtNetIpCurrentStateAssociatedResource
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    id string
    IP address of the external network IP.
    ip string
    IP address of the external network IP.
    location GetCloudExtNetIpCurrentStateLocation
    Location details:
    associated_resource GetCloudExtNetIpCurrentStateAssociatedResource
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    id str
    IP address of the external network IP.
    ip str
    IP address of the external network IP.
    location GetCloudExtNetIpCurrentStateLocation
    Location details:
    associatedResource Property Map
    Resource the external network IP is currently attached to. Null when the IP is not attached to any resource:
    id String
    IP address of the external network IP.
    ip String
    IP address of the external network IP.
    location Property Map
    Location details:

    GetCloudExtNetIpCurrentStateAssociatedResource

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

    GetCloudExtNetIpCurrentStateLocation

    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.

    GetCloudExtNetIpCurrentTask

    Errors List<GetCloudExtNetIpCurrentTaskError>
    Errors that occurred on the task:
    Id string
    IP address of the external network 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 []GetCloudExtNetIpCurrentTaskError
    Errors that occurred on the task:
    Id string
    IP address of the external network 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 external network 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<GetCloudExtNetIpCurrentTaskError>
    Errors that occurred on the task:
    id String
    IP address of the external network 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 GetCloudExtNetIpCurrentTaskError[]
    Errors that occurred on the task:
    id string
    IP address of the external network 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[GetCloudExtNetIpCurrentTaskError]
    Errors that occurred on the task:
    id str
    IP address of the external network 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 external network IP.
    link String
    Link to the task details.
    status String
    Current global status of the current task.
    type String
    Type of the current task.

    GetCloudExtNetIpCurrentTaskError

    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.

    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