ovh.CloudProject.getRancher

OVHCloud v2.12.0, Mar 12 26

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

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

const rancher = ovh.CloudProject.getRancher({
    projectId: "<public cloud project ID>",
    id: "<Rancher service ID>",
});

import pulumi
import pulumi_ovh as ovh

rancher = ovh.CloudProject.get_rancher(project_id="<public cloud project ID>",
    id="<Rancher service ID>")

package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.GetRancher(ctx, &cloudproject.GetRancherArgs{
			ProjectId: "<public cloud project ID>",
			Id:        "<Rancher service ID>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var rancher = Ovh.CloudProject.GetRancher.Invoke(new()
    {
        ProjectId = "<public cloud project ID>",
        Id = "<Rancher service ID>",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetRancherArgs;
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 rancher = CloudProjectFunctions.getRancher(GetRancherArgs.builder()
            .projectId("<public cloud project ID>")
            .id("<Rancher service ID>")
            .build());

    }
}

variables:
  rancher:
    fn::invoke:
      function: ovh:CloudProject:getRancher
      arguments:
        projectId: <public cloud project ID>
        id: <Rancher service ID>

Using getRancher

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 getRancher(args: GetRancherArgs, opts?: InvokeOptions): Promise<GetRancherResult>
function getRancherOutput(args: GetRancherOutputArgs, opts?: InvokeOptions): Output<GetRancherResult>

def get_rancher(id: Optional[str] = None,
                project_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRancherResult
def get_rancher_output(id: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRancherResult]

func LookupRancher(ctx *Context, args *LookupRancherArgs, opts ...InvokeOption) (*LookupRancherResult, error)
func LookupRancherOutput(ctx *Context, args *LookupRancherOutputArgs, opts ...InvokeOption) LookupRancherResultOutput

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

public static class GetRancher 
{
    public static Task<GetRancherResult> InvokeAsync(GetRancherArgs args, InvokeOptions? opts = null)
    public static Output<GetRancherResult> Invoke(GetRancherInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRancherResult> getRancher(GetRancherArgs args, InvokeOptions options)
public static Output<GetRancherResult> getRancher(GetRancherArgs args, InvokeOptions options)

fn::invoke:
  function: ovh:CloudProject/getRancher:getRancher
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Unique identifier
ProjectId string: Project ID

Id string: Unique identifier
ProjectId string: Project ID

id String: Unique identifier
projectId String: Project ID

id string: Unique identifier
projectId string: Project ID

id str: Unique identifier
project_id str: Project ID

id String: Unique identifier
projectId String: Project ID

getRancher Result

The following output properties are available:

CreatedAt string: Date of the managed Rancher service creation
CurrentState GetRancherCurrentState: Current configuration applied to the managed Rancher service
CurrentTasks List<GetRancherCurrentTask>: Asynchronous operations ongoing on the managed Rancher service
Id string: Unique identifier
ProjectId string: Project ID
ResourceStatus string: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
TargetSpec GetRancherTargetSpec: Last target specification of the managed Rancher service
UpdatedAt string: Date of the last managed Rancher service update

CreatedAt string: Date of the managed Rancher service creation
CurrentState GetRancherCurrentState: Current configuration applied to the managed Rancher service
CurrentTasks []GetRancherCurrentTask: Asynchronous operations ongoing on the managed Rancher service
Id string: Unique identifier
ProjectId string: Project ID
ResourceStatus string: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
TargetSpec GetRancherTargetSpec: Last target specification of the managed Rancher service
UpdatedAt string: Date of the last managed Rancher service update

createdAt String: Date of the managed Rancher service creation
currentState GetRancherCurrentState: Current configuration applied to the managed Rancher service
currentTasks List<GetRancherCurrentTask>: Asynchronous operations ongoing on the managed Rancher service
id String: Unique identifier
projectId String: Project ID
resourceStatus String: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
targetSpec GetRancherTargetSpec: Last target specification of the managed Rancher service
updatedAt String: Date of the last managed Rancher service update

createdAt string: Date of the managed Rancher service creation
currentState GetRancherCurrentState: Current configuration applied to the managed Rancher service
currentTasks GetRancherCurrentTask[]: Asynchronous operations ongoing on the managed Rancher service
id string: Unique identifier
projectId string: Project ID
resourceStatus string: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
targetSpec GetRancherTargetSpec: Last target specification of the managed Rancher service
updatedAt string: Date of the last managed Rancher service update

created_at str: Date of the managed Rancher service creation
current_state GetRancherCurrentState: Current configuration applied to the managed Rancher service
current_tasks Sequence[GetRancherCurrentTask]: Asynchronous operations ongoing on the managed Rancher service
id str: Unique identifier
project_id str: Project ID
resource_status str: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
target_spec GetRancherTargetSpec: Last target specification of the managed Rancher service
updated_at str: Date of the last managed Rancher service update

createdAt String: Date of the managed Rancher service creation
currentState Property Map: Current configuration applied to the managed Rancher service
currentTasks List<Property Map>: Asynchronous operations ongoing on the managed Rancher service
id String: Unique identifier
projectId String: Project ID
resourceStatus String: Reflects the readiness of the managed Rancher service. A new target specification request will be accepted only in READY status
targetSpec Property Map: Last target specification of the managed Rancher service
updatedAt String: Date of the last managed Rancher service update

Supporting Types

GetRancherCurrentState

BootstrapPassword string: Bootstrap password of the managed Rancher service, returned only on creation
IamAuthEnabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
IpRestrictions List<GetRancherCurrentStateIpRestriction>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
Name string: Name of the managed Rancher service
Networking GetRancherCurrentStateNetworking: Networking properties of a managed Rancher service
Plan string: Plan of the managed Rancher service
Region string: Region of the managed Rancher service
Url string: URL of the managed Rancher service
Usage GetRancherCurrentStateUsage: Latest metrics regarding the usage of the managed Rancher service
Version string: Version of the managed Rancher service

BootstrapPassword string: Bootstrap password of the managed Rancher service, returned only on creation
IamAuthEnabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
IpRestrictions []GetRancherCurrentStateIpRestriction: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
Name string: Name of the managed Rancher service
Networking GetRancherCurrentStateNetworking: Networking properties of a managed Rancher service
Plan string: Plan of the managed Rancher service
Region string: Region of the managed Rancher service
Url string: URL of the managed Rancher service
Usage GetRancherCurrentStateUsage: Latest metrics regarding the usage of the managed Rancher service
Version string: Version of the managed Rancher service

bootstrapPassword String: Bootstrap password of the managed Rancher service, returned only on creation
iamAuthEnabled Boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions List<GetRancherCurrentStateIpRestriction>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name String: Name of the managed Rancher service
networking GetRancherCurrentStateNetworking: Networking properties of a managed Rancher service
plan String: Plan of the managed Rancher service
region String: Region of the managed Rancher service
url String: URL of the managed Rancher service
usage GetRancherCurrentStateUsage: Latest metrics regarding the usage of the managed Rancher service
version String: Version of the managed Rancher service

bootstrapPassword string: Bootstrap password of the managed Rancher service, returned only on creation
iamAuthEnabled boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions GetRancherCurrentStateIpRestriction[]: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name string: Name of the managed Rancher service
networking GetRancherCurrentStateNetworking: Networking properties of a managed Rancher service
plan string: Plan of the managed Rancher service
region string: Region of the managed Rancher service
url string: URL of the managed Rancher service
usage GetRancherCurrentStateUsage: Latest metrics regarding the usage of the managed Rancher service
version string: Version of the managed Rancher service

bootstrap_password str: Bootstrap password of the managed Rancher service, returned only on creation
iam_auth_enabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ip_restrictions Sequence[GetRancherCurrentStateIpRestriction]: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name str: Name of the managed Rancher service
networking GetRancherCurrentStateNetworking: Networking properties of a managed Rancher service
plan str: Plan of the managed Rancher service
region str: Region of the managed Rancher service
url str: URL of the managed Rancher service
usage GetRancherCurrentStateUsage: Latest metrics regarding the usage of the managed Rancher service
version str: Version of the managed Rancher service

bootstrapPassword String: Bootstrap password of the managed Rancher service, returned only on creation
iamAuthEnabled Boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions List<Property Map>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name String: Name of the managed Rancher service
networking Property Map: Networking properties of a managed Rancher service
plan String: Plan of the managed Rancher service
region String: Region of the managed Rancher service
url String: URL of the managed Rancher service
usage Property Map: Latest metrics regarding the usage of the managed Rancher service
version String: Version of the managed Rancher service

GetRancherCurrentStateIpRestriction

CidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
Description string: Description of the allowed CIDR block

CidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
Description string: Description of the allowed CIDR block

cidrBlock String: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description String: Description of the allowed CIDR block

cidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description string: Description of the allowed CIDR block

cidr_block str: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description str: Description of the allowed CIDR block

cidrBlock String: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description String: Description of the allowed CIDR block

GetRancherCurrentStateNetworking

EgressCidrBlocks List<string>: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

EgressCidrBlocks []string: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

egressCidrBlocks List<String>: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

egressCidrBlocks string[]: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

egress_cidr_blocks Sequence[str]: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

egressCidrBlocks List<String>: Specifies the CIDR ranges for egress IP addresses used by Rancher. Ensure these ranges are allowed in any IP restrictions for services that Rancher will access.

GetRancherCurrentStateUsage

Datetime string: Date of the sample
OrchestratedVcpus double: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

Datetime string: Date of the sample
OrchestratedVcpus float64: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

datetime String: Date of the sample
orchestratedVcpus Double: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

datetime string: Date of the sample
orchestratedVcpus number: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

datetime str: Date of the sample
orchestrated_vcpus float: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

datetime String: Date of the sample
orchestratedVcpus Number: Total number of vCPUs orchestrated by the managed Rancher service through the downstream clusters

GetRancherCurrentTask

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

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

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

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

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

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

GetRancherTargetSpec

IamAuthEnabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
IpRestrictions List<GetRancherTargetSpecIpRestriction>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
Name string: Name of the managed Rancher service
Plan string: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
Version string: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

IamAuthEnabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
IpRestrictions []GetRancherTargetSpecIpRestriction: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
Name string: Name of the managed Rancher service
Plan string: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
Version string: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

iamAuthEnabled Boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions List<GetRancherTargetSpecIpRestriction>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name String: Name of the managed Rancher service
plan String: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
version String: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

iamAuthEnabled boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions GetRancherTargetSpecIpRestriction[]: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name string: Name of the managed Rancher service
plan string: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
version string: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

iam_auth_enabled bool: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ip_restrictions Sequence[GetRancherTargetSpecIpRestriction]: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name str: Name of the managed Rancher service
plan str: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
version str: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

iamAuthEnabled Boolean: Allows Rancher to use identities managed by OVHcloud IAM (Identity and Access Management) to control access
ipRestrictions List<Property Map>: List of allowed CIDR blocks for a managed Rancher service's IP restrictions. When empty, any IP is allowed
name String: Name of the managed Rancher service
plan String: Plan of the managed Rancher service. Available plans for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/plan
version String: Version of the managed Rancher service. Available versions for an existing managed Rancher can be retrieved using GET /rancher/rancherID/capabilities/version

GetRancherTargetSpecIpRestriction

CidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
Description string: Description of the allowed CIDR block

CidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
Description string: Description of the allowed CIDR block

cidrBlock String: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description String: Description of the allowed CIDR block

cidrBlock string: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description string: Description of the allowed CIDR block

cidr_block str: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description str: Description of the allowed CIDR block

cidrBlock String: Allowed CIDR block (/subnet is optional, if unspecified then /32 will be used)
description String: Description of the allowed CIDR block

Package Details

Repository: ovh ovh/pulumi-ovh
License: Apache-2.0
Notes: This Pulumi package is based on the ovh Terraform Provider.

Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

ovh.CloudProject.getRancher

On this page

On this page

Example Usage

Using getRancher

getRancher Result

Supporting Types

GetRancherCurrentState

GetRancherCurrentStateIpRestriction

GetRancherCurrentStateNetworking

GetRancherCurrentStateUsage

GetRancherCurrentTask

GetRancherTargetSpec

GetRancherTargetSpecIpRestriction

Package Details

On this page

On this page