1. Packages
  2. Nutanix
  3. API Docs
  4. getVolumeGroupsV2
Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

nutanix.getVolumeGroupsV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg

    Describes a List all the Volume Groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pulumi/nutanix";
    
    const volumeGroups = nutanix.getVolumeGroupsV2({});
    const vg_pagination = nutanix.getVolumeGroupsV2({
        limit: 10,
        page: 1,
    });
    const vg_filter = nutanix.getVolumeGroupsV2({
        filter: "name eq 'volume_group_test'",
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    volume_groups = nutanix.get_volume_groups_v2()
    vg_pagination = nutanix.get_volume_groups_v2(limit=10,
        page=1)
    vg_filter = nutanix.get_volume_groups_v2(filter="name eq 'volume_group_test'")
    
    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.GetVolumeGroupsV2(ctx, &nutanix.GetVolumeGroupsV2Args{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nutanix.GetVolumeGroupsV2(ctx, &nutanix.GetVolumeGroupsV2Args{
    			Limit: pulumi.IntRef(10),
    			Page:  pulumi.IntRef(1),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = nutanix.GetVolumeGroupsV2(ctx, &nutanix.GetVolumeGroupsV2Args{
    			Filter: pulumi.StringRef("name eq 'volume_group_test'"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = Pulumi.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        var volumeGroups = Nutanix.GetVolumeGroupsV2.Invoke();
    
        var vg_pagination = Nutanix.GetVolumeGroupsV2.Invoke(new()
        {
            Limit = 10,
            Page = 1,
        });
    
        var vg_filter = Nutanix.GetVolumeGroupsV2.Invoke(new()
        {
            Filter = "name eq 'volume_group_test'",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nutanix.NutanixFunctions;
    import com.pulumi.nutanix.inputs.GetVolumeGroupsV2Args;
    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 volumeGroups = NutanixFunctions.getVolumeGroupsV2(GetVolumeGroupsV2Args.builder()
                .build());
    
            final var vg-pagination = NutanixFunctions.getVolumeGroupsV2(GetVolumeGroupsV2Args.builder()
                .limit(10)
                .page(1)
                .build());
    
            final var vg-filter = NutanixFunctions.getVolumeGroupsV2(GetVolumeGroupsV2Args.builder()
                .filter("name eq 'volume_group_test'")
                .build());
    
        }
    }
    
    variables:
      volumeGroups:
        fn::invoke:
          function: nutanix:getVolumeGroupsV2
          arguments: {}
      vg-pagination:
        fn::invoke:
          function: nutanix:getVolumeGroupsV2
          arguments:
            limit: 10
            page: 1
      vg-filter:
        fn::invoke:
          function: nutanix:getVolumeGroupsV2
          arguments:
            filter: name eq 'volume_group_test'
    

    Argument Reference

    The following arguments are supported:

    • page: - A query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource.
    • limit : A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
    • filter : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter ‘$filter=name eq ‘karbon-ntnx-1.0’ would filter the result on cluster name ‘karbon-ntnx1.0’, filter ‘$filter=startswith(name, ‘C’)’ would filter on cluster name starting with ‘C’. The filter can be applied to the following fields:
      • clusterReference
      • extId
      • name
    • orderby : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, ‘$orderby=templateName desc’ would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields:
      • clusterReference
      • extId
      • name
    • expand : A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported. The expand can be applied to the following fields:
      • clusterReference
      • metadata
    • select : A query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. The select can be applied to the following fields:
      • clusterReference
      • extId
      • name

    Volume Groups

    The volume_groups contains list of Volume Groups. Each Volume Group contains the following attributes:

    • tenant_id: - 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).
    • ext_id: - A globally unique identifier of an instance that is suitable for external consumption.
    • links: - 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: -(Required) Volume Group name. This is an optional field.
    • description: - Volume Group description. This is an optional field.
    • should_load_balance_vm_attachments: - 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.
    • sharing_status: - 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
    • target_name: - Name of the external client target that will be visible and accessible to the client.
    • enabled_authentications: - The authentication type enabled for the Volume Group. Valid values are CHAP, NONE
    • iscsi_features: - iSCSI specific settings for the Volume Group.
    • created_by: - Service/user who created this Volume Group.
    • cluster_reference: - The UUID of the cluster that will host the Volume Group.
    • storage_features: - Storage optimization features which must be enabled on the Volume Group.
    • usage_type: - 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
    • is_hidden: - Indicates whether the Volume Group is meant to be hidden or not.

    The links attribute supports the following:

    • href: - The URL at which the entity described by the link can be accessed.
    • rel: - 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.

    Iscsi Features

    The iscsi_features attribute supports the following:

    • enabled_authentications: - The authentication type enabled for the Volume Group.

    Storage Features

    The storage features attribute supports the following:

    • flash_mode: - this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    Flash Mode

    The flash mode features attribute supports the following:

    • is_enabled: - Indicates whether the flash mode is enabled for the Volume Group.

    See detailed information in Nutanix List Volume Groups V4.

    Using getVolumeGroupsV2

    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 getVolumeGroupsV2(args: GetVolumeGroupsV2Args, opts?: InvokeOptions): Promise<GetVolumeGroupsV2Result>
    function getVolumeGroupsV2Output(args: GetVolumeGroupsV2OutputArgs, opts?: InvokeOptions): Output<GetVolumeGroupsV2Result>
    def get_volume_groups_v2(expand: Optional[str] = None,
                             filter: Optional[str] = None,
                             limit: Optional[int] = None,
                             orderby: Optional[str] = None,
                             page: Optional[int] = None,
                             select: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVolumeGroupsV2Result
    def get_volume_groups_v2_output(expand: Optional[pulumi.Input[str]] = None,
                             filter: Optional[pulumi.Input[str]] = None,
                             limit: Optional[pulumi.Input[int]] = None,
                             orderby: Optional[pulumi.Input[str]] = None,
                             page: Optional[pulumi.Input[int]] = None,
                             select: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVolumeGroupsV2Result]
    func GetVolumeGroupsV2(ctx *Context, args *GetVolumeGroupsV2Args, opts ...InvokeOption) (*GetVolumeGroupsV2Result, error)
    func GetVolumeGroupsV2Output(ctx *Context, args *GetVolumeGroupsV2OutputArgs, opts ...InvokeOption) GetVolumeGroupsV2ResultOutput

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

    public static class GetVolumeGroupsV2 
    {
        public static Task<GetVolumeGroupsV2Result> InvokeAsync(GetVolumeGroupsV2Args args, InvokeOptions? opts = null)
        public static Output<GetVolumeGroupsV2Result> Invoke(GetVolumeGroupsV2InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVolumeGroupsV2Result> getVolumeGroupsV2(GetVolumeGroupsV2Args args, InvokeOptions options)
    public static Output<GetVolumeGroupsV2Result> getVolumeGroupsV2(GetVolumeGroupsV2Args args, InvokeOptions options)
    
    fn::invoke:
      function: nutanix:index/getVolumeGroupsV2:getVolumeGroupsV2
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Expand string
    Filter string
    Limit int
    Orderby string
    Page int
    Select string
    Expand string
    Filter string
    Limit int
    Orderby string
    Page int
    Select string
    expand String
    filter String
    limit Integer
    orderby String
    page Integer
    select String
    expand string
    filter string
    limit number
    orderby string
    page number
    select string
    expand str
    filter str
    limit int
    orderby str
    page int
    select str
    expand String
    filter String
    limit Number
    orderby String
    page Number
    select String

    getVolumeGroupsV2 Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Volumes List<PiersKarsenbarg.Nutanix.Outputs.GetVolumeGroupsV2Volume>
    Expand string
    Filter string
    Limit int
    Orderby string
    Page int
    Select string
    Id string
    The provider-assigned unique ID for this managed resource.
    Volumes []GetVolumeGroupsV2Volume
    Expand string
    Filter string
    Limit int
    Orderby string
    Page int
    Select string
    id String
    The provider-assigned unique ID for this managed resource.
    volumes List<GetVolumeGroupsV2Volume>
    expand String
    filter String
    limit Integer
    orderby String
    page Integer
    select String
    id string
    The provider-assigned unique ID for this managed resource.
    volumes GetVolumeGroupsV2Volume[]
    expand string
    filter string
    limit number
    orderby string
    page number
    select string
    id str
    The provider-assigned unique ID for this managed resource.
    volumes Sequence[GetVolumeGroupsV2Volume]
    expand str
    filter str
    limit int
    orderby str
    page int
    select str
    id String
    The provider-assigned unique ID for this managed resource.
    volumes List<Property Map>
    expand String
    filter String
    limit Number
    orderby String
    page Number
    select String

    Supporting Types

    GetVolumeGroupsV2Volume

    ClusterReference string
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    CreatedBy string
    Service/user who created this Volume Group. This is an optional field.
    Description string
    Volume Group description. This is an optional field.
    EnabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    ExtId string
    A globally unique identifier of an instance that is suitable for external consumption.
    IsHidden bool
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    IscsiFeatures List<PiersKarsenbarg.Nutanix.Inputs.GetVolumeGroupsV2VolumeIscsiFeature>
    iSCSI specific settings for the Volume Group. This is an optional field.
    Links List<PiersKarsenbarg.Nutanix.Inputs.GetVolumeGroupsV2VolumeLink>
    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
    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
    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.Inputs.GetVolumeGroupsV2VolumeStorageFeature>
    Storage optimization features which must be enabled on the Volume Group. This is an optional field.
    TargetName string
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.
    ClusterReference string
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    CreatedBy string
    Service/user who created this Volume Group. This is an optional field.
    Description string
    Volume Group description. This is an optional field.
    EnabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    ExtId string
    A globally unique identifier of an instance that is suitable for external consumption.
    IsHidden bool
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    IscsiFeatures []GetVolumeGroupsV2VolumeIscsiFeature
    iSCSI specific settings for the Volume Group. This is an optional field.
    Links []GetVolumeGroupsV2VolumeLink
    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
    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
    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 []GetVolumeGroupsV2VolumeStorageFeature
    Storage optimization features which must be enabled on the Volume Group. This is an optional field.
    TargetName string
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.
    clusterReference String
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    createdBy String
    Service/user who created this Volume Group. This is an optional field.
    description String
    Volume Group description. This is an optional field.
    enabledAuthentications String
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    extId String
    A globally unique identifier of an instance that is suitable for external consumption.
    isHidden Boolean
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    iscsiFeatures List<GetVolumeGroupsV2VolumeIscsiFeature>
    iSCSI specific settings for the Volume Group. This is an optional field.
    links List<GetVolumeGroupsV2VolumeLink>
    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
    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
    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<GetVolumeGroupsV2VolumeStorageFeature>
    Storage optimization features which must be enabled on the Volume Group. This is an optional field.
    targetName String
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.
    clusterReference string
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    createdBy string
    Service/user who created this Volume Group. This is an optional field.
    description string
    Volume Group description. This is an optional field.
    enabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    extId string
    A globally unique identifier of an instance that is suitable for external consumption.
    isHidden boolean
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    iscsiFeatures GetVolumeGroupsV2VolumeIscsiFeature[]
    iSCSI specific settings for the Volume Group. This is an optional field.
    links GetVolumeGroupsV2VolumeLink[]
    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
    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
    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 GetVolumeGroupsV2VolumeStorageFeature[]
    Storage optimization features which must be enabled on the Volume Group. This is an optional field.
    targetName string
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.
    cluster_reference str
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    created_by str
    Service/user who created this Volume Group. This is an optional field.
    description str
    Volume Group description. This is an optional field.
    enabled_authentications str
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    ext_id str
    A globally unique identifier of an instance that is suitable for external consumption.
    is_hidden bool
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    iscsi_features Sequence[GetVolumeGroupsV2VolumeIscsiFeature]
    iSCSI specific settings for the Volume Group. This is an optional field.
    links Sequence[GetVolumeGroupsV2VolumeLink]
    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
    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
    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[GetVolumeGroupsV2VolumeStorageFeature]
    Storage optimization features which must be enabled on the Volume Group. This is an optional field.
    target_name str
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.
    clusterReference String
    The UUID of the cluster that will host the Volume Group. This is a mandatory field for creating a Volume Group on Prism Central.
    createdBy String
    Service/user who created this Volume Group. This is an optional field.
    description String
    Volume Group description. This is an optional field.
    enabledAuthentications String
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    extId String
    A globally unique identifier of an instance that is suitable for external consumption.
    isHidden Boolean
    Indicates whether the Volume Group is meant to be hidden or not. This is an optional field. If omitted, the VG will not be hidden.
    iscsiFeatures List<Property Map>
    iSCSI specific settings for the Volume Group. This is an optional field.
    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
    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
    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. This is an optional field.
    targetName String
    Name of the external client target that will be visible and accessible to the client. This is an optional field.
    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. This is an optional field.

    GetVolumeGroupsV2VolumeIscsiFeature

    EnabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    EnabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    enabledAuthentications String
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    enabledAuthentications string
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    enabled_authentications str
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    enabledAuthentications String
    The authentication type enabled for the Volume Group. This is an optional field. If omitted, authentication is not configured for the Volume Group. If this is set to CHAP, the target/client secret must be provided.
    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.

    GetVolumeGroupsV2VolumeStorageFeature

    FlashModes List<PiersKarsenbarg.Nutanix.Inputs.GetVolumeGroupsV2VolumeStorageFeatureFlashMode>
    Once configured, this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    FlashModes []GetVolumeGroupsV2VolumeStorageFeatureFlashMode
    Once configured, this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flashModes List<GetVolumeGroupsV2VolumeStorageFeatureFlashMode>
    Once configured, this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.
    flashModes GetVolumeGroupsV2VolumeStorageFeatureFlashMode[]
    Once configured, 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[GetVolumeGroupsV2VolumeStorageFeatureFlashMode]
    Once configured, 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>
    Once configured, this field will avoid down migration of data from the hot tier unless the overrides field is specified for the virtual disks.

    GetVolumeGroupsV2VolumeStorageFeatureFlashMode

    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.8.0 published on Sunday, May 11, 2025 by Piers Karsenbarg