1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Ocvp
  5. getClusters
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Ocvp.getClusters

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

    This data source provides the list of Clusters in Oracle Cloud Infrastructure Oracle Cloud VMware Solution service.

    Lists the Clusters in the specified compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testClusters = oci.Ocvp.getClusters({
        compartmentId: compartmentId,
        displayName: clusterDisplayName,
        sddcId: testSddc.id,
        state: clusterState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_clusters = oci.Ocvp.get_clusters(compartment_id=compartment_id,
        display_name=cluster_display_name,
        sddc_id=test_sddc["id"],
        state=cluster_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Ocvp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Ocvp.GetClusters(ctx, &ocvp.GetClustersArgs{
    			CompartmentId: pulumi.StringRef(compartmentId),
    			DisplayName:   pulumi.StringRef(clusterDisplayName),
    			SddcId:        pulumi.StringRef(testSddc.Id),
    			State:         pulumi.StringRef(clusterState),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testClusters = Oci.Ocvp.GetClusters.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = clusterDisplayName,
            SddcId = testSddc.Id,
            State = clusterState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Ocvp.OcvpFunctions;
    import com.pulumi.oci.Ocvp.inputs.GetClustersArgs;
    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 testClusters = OcvpFunctions.getClusters(GetClustersArgs.builder()
                .compartmentId(compartmentId)
                .displayName(clusterDisplayName)
                .sddcId(testSddc.id())
                .state(clusterState)
                .build());
    
        }
    }
    
    variables:
      testClusters:
        fn::invoke:
          Function: oci:Ocvp:getClusters
          Arguments:
            compartmentId: ${compartmentId}
            displayName: ${clusterDisplayName}
            sddcId: ${testSddc.id}
            state: ${clusterState}
    

    Using getClusters

    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 getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
    function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>
    def get_clusters(compartment_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     filters: Optional[Sequence[_ocvp.GetClustersFilter]] = None,
                     sddc_id: Optional[str] = None,
                     state: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetClustersResult
    def get_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     filters: Optional[pulumi.Input[Sequence[pulumi.Input[_ocvp.GetClustersFilterArgs]]]] = None,
                     sddc_id: Optional[pulumi.Input[str]] = None,
                     state: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
    func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
    func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

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

    public static class GetClusters 
    {
        public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
        public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Ocvp/getClusters:getClusters
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment as optional parameter.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetClustersFilter>
    SddcId string
    The OCID of the SDDC.
    State string
    The lifecycle state of the resource.
    CompartmentId string
    The OCID of the compartment as optional parameter.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetClustersFilter
    SddcId string
    The OCID of the SDDC.
    State string
    The lifecycle state of the resource.
    compartmentId String
    The OCID of the compartment as optional parameter.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetClustersFilter>
    sddcId String
    The OCID of the SDDC.
    state String
    The lifecycle state of the resource.
    compartmentId string
    The OCID of the compartment as optional parameter.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetClustersFilter[]
    sddcId string
    The OCID of the SDDC.
    state string
    The lifecycle state of the resource.
    compartment_id str
    The OCID of the compartment as optional parameter.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[ocvp.GetClustersFilter]
    sddc_id str
    The OCID of the SDDC.
    state str
    The lifecycle state of the resource.
    compartmentId String
    The OCID of the compartment as optional parameter.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    sddcId String
    The OCID of the SDDC.
    state String
    The lifecycle state of the resource.

    getClusters Result

    The following output properties are available:

    ClusterCollections List<GetClustersClusterCollection>
    The list of cluster_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment that contains the Cluster.
    DisplayName string
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    Filters List<GetClustersFilter>
    SddcId string
    The OCID of the SDDC that the Cluster belongs to.
    State string
    The current state of the Cluster.
    ClusterCollections []GetClustersClusterCollection
    The list of cluster_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    CompartmentId string
    The OCID of the compartment that contains the Cluster.
    DisplayName string
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    Filters []GetClustersFilter
    SddcId string
    The OCID of the SDDC that the Cluster belongs to.
    State string
    The current state of the Cluster.
    clusterCollections List<GetClustersClusterCollection>
    The list of cluster_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment that contains the Cluster.
    displayName String
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    filters List<GetClustersFilter>
    sddcId String
    The OCID of the SDDC that the Cluster belongs to.
    state String
    The current state of the Cluster.
    clusterCollections GetClustersClusterCollection[]
    The list of cluster_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    compartmentId string
    The OCID of the compartment that contains the Cluster.
    displayName string
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    filters GetClustersFilter[]
    sddcId string
    The OCID of the SDDC that the Cluster belongs to.
    state string
    The current state of the Cluster.
    cluster_collections Sequence[ocvp.GetClustersClusterCollection]
    The list of cluster_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    compartment_id str
    The OCID of the compartment that contains the Cluster.
    display_name str
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    filters Sequence[ocvp.GetClustersFilter]
    sddc_id str
    The OCID of the SDDC that the Cluster belongs to.
    state str
    The current state of the Cluster.
    clusterCollections List<Property Map>
    The list of cluster_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    compartmentId String
    The OCID of the compartment that contains the Cluster.
    displayName String
    A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.
    filters List<Property Map>
    sddcId String
    The OCID of the SDDC that the Cluster belongs to.
    state String
    The current state of the Cluster.

    Supporting Types

    GetClustersClusterCollection

    GetClustersClusterCollectionItem

    ActualEsxiHostsCount int
    CapacityReservationId string
    The OCID of the Capacity Reservation.
    CompartmentId string
    The OCID of the compartment as optional parameter.
    ComputeAvailabilityDomain string
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    Datastores List<GetClustersClusterCollectionItemDatastore>
    Datastores used for the Cluster.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    EsxiHostsCount int
    The number of ESXi hosts in the Cluster.
    EsxiSoftwareVersion string
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Cluster.
    InitialCommitment string
    The billing option selected during Cluster creation. ListSupportedCommitments.
    InitialHostOcpuCount double
    The initial OCPU count of the Cluster's ESXi hosts.
    InitialHostShapeName string
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    InstanceDisplayNamePrefix string
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    IsShieldedInstanceEnabled bool
    Indicates whether shielded instance is enabled at the Cluster level.
    NetworkConfigurations List<GetClustersClusterCollectionItemNetworkConfiguration>
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    SddcId string
    The OCID of the SDDC.
    State string
    The lifecycle state of the resource.
    TimeCreated string
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the Cluster was updated, in the format defined by RFC3339.
    UpgradeLicenses List<GetClustersClusterCollectionItemUpgradeLicense>
    The vSphere licenses to use when upgrading the Cluster.
    VmwareSoftwareVersion string
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    VsphereType string
    vSphere Cluster types.
    VsphereUpgradeObjects List<GetClustersClusterCollectionItemVsphereUpgradeObject>
    The links to binary objects needed to upgrade vSphere.
    WorkloadNetworkCidr string
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
    ActualEsxiHostsCount int
    CapacityReservationId string
    The OCID of the Capacity Reservation.
    CompartmentId string
    The OCID of the compartment as optional parameter.
    ComputeAvailabilityDomain string
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    Datastores []GetClustersClusterCollectionItemDatastore
    Datastores used for the Cluster.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    EsxiHostsCount int
    The number of ESXi hosts in the Cluster.
    EsxiSoftwareVersion string
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the Cluster.
    InitialCommitment string
    The billing option selected during Cluster creation. ListSupportedCommitments.
    InitialHostOcpuCount float64
    The initial OCPU count of the Cluster's ESXi hosts.
    InitialHostShapeName string
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    InstanceDisplayNamePrefix string
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    IsShieldedInstanceEnabled bool
    Indicates whether shielded instance is enabled at the Cluster level.
    NetworkConfigurations []GetClustersClusterCollectionItemNetworkConfiguration
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    SddcId string
    The OCID of the SDDC.
    State string
    The lifecycle state of the resource.
    TimeCreated string
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the Cluster was updated, in the format defined by RFC3339.
    UpgradeLicenses []GetClustersClusterCollectionItemUpgradeLicense
    The vSphere licenses to use when upgrading the Cluster.
    VmwareSoftwareVersion string
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    VsphereType string
    vSphere Cluster types.
    VsphereUpgradeObjects []GetClustersClusterCollectionItemVsphereUpgradeObject
    The links to binary objects needed to upgrade vSphere.
    WorkloadNetworkCidr string
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
    actualEsxiHostsCount Integer
    capacityReservationId String
    The OCID of the Capacity Reservation.
    compartmentId String
    The OCID of the compartment as optional parameter.
    computeAvailabilityDomain String
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    datastores List<GetClustersClusterCollectionItemDatastore>
    Datastores used for the Cluster.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    esxiHostsCount Integer
    The number of ESXi hosts in the Cluster.
    esxiSoftwareVersion String
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Cluster.
    initialCommitment String
    The billing option selected during Cluster creation. ListSupportedCommitments.
    initialHostOcpuCount Double
    The initial OCPU count of the Cluster's ESXi hosts.
    initialHostShapeName String
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    instanceDisplayNamePrefix String
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    isShieldedInstanceEnabled Boolean
    Indicates whether shielded instance is enabled at the Cluster level.
    networkConfigurations List<GetClustersClusterCollectionItemNetworkConfiguration>
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    sddcId String
    The OCID of the SDDC.
    state String
    The lifecycle state of the resource.
    timeCreated String
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the Cluster was updated, in the format defined by RFC3339.
    upgradeLicenses List<GetClustersClusterCollectionItemUpgradeLicense>
    The vSphere licenses to use when upgrading the Cluster.
    vmwareSoftwareVersion String
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    vsphereType String
    vSphere Cluster types.
    vsphereUpgradeObjects List<GetClustersClusterCollectionItemVsphereUpgradeObject>
    The links to binary objects needed to upgrade vSphere.
    workloadNetworkCidr String
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
    actualEsxiHostsCount number
    capacityReservationId string
    The OCID of the Capacity Reservation.
    compartmentId string
    The OCID of the compartment as optional parameter.
    computeAvailabilityDomain string
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    datastores GetClustersClusterCollectionItemDatastore[]
    Datastores used for the Cluster.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A filter to return only resources that match the given display name exactly.
    esxiHostsCount number
    The number of ESXi hosts in the Cluster.
    esxiSoftwareVersion string
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the Cluster.
    initialCommitment string
    The billing option selected during Cluster creation. ListSupportedCommitments.
    initialHostOcpuCount number
    The initial OCPU count of the Cluster's ESXi hosts.
    initialHostShapeName string
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    instanceDisplayNamePrefix string
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    isShieldedInstanceEnabled boolean
    Indicates whether shielded instance is enabled at the Cluster level.
    networkConfigurations GetClustersClusterCollectionItemNetworkConfiguration[]
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    sddcId string
    The OCID of the SDDC.
    state string
    The lifecycle state of the resource.
    timeCreated string
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the Cluster was updated, in the format defined by RFC3339.
    upgradeLicenses GetClustersClusterCollectionItemUpgradeLicense[]
    The vSphere licenses to use when upgrading the Cluster.
    vmwareSoftwareVersion string
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    vsphereType string
    vSphere Cluster types.
    vsphereUpgradeObjects GetClustersClusterCollectionItemVsphereUpgradeObject[]
    The links to binary objects needed to upgrade vSphere.
    workloadNetworkCidr string
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
    actual_esxi_hosts_count int
    capacity_reservation_id str
    The OCID of the Capacity Reservation.
    compartment_id str
    The OCID of the compartment as optional parameter.
    compute_availability_domain str
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    datastores Sequence[ocvp.GetClustersClusterCollectionItemDatastore]
    Datastores used for the Cluster.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A filter to return only resources that match the given display name exactly.
    esxi_hosts_count int
    The number of ESXi hosts in the Cluster.
    esxi_software_version str
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the Cluster.
    initial_commitment str
    The billing option selected during Cluster creation. ListSupportedCommitments.
    initial_host_ocpu_count float
    The initial OCPU count of the Cluster's ESXi hosts.
    initial_host_shape_name str
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    instance_display_name_prefix str
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    is_shielded_instance_enabled bool
    Indicates whether shielded instance is enabled at the Cluster level.
    network_configurations Sequence[ocvp.GetClustersClusterCollectionItemNetworkConfiguration]
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    sddc_id str
    The OCID of the SDDC.
    state str
    The lifecycle state of the resource.
    time_created str
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the Cluster was updated, in the format defined by RFC3339.
    upgrade_licenses Sequence[ocvp.GetClustersClusterCollectionItemUpgradeLicense]
    The vSphere licenses to use when upgrading the Cluster.
    vmware_software_version str
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    vsphere_type str
    vSphere Cluster types.
    vsphere_upgrade_objects Sequence[ocvp.GetClustersClusterCollectionItemVsphereUpgradeObject]
    The links to binary objects needed to upgrade vSphere.
    workload_network_cidr str
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
    actualEsxiHostsCount Number
    capacityReservationId String
    The OCID of the Capacity Reservation.
    compartmentId String
    The OCID of the compartment as optional parameter.
    computeAvailabilityDomain String
    The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD. Example: Uocm:PHX-AD-1, multi-AD
    datastores List<Property Map>
    Datastores used for the Cluster.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A filter to return only resources that match the given display name exactly.
    esxiHostsCount Number
    The number of ESXi hosts in the Cluster.
    esxiSoftwareVersion String
    In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the Cluster.
    initialCommitment String
    The billing option selected during Cluster creation. ListSupportedCommitments.
    initialHostOcpuCount Number
    The initial OCPU count of the Cluster's ESXi hosts.
    initialHostShapeName String
    The initial compute shape of the Cluster's ESXi hosts. ListSupportedHostShapes.
    instanceDisplayNamePrefix String
    A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.
    isShieldedInstanceEnabled Boolean
    Indicates whether shielded instance is enabled at the Cluster level.
    networkConfigurations List<Property Map>
    The network configurations used by Cluster, including OCIDs of the management subnet and VLANs.
    sddcId String
    The OCID of the SDDC.
    state String
    The lifecycle state of the resource.
    timeCreated String
    The date and time the Cluster was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the Cluster was updated, in the format defined by RFC3339.
    upgradeLicenses List<Property Map>
    The vSphere licenses to use when upgrading the Cluster.
    vmwareSoftwareVersion String
    In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see ListSupportedVmwareSoftwareVersions).
    vsphereType String
    vSphere Cluster types.
    vsphereUpgradeObjects List<Property Map>
    The links to binary objects needed to upgrade vSphere.
    workloadNetworkCidr String
    The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

    GetClustersClusterCollectionItemDatastore

    BlockVolumeIds List<string>
    A list of OCIDs of Block Storage Volumes.
    Capacity double
    Size of the Block Storage Volume in GB.
    DatastoreType string
    Type of the datastore.
    BlockVolumeIds []string
    A list of OCIDs of Block Storage Volumes.
    Capacity float64
    Size of the Block Storage Volume in GB.
    DatastoreType string
    Type of the datastore.
    blockVolumeIds List<String>
    A list of OCIDs of Block Storage Volumes.
    capacity Double
    Size of the Block Storage Volume in GB.
    datastoreType String
    Type of the datastore.
    blockVolumeIds string[]
    A list of OCIDs of Block Storage Volumes.
    capacity number
    Size of the Block Storage Volume in GB.
    datastoreType string
    Type of the datastore.
    block_volume_ids Sequence[str]
    A list of OCIDs of Block Storage Volumes.
    capacity float
    Size of the Block Storage Volume in GB.
    datastore_type str
    Type of the datastore.
    blockVolumeIds List<String>
    A list of OCIDs of Block Storage Volumes.
    capacity Number
    Size of the Block Storage Volume in GB.
    datastoreType String
    Type of the datastore.

    GetClustersClusterCollectionItemNetworkConfiguration

    HcxVlanId string
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    NsxEdgeUplink1vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    NsxEdgeUplink2vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    NsxEdgeVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    NsxVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    ProvisioningSubnetId string
    The OCID of the management subnet used to provision the Cluster.
    ProvisioningVlanId string
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    ReplicationVlanId string
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    VmotionVlanId string
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    VsanVlanId string
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    VsphereVlanId string
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    HcxVlanId string
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    NsxEdgeUplink1vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    NsxEdgeUplink2vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    NsxEdgeVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    NsxVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    ProvisioningSubnetId string
    The OCID of the management subnet used to provision the Cluster.
    ProvisioningVlanId string
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    ReplicationVlanId string
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    VmotionVlanId string
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    VsanVlanId string
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    VsphereVlanId string
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    hcxVlanId String
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    nsxEdgeUplink1vlanId String
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeUplink2vlanId String
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeVtepVlanId String
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    nsxVtepVlanId String
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    provisioningSubnetId String
    The OCID of the management subnet used to provision the Cluster.
    provisioningVlanId String
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    replicationVlanId String
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    vmotionVlanId String
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    vsanVlanId String
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    vsphereVlanId String
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    hcxVlanId string
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    nsxEdgeUplink1vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeUplink2vlanId string
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    nsxVtepVlanId string
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    provisioningSubnetId string
    The OCID of the management subnet used to provision the Cluster.
    provisioningVlanId string
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    replicationVlanId string
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    vmotionVlanId string
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    vsanVlanId string
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    vsphereVlanId string
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    hcx_vlan_id str
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    nsx_edge_uplink1vlan_id str
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsx_edge_uplink2vlan_id str
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsx_edge_vtep_vlan_id str
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    nsx_vtep_vlan_id str
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    provisioning_subnet_id str
    The OCID of the management subnet used to provision the Cluster.
    provisioning_vlan_id str
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    replication_vlan_id str
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    vmotion_vlan_id str
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    vsan_vlan_id str
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    vsphere_vlan_id str
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    hcxVlanId String
    The OCID of the VLAN used by the SDDC for the HCX component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster when HCX is enabled.
    nsxEdgeUplink1vlanId String
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 1 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeUplink2vlanId String
    The OCID of the VLAN used by the SDDC for the NSX Edge Uplink 2 component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.
    nsxEdgeVtepVlanId String
    The OCID of the VLAN used by the Cluster for the NSX Edge VTEP component of the VMware environment.
    nsxVtepVlanId String
    The OCID of the VLAN used by the Cluster for the NSX VTEP component of the VMware environment.
    provisioningSubnetId String
    The OCID of the management subnet used to provision the Cluster.
    provisioningVlanId String
    The OCID of the VLAN used by the Cluster for the Provisioning component of the VMware environment.
    replicationVlanId String
    The OCID of the VLAN used by the Cluster for the vSphere Replication component of the VMware environment.
    vmotionVlanId String
    The OCID of the VLAN used by the Cluster for the vMotion component of the VMware environment.
    vsanVlanId String
    The OCID of the VLAN used by the Cluster for the vSAN component of the VMware environment.
    vsphereVlanId String
    The OCID of the VLAN used by the SDDC for the vSphere component of the VMware environment. This VLAN is a mandatory attribute for Management Cluster.

    GetClustersClusterCollectionItemUpgradeLicense

    LicenseKey string
    vSphere license key value.
    LicenseType string
    vSphere license type.
    LicenseKey string
    vSphere license key value.
    LicenseType string
    vSphere license type.
    licenseKey String
    vSphere license key value.
    licenseType String
    vSphere license type.
    licenseKey string
    vSphere license key value.
    licenseType string
    vSphere license type.
    license_key str
    vSphere license key value.
    license_type str
    vSphere license type.
    licenseKey String
    vSphere license key value.
    licenseType String
    vSphere license type.

    GetClustersClusterCollectionItemVsphereUpgradeObject

    DownloadLink string
    Binary object download link.
    LinkDescription string
    Binary object description.
    DownloadLink string
    Binary object download link.
    LinkDescription string
    Binary object description.
    downloadLink String
    Binary object download link.
    linkDescription String
    Binary object description.
    downloadLink string
    Binary object download link.
    linkDescription string
    Binary object description.
    download_link str
    Binary object download link.
    link_description str
    Binary object description.
    downloadLink String
    Binary object download link.
    linkDescription String
    Binary object description.

    GetClustersFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi