1. Registry
  2. Packages
  3. Vsphere Provider
  4. API Docs
  5. getSupervisor
Viewing docs for vSphere v4.19.0
published on Tuesday, Nov 10, 2026 by Pulumi
vsphere logo vsphere logo
Viewing docs for vSphere v4.19.0
published on Tuesday, Nov 10, 2026 by Pulumi

    This data source can be used to read the properties of a vSphere Supervisor.

    Example Usage

    S

    Look up a Supervisor by Name

    import * as pulumi from "@pulumi/pulumi";
    import * as vsphere from "@pulumi/vsphere";
    
    const example = vsphere.getSupervisor({
        name: "example-supervisor",
    });
    
    import pulumi
    import pulumi_vsphere as vsphere
    
    example = vsphere.get_supervisor(name="example-supervisor")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vsphere.GetSupervisor(ctx, &vsphere.LookupSupervisorArgs{
    			Name: pulumi.StringRef("example-supervisor"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using VSphere = Pulumi.VSphere;
    
    return await Deployment.RunAsync(() => 
    {
        var example = VSphere.GetSupervisor.Invoke(new()
        {
            Name = "example-supervisor",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vsphere.VsphereFunctions;
    import com.pulumi.vsphere.inputs.GetSupervisorArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = VsphereFunctions.getSupervisor(GetSupervisorArgs.builder()
                .name("example-supervisor")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: vsphere:getSupervisor
          arguments:
            name: example-supervisor
    
    terraform {
      required_providers {
        vsphere = {
          source = "pulumi/vsphere"
        }
      }
    }
    
    data "vsphere_supervisor" "example" {
      name = "example-supervisor"
    }
    

    Look up a Supervisor by Compute Cluster

    import * as pulumi from "@pulumi/pulumi";
    import * as vsphere from "@pulumi/vsphere";
    
    const example = vsphere.getSupervisor({
        cluster: cluster.id,
    });
    
    import pulumi
    import pulumi_vsphere as vsphere
    
    example = vsphere.get_supervisor(cluster=cluster["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vsphere.GetSupervisor(ctx, &vsphere.LookupSupervisorArgs{
    			Cluster: pulumi.StringRef(cluster.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using VSphere = Pulumi.VSphere;
    
    return await Deployment.RunAsync(() => 
    {
        var example = VSphere.GetSupervisor.Invoke(new()
        {
            Cluster = cluster.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vsphere.VsphereFunctions;
    import com.pulumi.vsphere.inputs.GetSupervisorArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = VsphereFunctions.getSupervisor(GetSupervisorArgs.builder()
                .cluster(cluster.get("id"))
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: vsphere:getSupervisor
          arguments:
            cluster: ${cluster.id}
    
    terraform {
      required_providers {
        vsphere = {
          source = "pulumi/vsphere"
        }
      }
    }
    
    data "vsphere_supervisor" "example" {
      cluster = cluster.id
    }
    

    Look up a Supervisor by ID

    import * as pulumi from "@pulumi/pulumi";
    import * as vsphere from "@pulumi/vsphere";
    
    const example = vsphere.getSupervisor({
        id: "435a6f10-ffd2-44f4-a2a8-65b4059b0b5f",
    });
    
    import pulumi
    import pulumi_vsphere as vsphere
    
    example = vsphere.get_supervisor(id="435a6f10-ffd2-44f4-a2a8-65b4059b0b5f")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vsphere.GetSupervisor(ctx, &vsphere.LookupSupervisorArgs{
    			Id: pulumi.StringRef("435a6f10-ffd2-44f4-a2a8-65b4059b0b5f"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using VSphere = Pulumi.VSphere;
    
    return await Deployment.RunAsync(() => 
    {
        var example = VSphere.GetSupervisor.Invoke(new()
        {
            Id = "435a6f10-ffd2-44f4-a2a8-65b4059b0b5f",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vsphere.VsphereFunctions;
    import com.pulumi.vsphere.inputs.GetSupervisorArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 example = VsphereFunctions.getSupervisor(GetSupervisorArgs.builder()
                .id("435a6f10-ffd2-44f4-a2a8-65b4059b0b5f")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: vsphere:getSupervisor
          arguments:
            id: 435a6f10-ffd2-44f4-a2a8-65b4059b0b5f
    
    terraform {
      required_providers {
        vsphere = {
          source = "pulumi/vsphere"
        }
      }
    }
    
    data "vsphere_supervisor" "example" {
      id = "435a6f10-ffd2-44f4-a2a8-65b4059b0b5f"
    }
    

    Using getSupervisor

    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 getSupervisor(args: GetSupervisorArgs, opts?: InvokeOptions): Promise<GetSupervisorResult>
    function getSupervisorOutput(args: GetSupervisorOutputArgs, opts?: InvokeOutputOptions): Output<GetSupervisorResult>
    def get_supervisor(cluster: Optional[str] = None,
                       id: Optional[str] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetSupervisorResult
    def get_supervisor_output(cluster: pulumi.Input[Optional[str]] = None,
                       id: pulumi.Input[Optional[str]] = None,
                       name: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetSupervisorResult]
    func LookupSupervisor(ctx *Context, args *LookupSupervisorArgs, opts ...InvokeOption) (*LookupSupervisorResult, error)
    func LookupSupervisorOutput(ctx *Context, args *LookupSupervisorOutputArgs, opts ...InvokeOption) LookupSupervisorResultOutput

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

    public static class GetSupervisor 
    {
        public static Task<GetSupervisorResult> InvokeAsync(GetSupervisorArgs args, InvokeOptions? opts = null)
        public static Output<GetSupervisorResult> Invoke(GetSupervisorInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSupervisorResult> Invoke(GetSupervisorInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSupervisorResult> getSupervisor(GetSupervisorArgs args, InvokeOptions options)
    public static Output<GetSupervisorResult> getSupervisor(GetSupervisorArgs args, InvokeOptions options)
    public static Output<GetSupervisorResult> getSupervisor(GetSupervisorArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: vsphere:index/getSupervisor:getSupervisor
      arguments:
        # arguments dictionary
    data "vsphere_get_supervisor" "name" {
        # arguments
    }

    The following arguments are supported:

    Cluster string
    The ID of a compute cluster managed by the Supervisor.
    Id string
    The ID of the Supervisor.
    Name string
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    Cluster string
    The ID of a compute cluster managed by the Supervisor.
    Id string
    The ID of the Supervisor.
    Name string
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    cluster string
    The ID of a compute cluster managed by the Supervisor.
    id string
    The ID of the Supervisor.
    name string
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    cluster String
    The ID of a compute cluster managed by the Supervisor.
    id String
    The ID of the Supervisor.
    name String
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    cluster string
    The ID of a compute cluster managed by the Supervisor.
    id string
    The ID of the Supervisor.
    name string
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    cluster str
    The ID of a compute cluster managed by the Supervisor.
    id str
    The ID of the Supervisor.
    name str
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.
    cluster String
    The ID of a compute cluster managed by the Supervisor.
    id String
    The ID of the Supervisor.
    name String
    The name of the Supervisor. The lookup fails if more than one Supervisor has this name.

    getSupervisor Result

    The following output properties are available:

    ConfigStatus string
    The configuration status of the Supervisor.
    CpuUsage int
    The CPU usage of the Supervisor in megahertz.
    Id string
    The ID of the Supervisor.
    KubernetesStatus string
    The Kubernetes status of the Supervisor.
    MemoryUsage int
    The memory usage of the Supervisor in mebibytes.
    Name string
    The name of the Supervisor.
    StorageUsage int
    The storage usage of the Supervisor in mebibytes.
    WorkloadNetworks List<Pulumi.VSphere.Outputs.GetSupervisorWorkloadNetwork>
    A workload network of the Supervisor.
    Zones List<Pulumi.VSphere.Outputs.GetSupervisorZone>
    The vSphere Zones of the Supervisor.
    Cluster string
    ConfigStatus string
    The configuration status of the Supervisor.
    CpuUsage int
    The CPU usage of the Supervisor in megahertz.
    Id string
    The ID of the Supervisor.
    KubernetesStatus string
    The Kubernetes status of the Supervisor.
    MemoryUsage int
    The memory usage of the Supervisor in mebibytes.
    Name string
    The name of the Supervisor.
    StorageUsage int
    The storage usage of the Supervisor in mebibytes.
    WorkloadNetworks []GetSupervisorWorkloadNetwork
    A workload network of the Supervisor.
    Zones []GetSupervisorZone
    The vSphere Zones of the Supervisor.
    Cluster string
    config_status string
    The configuration status of the Supervisor.
    cpu_usage number
    The CPU usage of the Supervisor in megahertz.
    id string
    The ID of the Supervisor.
    kubernetes_status string
    The Kubernetes status of the Supervisor.
    memory_usage number
    The memory usage of the Supervisor in mebibytes.
    name string
    The name of the Supervisor.
    storage_usage number
    The storage usage of the Supervisor in mebibytes.
    workload_networks list(object)
    A workload network of the Supervisor.
    zones list(object)
    The vSphere Zones of the Supervisor.
    cluster string
    configStatus String
    The configuration status of the Supervisor.
    cpuUsage Integer
    The CPU usage of the Supervisor in megahertz.
    id String
    The ID of the Supervisor.
    kubernetesStatus String
    The Kubernetes status of the Supervisor.
    memoryUsage Integer
    The memory usage of the Supervisor in mebibytes.
    name String
    The name of the Supervisor.
    storageUsage Integer
    The storage usage of the Supervisor in mebibytes.
    workloadNetworks List<GetSupervisorWorkloadNetwork>
    A workload network of the Supervisor.
    zones List<GetSupervisorZone>
    The vSphere Zones of the Supervisor.
    cluster String
    configStatus string
    The configuration status of the Supervisor.
    cpuUsage number
    The CPU usage of the Supervisor in megahertz.
    id string
    The ID of the Supervisor.
    kubernetesStatus string
    The Kubernetes status of the Supervisor.
    memoryUsage number
    The memory usage of the Supervisor in mebibytes.
    name string
    The name of the Supervisor.
    storageUsage number
    The storage usage of the Supervisor in mebibytes.
    workloadNetworks GetSupervisorWorkloadNetwork[]
    A workload network of the Supervisor.
    zones GetSupervisorZone[]
    The vSphere Zones of the Supervisor.
    cluster string
    config_status str
    The configuration status of the Supervisor.
    cpu_usage int
    The CPU usage of the Supervisor in megahertz.
    id str
    The ID of the Supervisor.
    kubernetes_status str
    The Kubernetes status of the Supervisor.
    memory_usage int
    The memory usage of the Supervisor in mebibytes.
    name str
    The name of the Supervisor.
    storage_usage int
    The storage usage of the Supervisor in mebibytes.
    workload_networks Sequence[GetSupervisorWorkloadNetwork]
    A workload network of the Supervisor.
    zones Sequence[GetSupervisorZone]
    The vSphere Zones of the Supervisor.
    cluster str
    configStatus String
    The configuration status of the Supervisor.
    cpuUsage Number
    The CPU usage of the Supervisor in megahertz.
    id String
    The ID of the Supervisor.
    kubernetesStatus String
    The Kubernetes status of the Supervisor.
    memoryUsage Number
    The memory usage of the Supervisor in mebibytes.
    name String
    The name of the Supervisor.
    storageUsage Number
    The storage usage of the Supervisor in mebibytes.
    workloadNetworks List<Property Map>
    A workload network of the Supervisor.
    zones List<Property Map>
    The vSphere Zones of the Supervisor.
    cluster String

    Supporting Types

    GetSupervisorWorkloadNetwork

    Gateway string
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    IpAssignmentMode string
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    Namespaces List<string>
    The vSphere Namespaces that use the Supervisor network.
    Network string
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    NetworkProvider string
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    Portgroup string
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    SubnetMask string
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    Gateway string
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    IpAssignmentMode string
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    Namespaces []string
    The vSphere Namespaces that use the Supervisor network.
    Network string
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    NetworkProvider string
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    Portgroup string
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    SubnetMask string
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    gateway string
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    ip_assignment_mode string
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    namespaces list(string)
    The vSphere Namespaces that use the Supervisor network.
    network string
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    network_provider string
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    portgroup string
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    subnet_mask string
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    gateway String
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    ipAssignmentMode String
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    namespaces List<String>
    The vSphere Namespaces that use the Supervisor network.
    network String
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    networkProvider String
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    portgroup String
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    subnetMask String
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    gateway string
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    ipAssignmentMode string
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    namespaces string[]
    The vSphere Namespaces that use the Supervisor network.
    network string
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    networkProvider string
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    portgroup string
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    subnetMask string
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    gateway str
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    ip_assignment_mode str
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    namespaces Sequence[str]
    The vSphere Namespaces that use the Supervisor network.
    network str
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    network_provider str
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    portgroup str
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    subnet_mask str
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.
    gateway String
    The gateway of the Supervisor network. Empty for NSX-backed networks.
    ipAssignmentMode String
    The IP assignment mode of the Supervisor network. Empty for NSX-backed networks.
    namespaces List<String>
    The vSphere Namespaces that use the Supervisor network.
    network String
    The name of the Supervisor network. Use it in the vsphere.getNetwork block of the vsphere.Namespace resource.
    networkProvider String
    The network provider of the Supervisor network, for example VSPHERE_NETWORK.
    portgroup String
    The ID of the distributed port group backing the Supervisor network. Empty for NSX-backed networks.
    subnetMask String
    The subnet mask of the Supervisor network. Empty for NSX-backed networks.

    GetSupervisorZone

    Clusters List<string>
    The IDs of the compute clusters in the vSphere Zone.
    Zone string
    The ID of the vSphere Zone.
    Clusters []string
    The IDs of the compute clusters in the vSphere Zone.
    Zone string
    The ID of the vSphere Zone.
    clusters list(string)
    The IDs of the compute clusters in the vSphere Zone.
    zone string
    The ID of the vSphere Zone.
    clusters List<String>
    The IDs of the compute clusters in the vSphere Zone.
    zone String
    The ID of the vSphere Zone.
    clusters string[]
    The IDs of the compute clusters in the vSphere Zone.
    zone string
    The ID of the vSphere Zone.
    clusters Sequence[str]
    The IDs of the compute clusters in the vSphere Zone.
    zone str
    The ID of the vSphere Zone.
    clusters List<String>
    The IDs of the compute clusters in the vSphere Zone.
    zone String
    The ID of the vSphere Zone.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo vsphere logo
    Viewing docs for vSphere v4.19.0
    published on Tuesday, Nov 10, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial