Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. CategoryV2
Nutanix v0.7.3 published on Thursday, Mar 13, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.CategoryV2

Explore with Pulumi AI

Nutanix v0.7.3 published on Thursday, Mar 13, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

Fetch a category

Example

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

const example = new nutanix.CategoryV2("example", {
    description: "category example description",
    key: "category_example_key",
    value: "category_example_value",
});
Copy
import pulumi
import pulumi_nutanix as nutanix

example = nutanix.CategoryV2("example",
    description="category example description",
    key="category_example_key",
    value="category_example_value")
Copy
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.NewCategoryV2(ctx, "example", &nutanix.CategoryV2Args{
			Description: pulumi.String("category example description"),
			Key:         pulumi.String("category_example_key"),
			Value:       pulumi.String("category_example_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;

return await Deployment.RunAsync(() => 
{
    var example = new Nutanix.CategoryV2("example", new()
    {
        Description = "category example description",
        Key = "category_example_key",
        Value = "category_example_value",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.CategoryV2;
import com.pulumi.nutanix.CategoryV2Args;
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 example = new CategoryV2("example", CategoryV2Args.builder()
            .description("category example description")
            .key("category_example_key")
            .value("category_example_value")
            .build());

    }
}
Copy
resources:
  example:
    type: nutanix:CategoryV2
    properties:
      description: category example description
      key: category_example_key
      value: category_example_value
Copy

Create CategoryV2 Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CategoryV2(name: string, args: CategoryV2Args, opts?: CustomResourceOptions);
@overload
def CategoryV2(resource_name: str,
               args: CategoryV2Args,
               opts: Optional[ResourceOptions] = None)

@overload
def CategoryV2(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               key: Optional[str] = None,
               value: Optional[str] = None,
               description: Optional[str] = None,
               owner_uuid: Optional[str] = None,
               type: Optional[str] = None)
func NewCategoryV2(ctx *Context, name string, args CategoryV2Args, opts ...ResourceOption) (*CategoryV2, error)
public CategoryV2(string name, CategoryV2Args args, CustomResourceOptions? opts = null)
public CategoryV2(String name, CategoryV2Args args)
public CategoryV2(String name, CategoryV2Args args, CustomResourceOptions options)

type: nutanix:CategoryV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CategoryV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CategoryV2Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CategoryV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CategoryV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CategoryV2Args
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var categoryV2Resource = new Nutanix.CategoryV2("categoryV2Resource", new()
{
    Key = "string",
    Value = "string",
    Description = "string",
    OwnerUuid = "string",
    Type = "string",
});
Copy
example, err := nutanix.NewCategoryV2(ctx, "categoryV2Resource", &nutanix.CategoryV2Args{
	Key:         pulumi.String("string"),
	Value:       pulumi.String("string"),
	Description: pulumi.String("string"),
	OwnerUuid:   pulumi.String("string"),
	Type:        pulumi.String("string"),
})
Copy
var categoryV2Resource = new CategoryV2("categoryV2Resource", CategoryV2Args.builder()
    .key("string")
    .value("string")
    .description("string")
    .ownerUuid("string")
    .type("string")
    .build());
Copy
category_v2_resource = nutanix.CategoryV2("categoryV2Resource",
    key="string",
    value="string",
    description="string",
    owner_uuid="string",
    type="string")
Copy
const categoryV2Resource = new nutanix.CategoryV2("categoryV2Resource", {
    key: "string",
    value: "string",
    description: "string",
    ownerUuid: "string",
    type: "string",
});
Copy
type: nutanix:CategoryV2
properties:
    description: string
    key: string
    ownerUuid: string
    type: string
    value: string
Copy

CategoryV2 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CategoryV2 resource accepts the following input properties:

Key This property is required. string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

Value This property is required. string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

Description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
OwnerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
Type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
Key This property is required. string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

Value This property is required. string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

Description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
OwnerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
Type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
key This property is required. String

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

value This property is required. String

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

description String
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
ownerUuid String
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type String
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
key This property is required. string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

value This property is required. string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
ownerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
key This property is required. str

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

value This property is required. str

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

description str
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
owner_uuid str
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type str
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
key This property is required. String

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

value This property is required. String

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

description String
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
ownerUuid String
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type String
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.

Outputs

All input properties are implicitly available as output properties. Additionally, the CategoryV2 resource produces the following output properties:

Associations List<PiersKarsenbarg.Nutanix.Outputs.CategoryV2Association>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
DetailedAssociations List<PiersKarsenbarg.Nutanix.Outputs.CategoryV2DetailedAssociation>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
Id string
The provider-assigned unique ID for this managed resource.
Associations []CategoryV2Association
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
DetailedAssociations []CategoryV2DetailedAssociation
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
Id string
The provider-assigned unique ID for this managed resource.
associations List<CategoryV2Association>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
detailedAssociations List<CategoryV2DetailedAssociation>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
id String
The provider-assigned unique ID for this managed resource.
associations CategoryV2Association[]
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
detailedAssociations CategoryV2DetailedAssociation[]
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
id string
The provider-assigned unique ID for this managed resource.
associations Sequence[CategoryV2Association]
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
detailed_associations Sequence[CategoryV2DetailedAssociation]
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
id str
The provider-assigned unique ID for this managed resource.
associations List<Property Map>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
detailedAssociations List<Property Map>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing CategoryV2 Resource

Get an existing CategoryV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CategoryV2State, opts?: CustomResourceOptions): CategoryV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associations: Optional[Sequence[CategoryV2AssociationArgs]] = None,
        description: Optional[str] = None,
        detailed_associations: Optional[Sequence[CategoryV2DetailedAssociationArgs]] = None,
        key: Optional[str] = None,
        owner_uuid: Optional[str] = None,
        type: Optional[str] = None,
        value: Optional[str] = None) -> CategoryV2
func GetCategoryV2(ctx *Context, name string, id IDInput, state *CategoryV2State, opts ...ResourceOption) (*CategoryV2, error)
public static CategoryV2 Get(string name, Input<string> id, CategoryV2State? state, CustomResourceOptions? opts = null)
public static CategoryV2 get(String name, Output<String> id, CategoryV2State state, CustomResourceOptions options)
resources:  _:    type: nutanix:CategoryV2    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Associations List<PiersKarsenbarg.Nutanix.Inputs.CategoryV2Association>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
Description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
DetailedAssociations List<PiersKarsenbarg.Nutanix.Inputs.CategoryV2DetailedAssociation>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
Key string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

OwnerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
Type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
Value string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

Associations []CategoryV2AssociationArgs
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
Description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
DetailedAssociations []CategoryV2DetailedAssociationArgs
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
Key string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

OwnerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
Type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
Value string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

associations List<CategoryV2Association>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
description String
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
detailedAssociations List<CategoryV2DetailedAssociation>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
key String

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

ownerUuid String
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type String
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
value String

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

associations CategoryV2Association[]
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
description string
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
detailedAssociations CategoryV2DetailedAssociation[]
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
key string

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

ownerUuid string
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type string
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
value string

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

associations Sequence[CategoryV2AssociationArgs]
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
description str
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
detailed_associations Sequence[CategoryV2DetailedAssociationArgs]
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
key str

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

owner_uuid str
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type str
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
value str

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

associations List<Property Map>
This field gives basic information about resources that are associated with the category. The results present under this field summarize the counts of various kinds of resources associated with the category. For more detailed information about the UUIDs of the resources, please look into the field detailedAssociations. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories API, unless the parameter $expand=associations is present in the URL.
description String
-(Optional) A string consisting of the description of the category as defined by the user. Description can be optionally provided in the payload of createCategory and updateCategoryById APIs. Description field can be updated through updateCategoryById API. The server does not validate this value nor does it enforce the uniqueness or any other constraints. It is the responsibility of the user to ensure that any semantic or syntactic constraints are retained when mutating this field.
detailedAssociations List<Property Map>
This field gives detailed information about the resources which are associated with the category. The results present under this field contain the UUIDs of the entities and policies of various kinds associated with the category. This field will be ignored, if given in the payload of updateCategoryById or createCategory APIs. This field will not be present by default in listCategories or getCategoryById APIs, unless the parameter $expand=detailedAssociations is present in the URL.
key String

-(Required) The key of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API.

ownerUuid String
-(Optional) This field contains the UUID of a user who owns the category. This field will be ignored if given in the payload of createCategory API. Hence, when a category is created, the logged-in user automatically becomes the owner of the category. This field can be updated through updateCategoryById API, in which case, should be provided, UUID of a valid user is present in the system. Validity of the user UUID can be checked by invoking the API: authn/users/{extId} in the 'Identity and Access Management' or 'IAM' namespace. It is used for enabling RBAC access to self-owned categories.
type String
-(Required) Denotes the type of a category. Valid values are:

  • SYSTEM Predefined categories contained in the system to be used by workflows visible in the UI that involve categories. System-defined categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. System-defined categories can't be updated or deleted.
  • INTERNAL Predefined categories contained in the system to be used by internal services, APIs and workflows that involve categories. These categories will not be visible in the UI. However, these categories will be returned in the response of listCategories and getCategoryById APIs, and are available for filtering as well. Internal categories can't be created through the Categories API. They are predefined in a configuration file and are created at PC boot-up time. Internal categories can't be updated or deleted.
  • USER These categories get created by users through the invocation of createCategory API. User-defined categories can be updated or deleted after creation.
value String

-(Required) The value of a category when it is represented in key:value format. Constraints applicable when field is given in the payload during create and update:

  • A string of maxlength of 64
  • Character at the start cannot be $
  • Character / is not allowed anywhere.

It is a mandatory field in the payload of createCategory and updateCategoryById APIs. This field can't be updated through updateCategoryById API. Updating the value will not change the extId of the category.

Supporting Types

CategoryV2Association
, CategoryV2AssociationArgs

CategoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
Count string
Count of associations of a particular type of entity or policy
ResourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
ResourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
CategoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
Count string
Count of associations of a particular type of entity or policy
ResourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
ResourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count String
Count of associations of a particular type of entity or policy
resourceGroup String
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceType String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count string
Count of associations of a particular type of entity or policy
resourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
category_id str
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count str
Count of associations of a particular type of entity or policy
resource_group str
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resource_type str
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
count String
Count of associations of a particular type of entity or policy
resourceGroup String
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceType String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.

CategoryV2DetailedAssociation
, CategoryV2DetailedAssociationArgs

CategoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
ResourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
ResourceId string
The UUID of the entity or policy associated with the particular category.
ResourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
CategoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
ResourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
ResourceId string
The UUID of the entity or policy associated with the particular category.
ResourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup String
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceId String
The UUID of the entity or policy associated with the particular category.
resourceType String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId string
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup string
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceId string
The UUID of the entity or policy associated with the particular category.
resourceType string
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
category_id str
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resource_group str
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resource_id str
The UUID of the entity or policy associated with the particular category.
resource_type str
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.
categoryId String
External identifier for the given category, used across all v4 apis/entities/resources where categories are referenced.
resourceGroup String
An enum denoting the resource group. Resources can be organized into either an entity or a policy. Valid values are:

  • POLICY: A ResourceGroup denoting a nutanix policy like VM host affinity policy, image placement policy, access control policy, and so on. A category is generally associated with many entities. The policy which is associated with this category, is then applied to those entities which are also associated with the same category.
  • ENTITY: A ResourceGroup denoting a nutanix entity like VM, cluster, host, image, and so on. A category is generally associated with many entities. A policy is then applied to these entities through the category.
resourceId String
The UUID of the entity or policy associated with the particular category.
resourceType String
An enum denoting the associated resource types. Resource types are further grouped into 2 types - entity or a policy. Valid values are:

  • APP: A resource of type application.
  • PROTECTION_RULE: A policy or rule of type protection rule.
  • IMAGE_RATE_LIMIT: A resource of type rate limit.
  • MH_VM: A resource of type Virtual Machine.
  • BLUEPRINT: A resource of type blueprint.
  • HOST: A resource representing the underlying host, the machine hosting the hypervisors and VMs.
  • IMAGE: A resource of type image.
  • VM_VM_ANTI_AFFINITY_POLICY: A policy of type VM-VM anti-affinity; This policy decides that the specified set of VMs are running on different hosts.
  • ACCESS_CONTROL_POLICY: A policy or rule of type access control policy or ACP; the rules that decide authorization of users to access an API.
  • VM_HOST_AFFINITY_POLICY: A policy of type VM host affinity; The policy decides the affinity between a set of VMs to be run only a specified set of hosts
  • NGT_POLICY: A policy or rule of type NGT policy.
  • RECOVERY_PLAN: A policy or rule of type recovery plan.
  • MARKETPLACE_ITEM: A resource of type marketplace item.
  • CLUSTER: A resource of type cluster, usually refers to a PE cluster.
  • NETWORK_SECURITY_RULE: A rule of type network security.
  • HOST_NIC: A resource of type Physical NIC.
  • ACTION_RULE: A policy of type Playbook.
  • VOLUMEGROUP: A resource of type volume group.
  • REPORT: A resource of type report.
  • STORAGE_POLICY: A policy or rule of type storage policy.
  • BUNDLE: A resource of type bundle.
  • QOS_POLICY: A policy or rule of type QoS policy.
  • SUBNET: A resource of type network subnets.
  • VM: A resource of type Virtual Machine.
  • NETWORK_SECURITY_POLICY: A policy of type network security.
  • POLICY_SCHEMA: Policies like user-defined-alerts.
  • IMAGE_PLACEMENT_POLICY: A policy of type image placement.

Package Details

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