1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudAdditionalIps
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 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 dictionary
    data "ovh_get_cloud_additional_ips" "name" {
        # arguments
    }

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.
    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.

    getCloudAdditionalIps Result

    The following output properties are available:

    AdditionalIps List<GetCloudAdditionalIpsAdditionalIp>
    List of additional IPs. Each element exports:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    AdditionalIps []GetCloudAdditionalIpsAdditionalIp
    List of additional IPs. Each element exports:
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName 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
    additionalIps List<GetCloudAdditionalIpsAdditionalIp>
    List of additional IPs. Each element exports:
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    additionalIps GetCloudAdditionalIpsAdditionalIp[]
    List of additional IPs. Each element exports:
    id string
    The provider-assigned unique ID for this managed resource.
    serviceName string
    additional_ips Sequence[GetCloudAdditionalIpsAdditionalIp]
    List of additional IPs. Each element exports:
    id str
    The provider-assigned unique ID for this managed resource.
    service_name str
    additionalIps List<Property Map>
    List of additional IPs. Each element exports:
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String

    Supporting Types

    GetCloudAdditionalIpsAdditionalIp

    Checksum string
    Checksum field of the API envelope. Always empty for this read-only IP type.
    CurrentState GetCloudAdditionalIpsAdditionalIpCurrentState
    Current state of the additional IP:
    CurrentTasks List<GetCloudAdditionalIpsAdditionalIpCurrentTask>
    Ongoing asynchronous tasks related to the additional IP. Each element exports:
    Id string
    Identifier of the current task.
    ResourceStatus 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.
    CurrentState GetCloudAdditionalIpsAdditionalIpCurrentState
    Current state of the additional IP:
    CurrentTasks []GetCloudAdditionalIpsAdditionalIpCurrentTask
    Ongoing asynchronous tasks related to the additional IP. Each element exports:
    Id string
    Identifier of the current task.
    ResourceStatus 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.
    currentState GetCloudAdditionalIpsAdditionalIpCurrentState
    Current state of the additional IP:
    currentTasks List<GetCloudAdditionalIpsAdditionalIpCurrentTask>
    Ongoing asynchronous tasks related to the additional IP. Each element exports:
    id String
    Identifier of the current task.
    resourceStatus 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.
    currentState GetCloudAdditionalIpsAdditionalIpCurrentState
    Current state of the additional IP:
    currentTasks GetCloudAdditionalIpsAdditionalIpCurrentTask[]
    Ongoing asynchronous tasks related to the additional IP. Each element exports:
    id string
    Identifier of the current task.
    resourceStatus 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 GetCloudAdditionalIpsAdditionalIpCurrentState
    Current state of the additional IP:
    current_tasks Sequence[GetCloudAdditionalIpsAdditionalIpCurrentTask]
    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.
    currentState Property Map
    Current state of the additional IP:
    currentTasks List<Property Map>
    Ongoing asynchronous tasks related to the additional IP. Each element exports:
    id String
    Identifier of the current task.
    resourceStatus String
    Additional IP readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UNKNOWN, UPDATING).

    GetCloudAdditionalIpsAdditionalIpCurrentState

    AssociatedResource GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
    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.
    IpBlock string
    IP block the additional IP belongs to. May be null.
    Location GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
    Location details:
    AssociatedResource GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
    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.
    IpBlock string
    IP block the additional IP belongs to. May be null.
    Location GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
    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:
    associatedResource GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
    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.
    ipBlock String
    IP block the additional IP belongs to. May be null.
    location GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
    Location details:
    associatedResource GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
    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.
    ipBlock string
    IP block the additional IP belongs to. May be null.
    location GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
    Location details:
    associated_resource GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource
    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 GetCloudAdditionalIpsAdditionalIpCurrentStateLocation
    Location details:
    associatedResource 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.
    ipBlock String
    IP block the additional IP belongs to. May be null.
    location Property Map
    Location details:

    GetCloudAdditionalIpsAdditionalIpCurrentStateAssociatedResource

    Id string
    Identifier of the current task.
    Type string
    Type of the current task.
    Id string
    Identifier of the current task.
    Type string
    Type of the current task.
    id string
    Identifier of the current task.
    type string
    Type of the current task.
    id String
    Identifier of the current task.
    type String
    Type of the current task.
    id string
    Identifier of the current task.
    type string
    Type of the current task.
    id str
    Identifier of the current task.
    type str
    Type of the current task.
    id String
    Identifier of the current task.
    type String
    Type of the current task.

    GetCloudAdditionalIpsAdditionalIpCurrentStateLocation

    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.

    GetCloudAdditionalIpsAdditionalIpCurrentTask

    Errors List<GetCloudAdditionalIpsAdditionalIpCurrentTaskError>
    Errors that occurred on the task:
    Id string
    Identifier of the current task.
    Link string
    Link to the task details.
    Status string
    Current global status of the current task.
    Type string
    Type of the current task.
    Errors []GetCloudAdditionalIpsAdditionalIpCurrentTaskError
    Errors that occurred on the task:
    Id string
    Identifier of the current task.
    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
    Identifier of the current task.
    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<GetCloudAdditionalIpsAdditionalIpCurrentTaskError>
    Errors that occurred on the task:
    id String
    Identifier of the current task.
    link String
    Link to the task details.
    status String
    Current global status of the current task.
    type String
    Type of the current task.
    errors GetCloudAdditionalIpsAdditionalIpCurrentTaskError[]
    Errors that occurred on the task:
    id string
    Identifier of the current task.
    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[GetCloudAdditionalIpsAdditionalIpCurrentTaskError]
    Errors that occurred on the task:
    id str
    Identifier of the current task.
    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
    Identifier of the current task.
    link String
    Link to the task details.
    status String
    Current global status of the current task.
    type String
    Type of the current task.

    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 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