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

nutanix.NgtUpgradeV2

Explore with Pulumi AI

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

Provides Nutanix resource to Trigger an in-guest upgrade of Nutanix Guest Tools.

Create NgtUpgradeV2 Resource

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

Constructor syntax

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

@overload
def NgtUpgradeV2(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 ext_id: Optional[str] = None,
                 reboot_preference: Optional[NgtUpgradeV2RebootPreferenceArgs] = None)
func NewNgtUpgradeV2(ctx *Context, name string, args NgtUpgradeV2Args, opts ...ResourceOption) (*NgtUpgradeV2, error)
public NgtUpgradeV2(string name, NgtUpgradeV2Args args, CustomResourceOptions? opts = null)
public NgtUpgradeV2(String name, NgtUpgradeV2Args args)
public NgtUpgradeV2(String name, NgtUpgradeV2Args args, CustomResourceOptions options)

type: nutanix:NgtUpgradeV2
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. NgtUpgradeV2Args
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. NgtUpgradeV2Args
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. NgtUpgradeV2Args
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. NgtUpgradeV2Args
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. NgtUpgradeV2Args
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 ngtUpgradeV2Resource = new Nutanix.NgtUpgradeV2("ngtUpgradeV2Resource", new()
{
    ExtId = "string",
    RebootPreference = new Nutanix.Inputs.NgtUpgradeV2RebootPreferenceArgs
    {
        ScheduleType = "string",
        Schedule = new Nutanix.Inputs.NgtUpgradeV2RebootPreferenceScheduleArgs
        {
            StartTime = "string",
        },
    },
});
Copy
example, err := nutanix.NewNgtUpgradeV2(ctx, "ngtUpgradeV2Resource", &nutanix.NgtUpgradeV2Args{
	ExtId: pulumi.String("string"),
	RebootPreference: &nutanix.NgtUpgradeV2RebootPreferenceArgs{
		ScheduleType: pulumi.String("string"),
		Schedule: &nutanix.NgtUpgradeV2RebootPreferenceScheduleArgs{
			StartTime: pulumi.String("string"),
		},
	},
})
Copy
var ngtUpgradeV2Resource = new NgtUpgradeV2("ngtUpgradeV2Resource", NgtUpgradeV2Args.builder()
    .extId("string")
    .rebootPreference(NgtUpgradeV2RebootPreferenceArgs.builder()
        .scheduleType("string")
        .schedule(NgtUpgradeV2RebootPreferenceScheduleArgs.builder()
            .startTime("string")
            .build())
        .build())
    .build());
Copy
ngt_upgrade_v2_resource = nutanix.NgtUpgradeV2("ngtUpgradeV2Resource",
    ext_id="string",
    reboot_preference={
        "schedule_type": "string",
        "schedule": {
            "start_time": "string",
        },
    })
Copy
const ngtUpgradeV2Resource = new nutanix.NgtUpgradeV2("ngtUpgradeV2Resource", {
    extId: "string",
    rebootPreference: {
        scheduleType: "string",
        schedule: {
            startTime: "string",
        },
    },
});
Copy
type: nutanix:NgtUpgradeV2
properties:
    extId: string
    rebootPreference:
        schedule:
            startTime: string
        scheduleType: string
Copy

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

ExtId This property is required. string
uuid of the Virtual Machine.
RebootPreference PiersKarsenbarg.Nutanix.Inputs.NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
ExtId This property is required. string
uuid of the Virtual Machine.
RebootPreference NgtUpgradeV2RebootPreferenceArgs
The restart schedule after installing or upgrading Nutanix Guest Tools.
extId This property is required. String
uuid of the Virtual Machine.
rebootPreference NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
extId This property is required. string
uuid of the Virtual Machine.
rebootPreference NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
ext_id This property is required. str
uuid of the Virtual Machine.
reboot_preference NgtUpgradeV2RebootPreferenceArgs
The restart schedule after installing or upgrading Nutanix Guest Tools.
extId This property is required. String
uuid of the Virtual Machine.
rebootPreference Property Map
The restart schedule after installing or upgrading Nutanix Guest Tools.

Outputs

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

AvailableVersion string
Version of Nutanix Guest Tools available on the cluster.
Capablities List<string>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
GuestOsVersion string
Version of the operating system on the VM.
Id string
The provider-assigned unique ID for this managed resource.
IsEnabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
IsInstalled bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
IsIsoInserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
IsReachable bool
Indicates whether the communication from VM to CVM is active or not.
IsVmMobilityDriversInstalled bool
Indicates whether the VM mobility drivers are installed on the VM or not.
IsVssSnapshotCapable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
Version string
Version of Nutanix Guest Tools installed on the VM.
AvailableVersion string
Version of Nutanix Guest Tools available on the cluster.
Capablities []string
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
GuestOsVersion string
Version of the operating system on the VM.
Id string
The provider-assigned unique ID for this managed resource.
IsEnabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
IsInstalled bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
IsIsoInserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
IsReachable bool
Indicates whether the communication from VM to CVM is active or not.
IsVmMobilityDriversInstalled bool
Indicates whether the VM mobility drivers are installed on the VM or not.
IsVssSnapshotCapable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
Version string
Version of Nutanix Guest Tools installed on the VM.
availableVersion String
Version of Nutanix Guest Tools available on the cluster.
capablities List<String>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
guestOsVersion String
Version of the operating system on the VM.
id String
The provider-assigned unique ID for this managed resource.
isEnabled Boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled Boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted Boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable Boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled Boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable Boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
version String
Version of Nutanix Guest Tools installed on the VM.
availableVersion string
Version of Nutanix Guest Tools available on the cluster.
capablities string[]
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
guestOsVersion string
Version of the operating system on the VM.
id string
The provider-assigned unique ID for this managed resource.
isEnabled boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
version string
Version of Nutanix Guest Tools installed on the VM.
available_version str
Version of Nutanix Guest Tools available on the cluster.
capablities Sequence[str]
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
guest_os_version str
Version of the operating system on the VM.
id str
The provider-assigned unique ID for this managed resource.
is_enabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
is_installed bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
is_iso_inserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
is_reachable bool
Indicates whether the communication from VM to CVM is active or not.
is_vm_mobility_drivers_installed bool
Indicates whether the VM mobility drivers are installed on the VM or not.
is_vss_snapshot_capable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
version str
Version of Nutanix Guest Tools installed on the VM.
availableVersion String
Version of Nutanix Guest Tools available on the cluster.
capablities List<String>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
guestOsVersion String
Version of the operating system on the VM.
id String
The provider-assigned unique ID for this managed resource.
isEnabled Boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled Boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted Boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable Boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled Boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable Boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
version String
Version of Nutanix Guest Tools installed on the VM.

Look up Existing NgtUpgradeV2 Resource

Get an existing NgtUpgradeV2 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?: NgtUpgradeV2State, opts?: CustomResourceOptions): NgtUpgradeV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        available_version: Optional[str] = None,
        capablities: Optional[Sequence[str]] = None,
        ext_id: Optional[str] = None,
        guest_os_version: Optional[str] = None,
        is_enabled: Optional[bool] = None,
        is_installed: Optional[bool] = None,
        is_iso_inserted: Optional[bool] = None,
        is_reachable: Optional[bool] = None,
        is_vm_mobility_drivers_installed: Optional[bool] = None,
        is_vss_snapshot_capable: Optional[bool] = None,
        reboot_preference: Optional[NgtUpgradeV2RebootPreferenceArgs] = None,
        version: Optional[str] = None) -> NgtUpgradeV2
func GetNgtUpgradeV2(ctx *Context, name string, id IDInput, state *NgtUpgradeV2State, opts ...ResourceOption) (*NgtUpgradeV2, error)
public static NgtUpgradeV2 Get(string name, Input<string> id, NgtUpgradeV2State? state, CustomResourceOptions? opts = null)
public static NgtUpgradeV2 get(String name, Output<String> id, NgtUpgradeV2State state, CustomResourceOptions options)
resources:  _:    type: nutanix:NgtUpgradeV2    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:
AvailableVersion string
Version of Nutanix Guest Tools available on the cluster.
Capablities List<string>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
ExtId string
uuid of the Virtual Machine.
GuestOsVersion string
Version of the operating system on the VM.
IsEnabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
IsInstalled bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
IsIsoInserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
IsReachable bool
Indicates whether the communication from VM to CVM is active or not.
IsVmMobilityDriversInstalled bool
Indicates whether the VM mobility drivers are installed on the VM or not.
IsVssSnapshotCapable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
RebootPreference PiersKarsenbarg.Nutanix.Inputs.NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
Version string
Version of Nutanix Guest Tools installed on the VM.
AvailableVersion string
Version of Nutanix Guest Tools available on the cluster.
Capablities []string
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
ExtId string
uuid of the Virtual Machine.
GuestOsVersion string
Version of the operating system on the VM.
IsEnabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
IsInstalled bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
IsIsoInserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
IsReachable bool
Indicates whether the communication from VM to CVM is active or not.
IsVmMobilityDriversInstalled bool
Indicates whether the VM mobility drivers are installed on the VM or not.
IsVssSnapshotCapable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
RebootPreference NgtUpgradeV2RebootPreferenceArgs
The restart schedule after installing or upgrading Nutanix Guest Tools.
Version string
Version of Nutanix Guest Tools installed on the VM.
availableVersion String
Version of Nutanix Guest Tools available on the cluster.
capablities List<String>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
extId String
uuid of the Virtual Machine.
guestOsVersion String
Version of the operating system on the VM.
isEnabled Boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled Boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted Boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable Boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled Boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable Boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
rebootPreference NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
version String
Version of Nutanix Guest Tools installed on the VM.
availableVersion string
Version of Nutanix Guest Tools available on the cluster.
capablities string[]
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
extId string
uuid of the Virtual Machine.
guestOsVersion string
Version of the operating system on the VM.
isEnabled boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
rebootPreference NgtUpgradeV2RebootPreference
The restart schedule after installing or upgrading Nutanix Guest Tools.
version string
Version of Nutanix Guest Tools installed on the VM.
available_version str
Version of Nutanix Guest Tools available on the cluster.
capablities Sequence[str]
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
ext_id str
uuid of the Virtual Machine.
guest_os_version str
Version of the operating system on the VM.
is_enabled bool
Indicates whether Nutanix Guest Tools is enabled or not.
is_installed bool
Indicates whether Nutanix Guest Tools is installed on the VM or not.
is_iso_inserted bool
Indicates whether Nutanix Guest Tools ISO is inserted or not.
is_reachable bool
Indicates whether the communication from VM to CVM is active or not.
is_vm_mobility_drivers_installed bool
Indicates whether the VM mobility drivers are installed on the VM or not.
is_vss_snapshot_capable bool
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
reboot_preference NgtUpgradeV2RebootPreferenceArgs
The restart schedule after installing or upgrading Nutanix Guest Tools.
version str
Version of Nutanix Guest Tools installed on the VM.
availableVersion String
Version of Nutanix Guest Tools available on the cluster.
capablities List<String>
The list of the application names that are enabled on the guest VM. [SELF_SERVICE_RESTORE, VSS_SNAPSHOT]
extId String
uuid of the Virtual Machine.
guestOsVersion String
Version of the operating system on the VM.
isEnabled Boolean
Indicates whether Nutanix Guest Tools is enabled or not.
isInstalled Boolean
Indicates whether Nutanix Guest Tools is installed on the VM or not.
isIsoInserted Boolean
Indicates whether Nutanix Guest Tools ISO is inserted or not.
isReachable Boolean
Indicates whether the communication from VM to CVM is active or not.
isVmMobilityDriversInstalled Boolean
Indicates whether the VM mobility drivers are installed on the VM or not.
isVssSnapshotCapable Boolean
Indicates whether the VM is configured to take VSS snapshots through NGT or not.
rebootPreference Property Map
The restart schedule after installing or upgrading Nutanix Guest Tools.
version String
Version of Nutanix Guest Tools installed on the VM.

Supporting Types

NgtUpgradeV2RebootPreference
, NgtUpgradeV2RebootPreferenceArgs

ScheduleType This property is required. string
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
Schedule PiersKarsenbarg.Nutanix.Inputs.NgtUpgradeV2RebootPreferenceSchedule
  • Restart schedule.
ScheduleType This property is required. string
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
Schedule NgtUpgradeV2RebootPreferenceSchedule
  • Restart schedule.
scheduleType This property is required. String
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
schedule NgtUpgradeV2RebootPreferenceSchedule
  • Restart schedule.
scheduleType This property is required. string
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
schedule NgtUpgradeV2RebootPreferenceSchedule
  • Restart schedule.
schedule_type This property is required. str
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
schedule NgtUpgradeV2RebootPreferenceSchedule
  • Restart schedule.
scheduleType This property is required. String
  • Schedule type for restart.
  • LATER : Schedule a restart for a specific time.
  • SKIP : Do not schedule a restart.
  • IMMEDIATE : Schedule an immediate restart.
schedule Property Map
  • Restart schedule.

NgtUpgradeV2RebootPreferenceSchedule
, NgtUpgradeV2RebootPreferenceScheduleArgs

StartTime This property is required. string
  • The start time for a scheduled restart.
StartTime This property is required. string
  • The start time for a scheduled restart.
startTime This property is required. String
  • The start time for a scheduled restart.
startTime This property is required. string
  • The start time for a scheduled restart.
start_time This property is required. str
  • The start time for a scheduled restart.
startTime This property is required. String
  • The start time for a scheduled restart.

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.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix