Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getVolumeGroupV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getVolumeGroupV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Query the Volume Group identified by {extId}.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";
import * as nutanix from "@pulumi/nutanix";

const vg = new nutanix.VolumeGroupV2("vg", {clusterReference: local.cluster1});
const volumeGroup = nutanix.getVolumeGroupV2({
    extId: resource.nutanix_volume_group_v2.test.id,
});

    import pulumi
import pulumi_nutanix as nutanix

vg = nutanix.VolumeGroupV2("vg", cluster_reference=local["cluster1"])
volume_group = nutanix.get_volume_group_v2(ext_id=resource["nutanix_volume_group_v2"]["test"]["id"])

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.NewVolumeGroupV2(ctx, "vg", &nutanix.VolumeGroupV2Args{
			ClusterReference: pulumi.Any(local.Cluster1),
		})
		if err != nil {
			return err
		}
		_, err = nutanix.LookupVolumeGroupV2(ctx, &nutanix.LookupVolumeGroupV2Args{
			ExtId: resource.Nutanix_volume_group_v2.Test.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var vg = new Nutanix.VolumeGroupV2("vg", new()
    {
        ClusterReference = local.Cluster1,
    });

    var volumeGroup = Nutanix.GetVolumeGroupV2.Invoke(new()
    {
        ExtId = resource.Nutanix_volume_group_v2.Test.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.VolumeGroupV2;
import com.pulumi.nutanix.VolumeGroupV2Args;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetVolumeGroupV2Args;
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) {
        var vg = new VolumeGroupV2("vg", VolumeGroupV2Args.builder()
            .clusterReference(local.cluster1())
            .build());

        final var volumeGroup = NutanixFunctions.getVolumeGroupV2(GetVolumeGroupV2Args.builder()
            .extId(resource.nutanix_volume_group_v2().test().id())
            .build());

    }
}

    resources:
  vg:
    type: nutanix:VolumeGroupV2
    properties:
      clusterReference: ${local.cluster1}
variables:
  volumeGroup:
    fn::invoke:
      function: nutanix:getVolumeGroupV2
      arguments:
        extId: ${resource.nutanix_volume_group_v2.test.id}

    Using getVolumeGroupV2

    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 getVolumeGroupV2(args: GetVolumeGroupV2Args, opts?: InvokeOptions): Promise<GetVolumeGroupV2Result>
function getVolumeGroupV2Output(args: GetVolumeGroupV2OutputArgs, opts?: InvokeOptions): Output<GetVolumeGroupV2Result>
    def get_volume_group_v2(ext_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVolumeGroupV2Result
def get_volume_group_v2_output(ext_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVolumeGroupV2Result]
    func LookupVolumeGroupV2(ctx *Context, args *LookupVolumeGroupV2Args, opts ...InvokeOption) (*LookupVolumeGroupV2Result, error)
func LookupVolumeGroupV2Output(ctx *Context, args *LookupVolumeGroupV2OutputArgs, opts ...InvokeOption) LookupVolumeGroupV2ResultOutput

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

    public static class GetVolumeGroupV2 
{
    public static Task<GetVolumeGroupV2Result> InvokeAsync(GetVolumeGroupV2Args args, InvokeOptions? opts = null)
    public static Output<GetVolumeGroupV2Result> Invoke(GetVolumeGroupV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeGroupV2Result> getVolumeGroupV2(GetVolumeGroupV2Args args, InvokeOptions options)
public static Output<GetVolumeGroupV2Result> getVolumeGroupV2(GetVolumeGroupV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getVolumeGroupV2:getVolumeGroupV2
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.
    extId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    ext_id str
    • A globally unique identifier of an instance that is suitable for external consumption.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.

    getVolumeGroupV2 Result

    The following output properties are available:

    ClusterReference string
    • The UUID of the cluster that will host the Volume Group.
    CreatedBy string
    • Service/user who created this Volume Group.
    Description string
    • Volume Group description. This is an optional field.
    EnabledAuthentications string
    • The authentication type enabled for the Volume Group.
    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsHidden bool
    • Indicates whether the Volume Group is meant to be hidden or not.
    IscsiFeatures List<PiersKarsenbarg.Nutanix.Outputs.GetVolumeGroupV2IscsiFeature>
    • iSCSI specific settings for the Volume Group.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetVolumeGroupV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Name string
    -(Required) Volume Group name. This is an optional field.
    SharingStatus string
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    ShouldLoadBalanceVmAttachments bool
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    StorageFeatures List<PiersKarsenbarg.Nutanix.Outputs.GetVolumeGroupV2StorageFeature>
    • Storage optimization features which must be enabled on the Volume Group.
    TargetName string
    • Name of the external client target that will be visible and accessible to the client.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    UsageType string
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER
    ClusterReference string
    • The UUID of the cluster that will host the Volume Group.
    CreatedBy string
    • Service/user who created this Volume Group.
    Description string
    • Volume Group description. This is an optional field.
    EnabledAuthentications string
    • The authentication type enabled for the Volume Group.
    ExtId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsHidden bool
    • Indicates whether the Volume Group is meant to be hidden or not.
    IscsiFeatures []GetVolumeGroupV2IscsiFeature
    • iSCSI specific settings for the Volume Group.
    Links []GetVolumeGroupV2Link
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    Name string
    -(Required) Volume Group name. This is an optional field.
    SharingStatus string
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    ShouldLoadBalanceVmAttachments bool
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    StorageFeatures []GetVolumeGroupV2StorageFeature
    • Storage optimization features which must be enabled on the Volume Group.
    TargetName string
    • Name of the external client target that will be visible and accessible to the client.
    TenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    UsageType string
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER
    clusterReference String
    • The UUID of the cluster that will host the Volume Group.
    createdBy String
    • Service/user who created this Volume Group.
    description String
    • Volume Group description. This is an optional field.
    enabledAuthentications String
    • The authentication type enabled for the Volume Group.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.
    id String
    The provider-assigned unique ID for this managed resource.
    isHidden Boolean
    • Indicates whether the Volume Group is meant to be hidden or not.
    iscsiFeatures List<GetVolumeGroupV2IscsiFeature>
    • iSCSI specific settings for the Volume Group.
    links List<GetVolumeGroupV2Link>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name String
    -(Required) Volume Group name. This is an optional field.
    sharingStatus String
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    shouldLoadBalanceVmAttachments Boolean
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    storageFeatures List<GetVolumeGroupV2StorageFeature>
    • Storage optimization features which must be enabled on the Volume Group.
    targetName String
    • Name of the external client target that will be visible and accessible to the client.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    usageType String
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER
    clusterReference string
    • The UUID of the cluster that will host the Volume Group.
    createdBy string
    • Service/user who created this Volume Group.
    description string
    • Volume Group description. This is an optional field.
    enabledAuthentications string
    • The authentication type enabled for the Volume Group.
    extId string
    • A globally unique identifier of an instance that is suitable for external consumption.
    id string
    The provider-assigned unique ID for this managed resource.
    isHidden boolean
    • Indicates whether the Volume Group is meant to be hidden or not.
    iscsiFeatures GetVolumeGroupV2IscsiFeature[]
    • iSCSI specific settings for the Volume Group.
    links GetVolumeGroupV2Link[]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name string
    -(Required) Volume Group name. This is an optional field.
    sharingStatus string
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    shouldLoadBalanceVmAttachments boolean
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    storageFeatures GetVolumeGroupV2StorageFeature[]
    • Storage optimization features which must be enabled on the Volume Group.
    targetName string
    • Name of the external client target that will be visible and accessible to the client.
    tenantId string
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    usageType string
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER
    cluster_reference str
    • The UUID of the cluster that will host the Volume Group.
    created_by str
    • Service/user who created this Volume Group.
    description str
    • Volume Group description. This is an optional field.
    enabled_authentications str
    • The authentication type enabled for the Volume Group.
    ext_id str
    • A globally unique identifier of an instance that is suitable for external consumption.
    id str
    The provider-assigned unique ID for this managed resource.
    is_hidden bool
    • Indicates whether the Volume Group is meant to be hidden or not.
    iscsi_features Sequence[GetVolumeGroupV2IscsiFeature]
    • iSCSI specific settings for the Volume Group.
    links Sequence[GetVolumeGroupV2Link]
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name str
    -(Required) Volume Group name. This is an optional field.
    sharing_status str
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    should_load_balance_vm_attachments bool
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    storage_features Sequence[GetVolumeGroupV2StorageFeature]
    • Storage optimization features which must be enabled on the Volume Group.
    target_name str
    • Name of the external client target that will be visible and accessible to the client.
    tenant_id str
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    usage_type str
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER
    clusterReference String
    • The UUID of the cluster that will host the Volume Group.
    createdBy String
    • Service/user who created this Volume Group.
    description String
    • Volume Group description. This is an optional field.
    enabledAuthentications String
    • The authentication type enabled for the Volume Group.
    extId String
    • A globally unique identifier of an instance that is suitable for external consumption.
    id String
    The provider-assigned unique ID for this managed resource.
    isHidden Boolean
    • Indicates whether the Volume Group is meant to be hidden or not.
    iscsiFeatures List<Property Map>
    • iSCSI specific settings for the Volume Group.
    links List<Property Map>
    • A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
    name String
    -(Required) Volume Group name. This is an optional field.
    sharingStatus String
    • Indicates whether the Volume Group can be shared across multiple iSCSI initiators. The mode cannot be changed from SHARED to NOT_SHARED on a Volume Group with multiple attachments. Similarly, a Volume Group cannot be associated with more than one attachment as long as it is in exclusive mode. This is an optional field. Valid values are SHARED, NOT_SHARED
    shouldLoadBalanceVmAttachments Boolean
    • Indicates whether to enable Volume Group load balancing for VM attachments. This cannot be enabled if there are iSCSI client attachments already associated with the Volume Group, and vice-versa. This is an optional field.
    storageFeatures List<Property Map>
    • Storage optimization features which must be enabled on the Volume Group.
    targetName String
    • Name of the external client target that will be visible and accessible to the client.
    tenantId String
    • A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
    usageType String
    • Expected usage type for the Volume Group. This is an indicative hint on how the caller will consume the Volume Group. Valid values are BACKUP_TARGET, INTERNAL, TEMPORARY, USER

    Supporting Types

    GetVolumeGroupV2IscsiFeature

    EnabledAuthentications string
    • The authentication type enabled for the Volume Group.
    EnabledAuthentications string
    • The authentication type enabled for the Volume Group.
    enabledAuthentications String
    • The authentication type enabled for the Volume Group.
    enabledAuthentications string
    • The authentication type enabled for the Volume Group.
    enabled_authentications str
    • The authentication type enabled for the Volume Group.
    enabledAuthentications String
    • The authentication type enabled for the Volume Group.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    Href string
    • The URL at which the entity described by the link can be accessed.
    Rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href string
    • The URL at which the entity described by the link can be accessed.
    rel string
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href str
    • The URL at which the entity described by the link can be accessed.
    rel str
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.
    href String
    • The URL at which the entity described by the link can be accessed.
    rel String
    • A name that identifies the relationship of the link to the object that is returned by the URL. The unique value of "self" identifies the URL for the object.

    GetVolumeGroupV2StorageFeature

    FlashModes List<PiersKarsenbarg.Nutanix.Inputs.GetVolumeGroupV2StorageFeatureFlashMode>
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    FlashModes []GetVolumeGroupV2StorageFeatureFlashMode
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flashModes List<GetVolumeGroupV2StorageFeatureFlashMode>
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flashModes GetVolumeGroupV2StorageFeatureFlashMode[]
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flash_modes Sequence[GetVolumeGroupV2StorageFeatureFlashMode]
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flashModes List<Property Map>
    • this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.

    GetVolumeGroupV2StorageFeatureFlashMode

    IsEnabled bool
    • Indicates whether the flash mode is enabled for the Volume Group.
    IsEnabled bool
    • Indicates whether the flash mode is enabled for the Volume Group.
    isEnabled Boolean
    • Indicates whether the flash mode is enabled for the Volume Group.
    isEnabled boolean
    • Indicates whether the flash mode is enabled for the Volume Group.
    is_enabled bool
    • Indicates whether the flash mode is enabled for the Volume Group.
    isEnabled Boolean
    • Indicates whether the flash mode is enabled for the Volume Group.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix