1. Packages
  2. OVH
  3. API Docs
  4. Vps
  5. getVps
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.Vps.getVps

ovh logo
Viewing docs for OVHCloud v2.12.0
published on Thursday, Mar 12, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Use this data source to retrieve information about a vps associated with your OVHcloud Account.

    Example Usage

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

const server = ovh.Vps.getVps({
    serviceName: "XXXXXX",
});

    import pulumi
import pulumi_ovh as ovh

server = ovh.Vps.get_vps(service_name="XXXXXX")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vps.GetVps(ctx, &vps.GetVpsArgs{
			ServiceName: "XXXXXX",
		}, 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 server = Ovh.Vps.GetVps.Invoke(new()
    {
        ServiceName = "XXXXXX",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.Vps.VpsFunctions;
import com.pulumi.ovh.Vps.inputs.GetVpsArgs;
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 server = VpsFunctions.getVps(GetVpsArgs.builder()
            .serviceName("XXXXXX")
            .build());

    }
}

    variables:
  server:
    fn::invoke:
      function: ovh:Vps:getVps
      arguments:
        serviceName: XXXXXX

    Using getVps

    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 getVps(args: GetVpsArgs, opts?: InvokeOptions): Promise<GetVpsResult>
function getVpsOutput(args: GetVpsOutputArgs, opts?: InvokeOptions): Output<GetVpsResult>
    def get_vps(service_name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVpsResult
def get_vps_output(service_name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVpsResult]
    func LookupVps(ctx *Context, args *LookupVpsArgs, opts ...InvokeOption) (*LookupVpsResult, error)
func LookupVpsOutput(ctx *Context, args *LookupVpsOutputArgs, opts ...InvokeOption) LookupVpsResultOutput

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

    public static class GetVps 
{
    public static Task<GetVpsResult> InvokeAsync(GetVpsArgs args, InvokeOptions? opts = null)
    public static Output<GetVpsResult> Invoke(GetVpsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVpsResult> getVps(GetVpsArgs args, InvokeOptions options)
public static Output<GetVpsResult> getVps(GetVpsArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:Vps/getVps:getVps
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ServiceName string
    The service_name of your dedicated server.
    ServiceName string
    The service_name of your dedicated server.
    serviceName String
    The service_name of your dedicated server.
    serviceName string
    The service_name of your dedicated server.
    service_name str
    The service_name of your dedicated server.
    serviceName String
    The service_name of your dedicated server.

    getVps Result

    The following output properties are available:

    Cluster string
    The OVHcloud cluster the vps is in
    Datacenter Dictionary<string, string>
    The datacenter in which the vps is located
    Displayname string
    The displayed name in the OVHcloud web admin
    Id string
    The provider-assigned unique ID for this managed resource.
    Ips List<string>
    The list of IPs addresses attached to the vps
    Keymap string
    The keymap for the ip kvm, valid values "", "fr", "us"
    Memory int
    The amount of memory in MB of the vps.
    Model Dictionary<string, string>
    A dict describing the type of vps.
    Name string
    Netbootmode string
    The source of the boot kernel
    Offertype string
    The type of offer (ssd, cloud, classic)
    ServiceName string
    Slamonitoring bool
    A boolean to indicate if OVHcloud SLA monitoring is active.
    State string
    The state of the vps
    Type string
    The type of server
    Vcore int
    The number of vcore of the vps
    VpsURN string
    The URN of the vps
    Zone string
    The OVHcloud zone where the vps is
    Cluster string
    The OVHcloud cluster the vps is in
    Datacenter map[string]string
    The datacenter in which the vps is located
    Displayname string
    The displayed name in the OVHcloud web admin
    Id string
    The provider-assigned unique ID for this managed resource.
    Ips []string
    The list of IPs addresses attached to the vps
    Keymap string
    The keymap for the ip kvm, valid values "", "fr", "us"
    Memory int
    The amount of memory in MB of the vps.
    Model map[string]string
    A dict describing the type of vps.
    Name string
    Netbootmode string
    The source of the boot kernel
    Offertype string
    The type of offer (ssd, cloud, classic)
    ServiceName string
    Slamonitoring bool
    A boolean to indicate if OVHcloud SLA monitoring is active.
    State string
    The state of the vps
    Type string
    The type of server
    Vcore int
    The number of vcore of the vps
    VpsURN string
    The URN of the vps
    Zone string
    The OVHcloud zone where the vps is
    VpsURN String
    The URN of the vps
    cluster String
    The OVHcloud cluster the vps is in
    datacenter Map<String,String>
    The datacenter in which the vps is located
    displayname String
    The displayed name in the OVHcloud web admin
    id String
    The provider-assigned unique ID for this managed resource.
    ips List<String>
    The list of IPs addresses attached to the vps
    keymap String
    The keymap for the ip kvm, valid values "", "fr", "us"
    memory Integer
    The amount of memory in MB of the vps.
    model Map<String,String>
    A dict describing the type of vps.
    name String
    netbootmode String
    The source of the boot kernel
    offertype String
    The type of offer (ssd, cloud, classic)
    serviceName String
    slamonitoring Boolean
    A boolean to indicate if OVHcloud SLA monitoring is active.
    state String
    The state of the vps
    type String
    The type of server
    vcore Integer
    The number of vcore of the vps
    zone String
    The OVHcloud zone where the vps is
    VpsURN string
    The URN of the vps
    cluster string
    The OVHcloud cluster the vps is in
    datacenter {[key: string]: string}
    The datacenter in which the vps is located
    displayname string
    The displayed name in the OVHcloud web admin
    id string
    The provider-assigned unique ID for this managed resource.
    ips string[]
    The list of IPs addresses attached to the vps
    keymap string
    The keymap for the ip kvm, valid values "", "fr", "us"
    memory number
    The amount of memory in MB of the vps.
    model {[key: string]: string}
    A dict describing the type of vps.
    name string
    netbootmode string
    The source of the boot kernel
    offertype string
    The type of offer (ssd, cloud, classic)
    serviceName string
    slamonitoring boolean
    A boolean to indicate if OVHcloud SLA monitoring is active.
    state string
    The state of the vps
    type string
    The type of server
    vcore number
    The number of vcore of the vps
    zone string
    The OVHcloud zone where the vps is
    cluster str
    The OVHcloud cluster the vps is in
    datacenter Mapping[str, str]
    The datacenter in which the vps is located
    displayname str
    The displayed name in the OVHcloud web admin
    id str
    The provider-assigned unique ID for this managed resource.
    ips Sequence[str]
    The list of IPs addresses attached to the vps
    keymap str
    The keymap for the ip kvm, valid values "", "fr", "us"
    memory int
    The amount of memory in MB of the vps.
    model Mapping[str, str]
    A dict describing the type of vps.
    name str
    netbootmode str
    The source of the boot kernel
    offertype str
    The type of offer (ssd, cloud, classic)
    service_name str
    slamonitoring bool
    A boolean to indicate if OVHcloud SLA monitoring is active.
    state str
    The state of the vps
    type str
    The type of server
    vcore int
    The number of vcore of the vps
    vps_urn str
    The URN of the vps
    zone str
    The OVHcloud zone where the vps is
    VpsURN String
    The URN of the vps
    cluster String
    The OVHcloud cluster the vps is in
    datacenter Map<String>
    The datacenter in which the vps is located
    displayname String
    The displayed name in the OVHcloud web admin
    id String
    The provider-assigned unique ID for this managed resource.
    ips List<String>
    The list of IPs addresses attached to the vps
    keymap String
    The keymap for the ip kvm, valid values "", "fr", "us"
    memory Number
    The amount of memory in MB of the vps.
    model Map<String>
    A dict describing the type of vps.
    name String
    netbootmode String
    The source of the boot kernel
    offertype String
    The type of offer (ssd, cloud, classic)
    serviceName String
    slamonitoring Boolean
    A boolean to indicate if OVHcloud SLA monitoring is active.
    state String
    The state of the vps
    type String
    The type of server
    vcore Number
    The number of vcore of the vps
    zone String
    The OVHcloud zone where the vps is

    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.12.0
    published on Thursday, Mar 12, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh
      Try Pulumi Cloud free. Your team will thank you.