1. Packages
  2. Nutanix
  3. API Docs
  4. TemplateGuestOsActionsV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.TemplateGuestOsActionsV2

Explore with Pulumi AI

Performs Guest OS actions on given template. It Initiates, Completes and Cancels the Guest OS operation.

Create TemplateGuestOsActionsV2 Resource

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

Constructor syntax

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

@overload
def TemplateGuestOsActionsV2(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             action: Optional[str] = None,
                             ext_id: Optional[str] = None,
                             is_active_version: Optional[str] = None,
                             version_description: Optional[str] = None,
                             version_id: Optional[str] = None,
                             version_name: Optional[str] = None)
func NewTemplateGuestOsActionsV2(ctx *Context, name string, args TemplateGuestOsActionsV2Args, opts ...ResourceOption) (*TemplateGuestOsActionsV2, error)
public TemplateGuestOsActionsV2(string name, TemplateGuestOsActionsV2Args args, CustomResourceOptions? opts = null)
public TemplateGuestOsActionsV2(String name, TemplateGuestOsActionsV2Args args)
public TemplateGuestOsActionsV2(String name, TemplateGuestOsActionsV2Args args, CustomResourceOptions options)
type: nutanix:TemplateGuestOsActionsV2
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. TemplateGuestOsActionsV2Args
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. TemplateGuestOsActionsV2Args
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. TemplateGuestOsActionsV2Args
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. TemplateGuestOsActionsV2Args
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. TemplateGuestOsActionsV2Args
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 templateGuestOsActionsV2Resource = new Nutanix.TemplateGuestOsActionsV2("templateGuestOsActionsV2Resource", new()
{
    Action = "string",
    ExtId = "string",
    IsActiveVersion = "string",
    VersionDescription = "string",
    VersionId = "string",
    VersionName = "string",
});
Copy
example, err := nutanix.NewTemplateGuestOsActionsV2(ctx, "templateGuestOsActionsV2Resource", &nutanix.TemplateGuestOsActionsV2Args{
	Action:             pulumi.String("string"),
	ExtId:              pulumi.String("string"),
	IsActiveVersion:    pulumi.String("string"),
	VersionDescription: pulumi.String("string"),
	VersionId:          pulumi.String("string"),
	VersionName:        pulumi.String("string"),
})
Copy
var templateGuestOsActionsV2Resource = new TemplateGuestOsActionsV2("templateGuestOsActionsV2Resource", TemplateGuestOsActionsV2Args.builder()
    .action("string")
    .extId("string")
    .isActiveVersion("string")
    .versionDescription("string")
    .versionId("string")
    .versionName("string")
    .build());
Copy
template_guest_os_actions_v2_resource = nutanix.TemplateGuestOsActionsV2("templateGuestOsActionsV2Resource",
    action="string",
    ext_id="string",
    is_active_version="string",
    version_description="string",
    version_id="string",
    version_name="string")
Copy
const templateGuestOsActionsV2Resource = new nutanix.TemplateGuestOsActionsV2("templateGuestOsActionsV2Resource", {
    action: "string",
    extId: "string",
    isActiveVersion: "string",
    versionDescription: "string",
    versionId: "string",
    versionName: "string",
});
Copy
type: nutanix:TemplateGuestOsActionsV2
properties:
    action: string
    extId: string
    isActiveVersion: string
    versionDescription: string
    versionId: string
    versionName: string
Copy

TemplateGuestOsActionsV2 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 TemplateGuestOsActionsV2 resource accepts the following input properties:

Action This property is required. string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ExtId This property is required. string
The identifier of a Template.
IsActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

VersionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
VersionId string
The identifier of a Template Version. Only applicable with Initiate action.
VersionName string
The user defined name of a Template Version. Only applicable with complete action.
Action This property is required. string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ExtId This property is required. string
The identifier of a Template.
IsActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

VersionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
VersionId string
The identifier of a Template Version. Only applicable with Initiate action.
VersionName string
The user defined name of a Template Version. Only applicable with complete action.
action This property is required. String
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId This property is required. String
The identifier of a Template.
isActiveVersion String

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription String
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId String
The identifier of a Template Version. Only applicable with Initiate action.
versionName String
The user defined name of a Template Version. Only applicable with complete action.
action This property is required. string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId This property is required. string
The identifier of a Template.
isActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId string
The identifier of a Template Version. Only applicable with Initiate action.
versionName string
The user defined name of a Template Version. Only applicable with complete action.
action This property is required. str
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ext_id This property is required. str
The identifier of a Template.
is_active_version str

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

version_description str
The user defined description of a Template Version. (Required) Only applicable with complete action.
version_id str
The identifier of a Template Version. Only applicable with Initiate action.
version_name str
The user defined name of a Template Version. Only applicable with complete action.
action This property is required. String
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId This property is required. String
The identifier of a Template.
isActiveVersion String

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription String
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId String
The identifier of a Template Version. Only applicable with Initiate action.
versionName String
The user defined name of a Template Version. Only applicable with complete action.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TemplateGuestOsActionsV2 Resource

Get an existing TemplateGuestOsActionsV2 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?: TemplateGuestOsActionsV2State, opts?: CustomResourceOptions): TemplateGuestOsActionsV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        ext_id: Optional[str] = None,
        is_active_version: Optional[str] = None,
        version_description: Optional[str] = None,
        version_id: Optional[str] = None,
        version_name: Optional[str] = None) -> TemplateGuestOsActionsV2
func GetTemplateGuestOsActionsV2(ctx *Context, name string, id IDInput, state *TemplateGuestOsActionsV2State, opts ...ResourceOption) (*TemplateGuestOsActionsV2, error)
public static TemplateGuestOsActionsV2 Get(string name, Input<string> id, TemplateGuestOsActionsV2State? state, CustomResourceOptions? opts = null)
public static TemplateGuestOsActionsV2 get(String name, Output<String> id, TemplateGuestOsActionsV2State state, CustomResourceOptions options)
resources:  _:    type: nutanix:TemplateGuestOsActionsV2    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:
Action string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ExtId string
The identifier of a Template.
IsActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

VersionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
VersionId string
The identifier of a Template Version. Only applicable with Initiate action.
VersionName string
The user defined name of a Template Version. Only applicable with complete action.
Action string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ExtId string
The identifier of a Template.
IsActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

VersionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
VersionId string
The identifier of a Template Version. Only applicable with Initiate action.
VersionName string
The user defined name of a Template Version. Only applicable with complete action.
action String
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId String
The identifier of a Template.
isActiveVersion String

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription String
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId String
The identifier of a Template Version. Only applicable with Initiate action.
versionName String
The user defined name of a Template Version. Only applicable with complete action.
action string
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId string
The identifier of a Template.
isActiveVersion string

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription string
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId string
The identifier of a Template Version. Only applicable with Initiate action.
versionName string
The user defined name of a Template Version. Only applicable with complete action.
action str
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
ext_id str
The identifier of a Template.
is_active_version str

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

version_description str
The user defined description of a Template Version. (Required) Only applicable with complete action.
version_id str
The identifier of a Template Version. Only applicable with Initiate action.
version_name str
The user defined name of a Template Version. Only applicable with complete action.
action String
Actions to be performed. Acceptable values are "initiate", "complete", "cancel" .
extId String
The identifier of a Template.
isActiveVersion String

Specify whether to mark the Template Version as active or not. The newly created Version during Template Creation, Updating or Guest OS Updating is set to Active by default unless specified otherwise. Default is true. Only applicable with complete action.

See detailed information in Nutanix Template Guest OS Action V4.

versionDescription String
The user defined description of a Template Version. (Required) Only applicable with complete action.
versionId String
The identifier of a Template Version. Only applicable with Initiate action.
versionName String
The user defined name of a Template Version. Only applicable with complete action.

Package Details

Repository
nutanix pierskarsenbarg/pulumi-nutanix
License
Apache-2.0
Notes
This Pulumi package is based on the nutanix Terraform Provider.