Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
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 dictionarydata "ovh_get_cloud_ext_net_ip" "name" {
# arguments
}The following arguments are supported:
- 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_SERVICEenvironment 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_SERVICEenvironment 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_SERVICEenvironment 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_SERVICEenvironment 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_SERVICEenvironment 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_SERVICEenvironment 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_SERVICEenvironment 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.
- Created
At string - Creation date of the external network IP.
- Current
State GetCloud Ext Net Ip Current State - Current state of the external network IP:
- Current
Tasks List<GetCloud Ext Net Ip Current Task> - 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.
- Created
At string - Creation date of the external network IP.
- Current
State GetCloud Ext Net Ip Current State - Current state of the external network IP:
- Current
Tasks []GetCloud Ext Net Ip Current Task - 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.
- 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.
- created
At String - Creation date of the external network IP.
- current
State GetCloud Ext Net Ip Current State - Current state of the external network IP:
- current
Tasks List<GetCloud Ext Net Ip Current Task> - 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.
- created
At string - Creation date of the external network IP.
- current
State GetCloud Ext Net Ip Current State - Current state of the external network IP:
- current
Tasks GetCloud Ext Net Ip Current Task[] - 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 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 GetCloud Ext Net Ip Current State - Current state of the external network IP:
- current_
tasks Sequence[GetCloud Ext Net Ip Current Task] - 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.
- created
At String - Creation date of the external network IP.
- current
State Property Map - Current state of the external network IP:
- current
Tasks List<Property Map> - 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.
Supporting Types
GetCloudExtNetIpCurrentState
- Associated
Resource GetCloud Ext Net Ip Current State Associated Resource - 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
Get
Cloud Ext Net Ip Current State Location - Location details:
- Associated
Resource GetCloud Ext Net Ip Current State Associated Resource - 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
Get
Cloud Ext Net Ip Current State Location - Location details:
- associated
Resource GetCloud Ext Net Ip Current State Associated Resource - 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
Get
Cloud Ext Net Ip Current State Location - Location details:
- associated
Resource GetCloud Ext Net Ip Current State Associated Resource - 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
Get
Cloud Ext Net Ip Current State Location - Location details:
- associated_
resource GetCloud Ext Net Ip Current State Associated Resource - 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
Get
Cloud Ext Net Ip Current State Location - Location details:
- associated
Resource 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
GetCloudExtNetIpCurrentStateLocation
- Availability
Zone string - Availability zone.
- Region string
- Region.
- Availability
Zone string - Availability zone.
- Region string
- Region.
- availability_
zone string - Availability zone.
- region string
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
- availability
Zone string - Availability zone.
- region string
- Region.
- availability_
zone str - Availability zone.
- region str
- Region.
- availability
Zone String - Availability zone.
- region String
- Region.
GetCloudExtNetIpCurrentTask
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
ovhTerraform Provider.
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
published on Friday, Jul 17, 2026 by OVHcloud