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 list the additional IPs of a public cloud project. Additional IPs are created and deleted through the lifecycle of other products (typically instances they are attached to), 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 ips = ovh.getCloudAdditionalIps({
serviceName: "<public cloud project ID>",
});
export const additionalIpAddresses = ips.then(ips => .map(ip => (ip.id)));
import pulumi
import pulumi_ovh as ovh
ips = ovh.get_cloud_additional_ips(service_name="<public cloud project ID>")
pulumi.export("additionalIpAddresses", [ip.id for ip in ips.additional_ips])
Example coming soon!
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var ips = Ovh.GetCloudAdditionalIps.Invoke(new()
{
ServiceName = "<public cloud project ID>",
});
return new Dictionary<string, object?>
{
["additionalIpAddresses"] = .Select(ip =>
{
return ip.Id;
}).ToList(),
};
});
Example coming soon!
Example coming soon!
Example coming soon!
Using getCloudAdditionalIps
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 getCloudAdditionalIps(args: GetCloudAdditionalIpsArgs, opts?: InvokeOptions): Promise<GetCloudAdditionalIpsResult>
function getCloudAdditionalIpsOutput(args: GetCloudAdditionalIpsOutputArgs, opts?: InvokeOptions): Output<GetCloudAdditionalIpsResult>def get_cloud_additional_ips(service_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCloudAdditionalIpsResult
def get_cloud_additional_ips_output(service_name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCloudAdditionalIpsResult]func GetCloudAdditionalIps(ctx *Context, args *GetCloudAdditionalIpsArgs, opts ...InvokeOption) (*GetCloudAdditionalIpsResult, error)
func GetCloudAdditionalIpsOutput(ctx *Context, args *GetCloudAdditionalIpsOutputArgs, opts ...InvokeOption) GetCloudAdditionalIpsResultOutput> Note: This function is named GetCloudAdditionalIps in the Go SDK.
public static class GetCloudAdditionalIps
{
public static Task<GetCloudAdditionalIpsResult> InvokeAsync(GetCloudAdditionalIpsArgs args, InvokeOptions? opts = null)
public static Output<GetCloudAdditionalIpsResult> Invoke(GetCloudAdditionalIpsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCloudAdditionalIpsResult> getCloudAdditionalIps(GetCloudAdditionalIpsArgs args, InvokeOptions options)
public static Output<GetCloudAdditionalIpsResult> getCloudAdditionalIps(GetCloudAdditionalIpsArgs args, InvokeOptions options)
fn::invoke:
function: ovh:index/getCloudAdditionalIps:getCloudAdditionalIps
arguments:
# arguments dictionarydata "ovh_get_cloud_additional_ips" "name" {
# arguments
}The following arguments are supported:
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
getCloudAdditionalIps Result
The following output properties are available:
- Additional
Ips List<GetCloud Additional Ips Additional Ip> - List of additional IPs. Each element exports:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Name string
- Additional
Ips []GetCloud Additional Ips Additional Ip - List of additional IPs. Each element exports:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Name string
- additional_
ips list(object) - List of additional IPs. Each element exports:
- id string
- The provider-assigned unique ID for this managed resource.
- service_
name string
- additional
Ips List<GetCloud Additional Ips Additional Ip> - List of additional IPs. Each element exports:
- id String
- The provider-assigned unique ID for this managed resource.
- service
Name String
- additional
Ips GetCloud Additional Ips Additional Ip[] - List of additional IPs. Each element exports:
- id string
- The provider-assigned unique ID for this managed resource.
- service
Name string
- additional_
ips Sequence[GetCloud Additional Ips Additional Ip] - List of additional IPs. Each element exports:
- id str
- The provider-assigned unique ID for this managed resource.
- service_
name str
- additional
Ips List<Property Map> - List of additional IPs. Each element exports:
- id String
- The provider-assigned unique ID for this managed resource.
- service
Name String
Supporting Types
GetCloudAdditionalIpsAdditionalIp
- Checksum string
- Checksum field of the API envelope. Always empty for this read-only IP type.
- Current
State GetCloud Additional Ips Additional Ip Current State - Current state of the additional IP:
- Current
Tasks List<GetCloud Additional Ips Additional Ip Current Task> - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- Id string
- Identifier of the current task.
- Resource
Status string - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- Checksum string
- Checksum field of the API envelope. Always empty for this read-only IP type.
- Current
State GetCloud Additional Ips Additional Ip Current State - Current state of the additional IP:
- Current
Tasks []GetCloud Additional Ips Additional Ip Current Task - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- Id string
- Identifier of the current task.
- Resource
Status string - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- checksum string
- Checksum field of the API envelope. Always empty for this read-only IP type.
- current_
state object - Current state of the additional IP:
- current_
tasks list(object) - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- id string
- Identifier of the current task.
- resource_
status string - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- checksum String
- Checksum field of the API envelope. Always empty for this read-only IP type.
- current
State GetCloud Additional Ips Additional Ip Current State - Current state of the additional IP:
- current
Tasks List<GetCloud Additional Ips Additional Ip Current Task> - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- id String
- Identifier of the current task.
- resource
Status String - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- checksum string
- Checksum field of the API envelope. Always empty for this read-only IP type.
- current
State GetCloud Additional Ips Additional Ip Current State - Current state of the additional IP:
- current
Tasks GetCloud Additional Ips Additional Ip Current Task[] - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- id string
- Identifier of the current task.
- resource
Status string - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- checksum str
- Checksum field of the API envelope. Always empty for this read-only IP type.
- current_
state GetCloud Additional Ips Additional Ip Current State - Current state of the additional IP:
- current_
tasks Sequence[GetCloud Additional Ips Additional Ip Current Task] - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- id str
- Identifier of the current task.
- resource_
status str - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
- checksum String
- Checksum field of the API envelope. Always empty for this read-only IP type.
- current
State Property Map - Current state of the additional IP:
- current
Tasks List<Property Map> - Ongoing asynchronous tasks related to the additional IP. Each element exports:
- id String
- Identifier of the current task.
- resource
Status String - Additional IP readiness in the system (
CREATING,DELETING,ERROR,OUT_OF_SYNC,READY,UNKNOWN,UPDATING).
GetCloudAdditionalIpsAdditionalIpCurrentState
- Associated
Resource GetCloud Additional Ips Additional Ip Current State Associated Resource - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- Id string
- Identifier of the current task.
- Ip string
- IP address of the additional IP.
- Ip
Block string - IP block the additional IP belongs to. May be null.
- Location
Get
Cloud Additional Ips Additional Ip Current State Location - Location details:
- Associated
Resource GetCloud Additional Ips Additional Ip Current State Associated Resource - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- Id string
- Identifier of the current task.
- Ip string
- IP address of the additional IP.
- Ip
Block string - IP block the additional IP belongs to. May be null.
- Location
Get
Cloud Additional Ips Additional Ip Current State Location - Location details:
- associated_
resource object - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- id string
- Identifier of the current task.
- ip string
- IP address of the additional IP.
- ip_
block string - IP block the additional IP belongs to. May be null.
- location object
- Location details:
- associated
Resource GetCloud Additional Ips Additional Ip Current State Associated Resource - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- id String
- Identifier of the current task.
- ip String
- IP address of the additional IP.
- ip
Block String - IP block the additional IP belongs to. May be null.
- location
Get
Cloud Additional Ips Additional Ip Current State Location - Location details:
- associated
Resource GetCloud Additional Ips Additional Ip Current State Associated Resource - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- id string
- Identifier of the current task.
- ip string
- IP address of the additional IP.
- ip
Block string - IP block the additional IP belongs to. May be null.
- location
Get
Cloud Additional Ips Additional Ip Current State Location - Location details:
- associated_
resource GetCloud Additional Ips Additional Ip Current State Associated Resource - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- id str
- Identifier of the current task.
- ip str
- IP address of the additional IP.
- ip_
block str - IP block the additional IP belongs to. May be null.
- location
Get
Cloud Additional Ips Additional Ip Current State Location - Location details:
- associated
Resource Property Map - Resource the additional IP is currently attached to. Null when the IP is not attached to any resource:
- id String
- Identifier of the current task.
- ip String
- IP address of the additional IP.
- ip
Block String - IP block the additional IP belongs to. May be null.
- location Property Map
- Location details:
GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
- 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.
GetCloudAdditionalIpsAdditionalIpCurrentTask
GetCloudAdditionalIpsAdditionalIpCurrentTaskError
- 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