getCloudAdditionalIp

OVHCloud v2.17.0, Jul 17 26

Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const ip = ovh.getCloudAdditionalIp({
    serviceName: "<public cloud project ID>",
    id: "<additional IP address>",
});
export const additionalIpStatus = ip.then(ip => ip.resourceStatus);

import pulumi
import pulumi_ovh as ovh

ip = ovh.get_cloud_additional_ip(service_name="<public cloud project ID>",
    id="<additional IP address>")
pulumi.export("additionalIpStatus", 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.GetCloudAdditionalIp(ctx, &ovh.GetCloudAdditionalIpArgs{
			ServiceName: pulumi.StringRef("<public cloud project ID>"),
			Id:          "<additional IP address>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("additionalIpStatus", ip.ResourceStatus)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var ip = Ovh.GetCloudAdditionalIp.Invoke(new()
    {
        ServiceName = "<public cloud project ID>",
        Id = "<additional IP address>",
    });

    return new Dictionary<string, object?>
    {
        ["additionalIpStatus"] = ip.Apply(getCloudAdditionalIpResult => getCloudAdditionalIpResult.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.GetCloudAdditionalIpArgs;
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.getCloudAdditionalIp(GetCloudAdditionalIpArgs.builder()
            .serviceName("<public cloud project ID>")
            .id("<additional IP address>")
            .build());

        ctx.export("additionalIpStatus", ip.resourceStatus());
    }
}

variables:
  ip:
    fn::invoke:
      function: ovh:getCloudAdditionalIp
      arguments:
        serviceName: <public cloud project ID>
        id: <additional IP address>
outputs:
  additionalIpStatus: ${ip.resourceStatus}

Example coming soon!

Using getCloudAdditionalIp

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 getCloudAdditionalIp(args: GetCloudAdditionalIpArgs, opts?: InvokeOptions): Promise<GetCloudAdditionalIpResult>
function getCloudAdditionalIpOutput(args: GetCloudAdditionalIpOutputArgs, opts?: InvokeOptions): Output<GetCloudAdditionalIpResult>

def get_cloud_additional_ip(id: Optional[str] = None,
                            service_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCloudAdditionalIpResult
def get_cloud_additional_ip_output(id: pulumi.Input[Optional[str]] = None,
                            service_name: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetCloudAdditionalIpResult]

func GetCloudAdditionalIp(ctx *Context, args *GetCloudAdditionalIpArgs, opts ...InvokeOption) (*GetCloudAdditionalIpResult, error)
func GetCloudAdditionalIpOutput(ctx *Context, args *GetCloudAdditionalIpOutputArgs, opts ...InvokeOption) GetCloudAdditionalIpResultOutput

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

public static class GetCloudAdditionalIp 
{
    public static Task<GetCloudAdditionalIpResult> InvokeAsync(GetCloudAdditionalIpArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudAdditionalIpResult> Invoke(GetCloudAdditionalIpInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudAdditionalIpResult> getCloudAdditionalIp(GetCloudAdditionalIpArgs args, InvokeOptions options)
public static Output<GetCloudAdditionalIpResult> getCloudAdditionalIp(GetCloudAdditionalIpArgs args, InvokeOptions options)

fn::invoke:
  function: ovh:index/getCloudAdditionalIp:getCloudAdditionalIp
  arguments:
    # arguments dictionary

data "ovh_get_cloud_additional_ip" "name" {
    # arguments
}

The following arguments are supported:

Id string: IP address of the additional 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 additional 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 additional 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 additional 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 additional 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 additional 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 additional 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.