1. Packages
  2. Packages
  3. Nutanix
  4. API Docs
  5. getEntityGroupV2
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
nutanix logo
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg

    Fetches a single entity group by its external identifier (ext_id). Use this data source when you know the entity group UUID and need its attributes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as nutanix from "@pierskarsenbarg/nutanix";
    
    // Fetch by known ext_id
    const example = nutanix.getEntityGroupV2({
        extId: "00000000-0000-0000-0000-000000000000",
    });
    // Fetch entity group created by a resource
    const byId = nutanix.getEntityGroupV2({
        extId: myGroup.id,
    });
    
    import pulumi
    import pulumi_nutanix as nutanix
    
    # Fetch by known ext_id
    example = nutanix.get_entity_group_v2(ext_id="00000000-0000-0000-0000-000000000000")
    # Fetch entity group created by a resource
    by_id = nutanix.get_entity_group_v2(ext_id=my_group["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 {
    		// Fetch by known ext_id
    		_, err := nutanix.GetEntityGroupV2(ctx, &nutanix.LookupEntityGroupV2Args{
    			ExtId: "00000000-0000-0000-0000-000000000000",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Fetch entity group created by a resource
    		_, err = nutanix.GetEntityGroupV2(ctx, &nutanix.LookupEntityGroupV2Args{
    			ExtId: myGroup.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nutanix = PiersKarsenbarg.Nutanix;
    
    return await Deployment.RunAsync(() => 
    {
        // Fetch by known ext_id
        var example = Nutanix.GetEntityGroupV2.Invoke(new()
        {
            ExtId = "00000000-0000-0000-0000-000000000000",
        });
    
        // Fetch entity group created by a resource
        var byId = Nutanix.GetEntityGroupV2.Invoke(new()
        {
            ExtId = myGroup.Id,
        });
    
    });
    
    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.GetEntityGroupV2Args;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Fetch by known ext_id
            final var example = NutanixFunctions.getEntityGroupV2(GetEntityGroupV2Args.builder()
                .extId("00000000-0000-0000-0000-000000000000")
                .build());
    
            // Fetch entity group created by a resource
            final var byId = NutanixFunctions.getEntityGroupV2(GetEntityGroupV2Args.builder()
                .extId(myGroup.id())
                .build());
    
        }
    }
    
    variables:
      # Fetch by known ext_id
      example:
        fn::invoke:
          function: nutanix:getEntityGroupV2
          arguments:
            extId: 00000000-0000-0000-0000-000000000000
      # Fetch entity group created by a resource
      byId:
        fn::invoke:
          function: nutanix:getEntityGroupV2
          arguments:
            extId: ${myGroup.id}
    
    pulumi {
      required_providers {
        nutanix = {
          source = "pulumi/nutanix"
        }
      }
    }
    
    data "nutanix_getentitygroupv2" "example" {
      ext_id = "00000000-0000-0000-0000-000000000000"
    }
    data "nutanix_getentitygroupv2" "byId" {
      ext_id = myGroup.id
    }
    
    # Fetch by known ext_id
    # Fetch entity group created by a resource
    

    Using getEntityGroupV2

    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 getEntityGroupV2(args: GetEntityGroupV2Args, opts?: InvokeOptions): Promise<GetEntityGroupV2Result>
    function getEntityGroupV2Output(args: GetEntityGroupV2OutputArgs, opts?: InvokeOptions): Output<GetEntityGroupV2Result>
    def get_entity_group_v2(ext_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEntityGroupV2Result
    def get_entity_group_v2_output(ext_id: pulumi.Input[Optional[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetEntityGroupV2Result]
    func LookupEntityGroupV2(ctx *Context, args *LookupEntityGroupV2Args, opts ...InvokeOption) (*LookupEntityGroupV2Result, error)
    func LookupEntityGroupV2Output(ctx *Context, args *LookupEntityGroupV2OutputArgs, opts ...InvokeOption) LookupEntityGroupV2ResultOutput

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

    public static class GetEntityGroupV2 
    {
        public static Task<GetEntityGroupV2Result> InvokeAsync(GetEntityGroupV2Args args, InvokeOptions? opts = null)
        public static Output<GetEntityGroupV2Result> Invoke(GetEntityGroupV2InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEntityGroupV2Result> getEntityGroupV2(GetEntityGroupV2Args args, InvokeOptions options)
    public static Output<GetEntityGroupV2Result> getEntityGroupV2(GetEntityGroupV2Args args, InvokeOptions options)
    
    fn::invoke:
      function: nutanix:index/getEntityGroupV2:getEntityGroupV2
      arguments:
        # arguments dictionary
    data "nutanix_getentitygroupv2" "name" {
        # arguments
    }

    The following arguments are supported:

    ExtId string
    The external identifier (UUID) of the entity group.
    ExtId string
    The external identifier (UUID) of the entity group.
    ext_id string
    The external identifier (UUID) of the entity group.
    extId String
    The external identifier (UUID) of the entity group.
    extId string
    The external identifier (UUID) of the entity group.
    ext_id str
    The external identifier (UUID) of the entity group.
    extId String
    The external identifier (UUID) of the entity group.

    getEntityGroupV2 Result

    The following output properties are available:

    AllowedConfigs List<PiersKarsenbarg.Nutanix.Outputs.GetEntityGroupV2AllowedConfig>
    Configuration of the allowed entities in the Entity Group.
    CreationTime string
    The timestamp when the Entity Group was created.
    Description string
    A user defined annotation for an Entity Group.
    ExceptConfigs List<PiersKarsenbarg.Nutanix.Outputs.GetEntityGroupV2ExceptConfig>
    Configuration of except entities in the Entity 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.
    LastUpdateTime string
    The timestamp when the Entity Group was last updated.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetEntityGroupV2Link>
    A HATEOAS style link for the response.
    Name string
    A short identifier of an Entity Group.
    OwnerExtId string
    The external identifier of the user who created the Entity Group.
    PolicyExtIds List<string>
    Mapping of entity group to the list of policy external identifiers.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    AllowedConfigs []GetEntityGroupV2AllowedConfig
    Configuration of the allowed entities in the Entity Group.
    CreationTime string
    The timestamp when the Entity Group was created.
    Description string
    A user defined annotation for an Entity Group.
    ExceptConfigs []GetEntityGroupV2ExceptConfig
    Configuration of except entities in the Entity 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.
    LastUpdateTime string
    The timestamp when the Entity Group was last updated.
    Links []GetEntityGroupV2Link
    A HATEOAS style link for the response.
    Name string
    A short identifier of an Entity Group.
    OwnerExtId string
    The external identifier of the user who created the Entity Group.
    PolicyExtIds []string
    Mapping of entity group to the list of policy external identifiers.
    TenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    allowed_configs list(object)
    Configuration of the allowed entities in the Entity Group.
    creation_time string
    The timestamp when the Entity Group was created.
    description string
    A user defined annotation for an Entity Group.
    except_configs list(object)
    Configuration of except entities in the Entity Group.
    ext_id 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.
    last_update_time string
    The timestamp when the Entity Group was last updated.
    links list(object)
    A HATEOAS style link for the response.
    name string
    A short identifier of an Entity Group.
    owner_ext_id string
    The external identifier of the user who created the Entity Group.
    policy_ext_ids list(string)
    Mapping of entity group to the list of policy external identifiers.
    tenant_id string
    A globally unique identifier that represents the tenant that owns this entity.
    allowedConfigs List<GetEntityGroupV2AllowedConfig>
    Configuration of the allowed entities in the Entity Group.
    creationTime String
    The timestamp when the Entity Group was created.
    description String
    A user defined annotation for an Entity Group.
    exceptConfigs List<GetEntityGroupV2ExceptConfig>
    Configuration of except entities in the Entity 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.
    lastUpdateTime String
    The timestamp when the Entity Group was last updated.
    links List<GetEntityGroupV2Link>
    A HATEOAS style link for the response.
    name String
    A short identifier of an Entity Group.
    ownerExtId String
    The external identifier of the user who created the Entity Group.
    policyExtIds List<String>
    Mapping of entity group to the list of policy external identifiers.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.
    allowedConfigs GetEntityGroupV2AllowedConfig[]
    Configuration of the allowed entities in the Entity Group.
    creationTime string
    The timestamp when the Entity Group was created.
    description string
    A user defined annotation for an Entity Group.
    exceptConfigs GetEntityGroupV2ExceptConfig[]
    Configuration of except entities in the Entity 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.
    lastUpdateTime string
    The timestamp when the Entity Group was last updated.
    links GetEntityGroupV2Link[]
    A HATEOAS style link for the response.
    name string
    A short identifier of an Entity Group.
    ownerExtId string
    The external identifier of the user who created the Entity Group.
    policyExtIds string[]
    Mapping of entity group to the list of policy external identifiers.
    tenantId string
    A globally unique identifier that represents the tenant that owns this entity.
    allowed_configs Sequence[GetEntityGroupV2AllowedConfig]
    Configuration of the allowed entities in the Entity Group.
    creation_time str
    The timestamp when the Entity Group was created.
    description str
    A user defined annotation for an Entity Group.
    except_configs Sequence[GetEntityGroupV2ExceptConfig]
    Configuration of except entities in the Entity 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.
    last_update_time str
    The timestamp when the Entity Group was last updated.
    links Sequence[GetEntityGroupV2Link]
    A HATEOAS style link for the response.
    name str
    A short identifier of an Entity Group.
    owner_ext_id str
    The external identifier of the user who created the Entity Group.
    policy_ext_ids Sequence[str]
    Mapping of entity group to the list of policy external identifiers.
    tenant_id str
    A globally unique identifier that represents the tenant that owns this entity.
    allowedConfigs List<Property Map>
    Configuration of the allowed entities in the Entity Group.
    creationTime String
    The timestamp when the Entity Group was created.
    description String
    A user defined annotation for an Entity Group.
    exceptConfigs List<Property Map>
    Configuration of except entities in the Entity 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.
    lastUpdateTime String
    The timestamp when the Entity Group was last updated.
    links List<Property Map>
    A HATEOAS style link for the response.
    name String
    A short identifier of an Entity Group.
    ownerExtId String
    The external identifier of the user who created the Entity Group.
    policyExtIds List<String>
    Mapping of entity group to the list of policy external identifiers.
    tenantId String
    A globally unique identifier that represents the tenant that owns this entity.

    Supporting Types

    GetEntityGroupV2AllowedConfig

    Entities []GetEntityGroupV2AllowedConfigEntity
    List of except entities. Each entity may contain:
    entities list(object)
    List of except entities. Each entity may contain:
    entities List<GetEntityGroupV2AllowedConfigEntity>
    List of except entities. Each entity may contain:
    entities GetEntityGroupV2AllowedConfigEntity[]
    List of except entities. Each entity may contain:
    entities Sequence[GetEntityGroupV2AllowedConfigEntity]
    List of except entities. Each entity may contain:
    entities List<Property Map>
    List of except entities. Each entity may contain:

    GetEntityGroupV2AllowedConfigEntity

    Addresses List<PiersKarsenbarg.Nutanix.Inputs.GetEntityGroupV2AllowedConfigEntityAddress>
    With ipv4Addresses (value, prefix_length).
    IpRanges List<PiersKarsenbarg.Nutanix.Inputs.GetEntityGroupV2AllowedConfigEntityIpRange>
    With ipv4Ranges (start_ip, end_ip).
    KubeEntities List<string>
    List of kube entities.
    ReferenceExtIds List<string>
    List of reference external identifiers.
    SelectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    Type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    Addresses []GetEntityGroupV2AllowedConfigEntityAddress
    With ipv4Addresses (value, prefix_length).
    IpRanges []GetEntityGroupV2AllowedConfigEntityIpRange
    With ipv4Ranges (start_ip, end_ip).
    KubeEntities []string
    List of kube entities.
    ReferenceExtIds []string
    List of reference external identifiers.
    SelectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    Type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses list(object)
    With ipv4Addresses (value, prefix_length).
    ip_ranges list(object)
    With ipv4Ranges (start_ip, end_ip).
    kube_entities list(string)
    List of kube entities.
    reference_ext_ids list(string)
    List of reference external identifiers.
    selected_by string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses List<GetEntityGroupV2AllowedConfigEntityAddress>
    With ipv4Addresses (value, prefix_length).
    ipRanges List<GetEntityGroupV2AllowedConfigEntityIpRange>
    With ipv4Ranges (start_ip, end_ip).
    kubeEntities List<String>
    List of kube entities.
    referenceExtIds List<String>
    List of reference external identifiers.
    selectedBy String
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type String
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses GetEntityGroupV2AllowedConfigEntityAddress[]
    With ipv4Addresses (value, prefix_length).
    ipRanges GetEntityGroupV2AllowedConfigEntityIpRange[]
    With ipv4Ranges (start_ip, end_ip).
    kubeEntities string[]
    List of kube entities.
    referenceExtIds string[]
    List of reference external identifiers.
    selectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses Sequence[GetEntityGroupV2AllowedConfigEntityAddress]
    With ipv4Addresses (value, prefix_length).
    ip_ranges Sequence[GetEntityGroupV2AllowedConfigEntityIpRange]
    With ipv4Ranges (start_ip, end_ip).
    kube_entities Sequence[str]
    List of kube entities.
    reference_ext_ids Sequence[str]
    List of reference external identifiers.
    selected_by str
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type str
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses List<Property Map>
    With ipv4Addresses (value, prefix_length).
    ipRanges List<Property Map>
    With ipv4Ranges (start_ip, end_ip).
    kubeEntities List<String>
    List of kube entities.
    referenceExtIds List<String>
    List of reference external identifiers.
    selectedBy String
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type String
    The type of entity (e.g. VM, ADDRESS_GROUP).

    GetEntityGroupV2AllowedConfigEntityAddress

    GetEntityGroupV2AllowedConfigEntityAddressIpv4Address

    prefix_length number
    value string
    prefixLength Integer
    value String
    prefixLength number
    value string
    prefixLength Number
    value String

    GetEntityGroupV2AllowedConfigEntityIpRange

    GetEntityGroupV2AllowedConfigEntityIpRangeIpv4Range

    EndIp string
    StartIp string
    EndIp string
    StartIp string
    end_ip string
    start_ip string
    endIp String
    startIp String
    endIp string
    startIp string
    endIp String
    startIp String

    GetEntityGroupV2ExceptConfig

    Entities []GetEntityGroupV2ExceptConfigEntity
    List of except entities. Each entity may contain:
    entities list(object)
    List of except entities. Each entity may contain:
    entities List<GetEntityGroupV2ExceptConfigEntity>
    List of except entities. Each entity may contain:
    entities GetEntityGroupV2ExceptConfigEntity[]
    List of except entities. Each entity may contain:
    entities Sequence[GetEntityGroupV2ExceptConfigEntity]
    List of except entities. Each entity may contain:
    entities List<Property Map>
    List of except entities. Each entity may contain:

    GetEntityGroupV2ExceptConfigEntity

    Addresses List<PiersKarsenbarg.Nutanix.Inputs.GetEntityGroupV2ExceptConfigEntityAddress>
    With ipv4Addresses (value, prefix_length).
    IpRanges List<PiersKarsenbarg.Nutanix.Inputs.GetEntityGroupV2ExceptConfigEntityIpRange>
    With ipv4Ranges (start_ip, end_ip).
    ReferenceExtIds List<string>
    List of reference external identifiers.
    SelectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    Type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    Addresses []GetEntityGroupV2ExceptConfigEntityAddress
    With ipv4Addresses (value, prefix_length).
    IpRanges []GetEntityGroupV2ExceptConfigEntityIpRange
    With ipv4Ranges (start_ip, end_ip).
    ReferenceExtIds []string
    List of reference external identifiers.
    SelectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    Type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses list(object)
    With ipv4Addresses (value, prefix_length).
    ip_ranges list(object)
    With ipv4Ranges (start_ip, end_ip).
    reference_ext_ids list(string)
    List of reference external identifiers.
    selected_by string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses List<GetEntityGroupV2ExceptConfigEntityAddress>
    With ipv4Addresses (value, prefix_length).
    ipRanges List<GetEntityGroupV2ExceptConfigEntityIpRange>
    With ipv4Ranges (start_ip, end_ip).
    referenceExtIds List<String>
    List of reference external identifiers.
    selectedBy String
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type String
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses GetEntityGroupV2ExceptConfigEntityAddress[]
    With ipv4Addresses (value, prefix_length).
    ipRanges GetEntityGroupV2ExceptConfigEntityIpRange[]
    With ipv4Ranges (start_ip, end_ip).
    referenceExtIds string[]
    List of reference external identifiers.
    selectedBy string
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type string
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses Sequence[GetEntityGroupV2ExceptConfigEntityAddress]
    With ipv4Addresses (value, prefix_length).
    ip_ranges Sequence[GetEntityGroupV2ExceptConfigEntityIpRange]
    With ipv4Ranges (start_ip, end_ip).
    reference_ext_ids Sequence[str]
    List of reference external identifiers.
    selected_by str
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type str
    The type of entity (e.g. VM, ADDRESS_GROUP).
    addresses List<Property Map>
    With ipv4Addresses (value, prefix_length).
    ipRanges List<Property Map>
    With ipv4Ranges (start_ip, end_ip).
    referenceExtIds List<String>
    List of reference external identifiers.
    selectedBy String
    The selection method (e.g. CATEGORY_EXT_ID, IP_VALUES).
    type String
    The type of entity (e.g. VM, ADDRESS_GROUP).

    GetEntityGroupV2ExceptConfigEntityAddress

    GetEntityGroupV2ExceptConfigEntityAddressIpv4Address

    prefix_length number
    value string
    prefixLength Integer
    value String
    prefixLength number
    value string
    prefixLength Number
    value String

    GetEntityGroupV2ExceptConfigEntityIpRange

    GetEntityGroupV2ExceptConfigEntityIpRangeIpv4Range

    EndIp string
    StartIp string
    EndIp string
    StartIp string
    end_ip string
    start_ip string
    endIp String
    startIp String
    endIp string
    startIp string
    endIp String
    startIp String
    Href string
    Rel string
    Href string
    Rel string
    href string
    rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.16.0
    published on Tuesday, May 26, 2026 by Piers Karsenbarg

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial