Blog Author
Do you know, you can interact with Nutanix cluster ( AHV , ESXi, Hyper-v ) via many interfaces i.e Prism web console, HTML5 UI, REST API, nCLI and Powershell CMDlets or Command-lets. Nutanix CMDlets Refference also known as Command-lets is very useful and powerful tool for Windows platform lover.
Nutanix provides PowerShell cmdlets for ( AHV , ESXi, Hyper-v ) to interacting with a Nutanix cluster. Through Nutanix CMDlets / Commandlets you can perform / execute almost any task that one you can do from any other interfaces.
Nutanix developed CMDlets based commands bundle that can be run directly on Microsoft Windows platform and easily integrated with Windows PowerShell.
Read also: What is Nutanix HCI ?
Nutanix CMDlets Commands
Nutanix has developed Nutanix cluster based commands list bundled in CMDlets light weight executable package that will be directly integrated with Windows PowerShell.
The Nutanix CMDlets can be downloaded from a Nutanix Cluster using Prism Web console and install it on a Windows OS. Nutanix Cmdlets desktop shortcut launches a PowerShell window with the Nutanix cmdlets loaded.
Read also: Google Chrome Version 82 Highlights
Nutanix Powershell CMDlet Example
I’m going to show Nutanix Powershell CMDlet commands tutorial with example to execute any task on Nutanix cluster.
Nutanix Powershell CMDlet command example:
Connect to Nutanix cluster
powershell> Connect-NutanixCluster -Server <Type_cluster_ip_address> -UserName <Type_UserName> -Password <Type_Password>
Example: Connect-NutanixCluster -Server 192.168.0.100 -UserName admin -Password P@ssword
More Example: Nutanix AHV PowerShell Commands
Execute Powershell CMDlet command on connected Nutanix Cluster
Example:
Powershell> AnyCMDLetCommand <Parameter Name> <Valid Value>
Example 1: powershell> Get-NutanixCluster
Example 2: Powershell> Add-NTNXAuthType InputList [ LOCAL | DIRECTORY_SERVICE ]
Read also: Nutanix Metro Availability Troubleshooting
Nutanix CMDlets Common Commands
Nutanix common CMDlets / Commandlets commands to connect and disconnect to/from Nutanix cluster.
Nutanix CMDlets Common commands list is here:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Connect-NTNXCluster | Connect to Nutanix acropolis cluster |
| Disconnect-NTNXCluster | Disconnect from Nutanix acropolis cluster |
| Get-NTNXCmdletioninfo | Get Nutanix cluster info |
| Disconnect-NutanixCluster | Disconnect from Nutanix acropolis cluster |
| Get-NutanixCluster | Get Nutanix cluster info |
| Get-NutanixCmdletsinfo | Get Nutanix cluster info with CMDlets info |
Read aslo: Download Latest Nutanix AHV, AOS Here
Nutanix Host Administration CMDlets Commands
Nutanix host administration CMDlets commands to put and exist Nutanix host to/from maintenance mode.
Nutanix host administration command list is here:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Start-NTNXMaintenanceMode | Put Nutanix Host in Maintenance Mode |
| Stop-NTNXMaintenanceMode | Evacutate Nutanix Host in Maintenance Mode |
Read also: Download Latest Nutanix Virtio Driver For Windows OS
Nutanix Host Network Administration CMDlets Commands
You can do network administration i.e create, remove, delete virtual network through CMDlets commands.
Nutanix host administration Nutanix CMDlets command list is here:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Get-NTNXNetwork | Get Nutanix Cluster Network Information |
| New-NTNXNetwork | Create New Virtual Network |
| Remove-NTNXNetwork | Remove Virtual Network |
| Set-NTNXNetwork | Set Virtual Network Configuration |
| Get-NTNXNetworkAddressTable | Get Nutanix Cluster Network Address Table |
| Reserve-NTNXNetworkIP | Reserve Nutanix IP Address For VMs |
| UnReserve-NTNXNetworkIP | UnReserve Nutanix IP Address For VMs |
Read also: Download Nutanix NGT Tool for Windows, Linux OS
Nutanix Snapshot Administration CMDlets Commands
you can take and manage Nutanix hosted VMs snapshots related tasks i.e VM’s cloning, take and delete snapshot through Nutanix CMDlets commands.
Nutanix Snapshots administration Nutanix CMDlets commands are here:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Clone-NTNXSnapshot | Create VM Clone From Snapshot |
| Get-NTNXSnapshot | Get VMs Snapshots List |
| New-NTNXSnapshot | Take New Snapshot |
| Remove-NTNXSnapshot | Remove Snapshot |
Read also: Nutanix Support Number
Nutanix Task Administration CMdlets Commands
You can execute major daily routine common task(s) i.e task status, vDisk, vNIC, VM power-off, power-on, VM cloning, create , delete VM etc. through Nutanix CMDlets commands.
Nutanix task administration Nutanix CMDlets commands list is here.
Nutanix cluster Task status Nutanix CMDlets commands are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Get-NTNXTask | Get Task List |
| Poll-NTNXTask | Task Pool List |
Read also: P2V / V2V Migration Prerequisites For Windows / Linux – Best practice
Nutanix cluster VM’s vDisk task related Nutanix CMDlets commands are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Add-NTNXVMDisk | Add vDisk in VM |
| Get-NTNXVMDisk | Get vDisk List of VM |
| Remove-NTNXVMDisk | Remove vDisk from VMs |
| Set-NTNXVMDisk | Set VM’s vDisk |
| Stop-NTNXVMMove | Stop Moving vDisk |
Read also: Nutanix AHV Supported Guest OS List
Nutanix cluster VM’s vNIC task related Nutanix CMDlets command are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Add-NTNXVMNIC | Add vNIC in VM |
| Get-NTNXVMNIC | Get vNIC Details of VM |
| Remove-NTNXVMNIC | Remove vNIC from VM |
Read also: Configure LACP / LAG on vDS VMware Distributed vSwitch – Best Practice
Nutanix cluster VM’s power related task Nutanix CMDlets command are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Set-NTNXVMPowerOff | Power-off VM |
| Set-NTNXVMPowerOn | Power-on VM |
| Set-NTNXVMPowerState | Set Power State Option |
Read also: Nutanix Software Products List
Nutanix cluster VMs related task Nutanix CMDlets commands are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Get-NTNXVMSnapshot | Get VMs Snapshots List |
| Clone-NTNXVirtualMachine | Clone VM |
| Get-NTNXVirtualMachine | Get VMs List |
| Move-NTNXVirtualMachine | Move VM between Hosts |
| New-NTNXVirtualMachine | Create New VM |
| Remove-NTNXVirtualMachine | Delete VM |
| Restore-NTNXVirtualMachine | Restore VM from Snapshot |
| Set-NTNXVirtualMachine | Set VM configuration |
Read aslo: Install Nutanix LCM Dark Site Bundle on Linux Server
Nutanix cluster Alerts CMDlets Commands
You can manage Nutanix cluster alerts i.e get alert status, acknowledge, resolve it.
Nutanix cluster alerts related task Nutanix CMDlets commands are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Acknowledge-NTNXAlert | Acknowledged Nutanix Cluster Alerts |
| Get-NTNXAlert | Get Nutanix Cluster Alerts |
| Resolve-NTNXAlert | Resolve Nutanix Cluster Alerts |
| Get-NTNXAlertConfiguration | Get Nutanix Cluster Alerts Configuration |
| Set-NTNXAlertConfiguration | Set Nutanix Cluster Alerts Configuration |
| Get-NTNXAlertMetadata | Get Nutanix Cluster Alerts Metadata |
| Set-NTNXAlertMetadata | Set Nutanix Cluster Alerts Metadata |
| Acknowledge-NTNXAlerts | Acknowledge Nutanix Cluster Alerts |
| Resolve-NTNXAlerts | Resolve Nutanix Cluster Alerts |
| Get-NTNXHardwareAlert | Get Nutanix Host Hardware Related Alerts |
| Get-NTNXStorageAlert | Get Nutanix Cluster Storage Alerts |
Read aslo: Google Nutanix Cloud Platform ?
Nutanix Authentication Administration CMDlets Commands
you can manage Nutanix authentication configuration i.e get, add, remove LDAP, active directory authentication through Nutanix CMDlets commands.
Nutanix cluster authentication administration CMDlets command are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Get-NTNXAuthConfig | Get Nutanix Cluster Authentication Details |
| Remove-NTNXAuthConfig | Remove Nutanix Cluster Authentication Details |
| Update-NTNXAuthConfig | Update Nutanix Cluster Authentication Details |
| Add-NTNXAuthConfigDirectory | Add Nutanix Cluster AD Authentication |
| Get-NTNXAuthConfigDirectory | Get Nutanix Cluster AD Authentication |
| Remove-NTNXAuthConfigDirectory | Remove Nutanix Cluster AD Authentication |
| Set-NTNXAuthConfigDirectory | Set Nutanix Cluster AD Authentication |
| Add-NTNCAuthType | Add Nutanix Cluster Authentication Type |
| Get-NTNCAuthType | Get Nutanix Cluster Authentication Type |
| Remove-NTNCAuthType | Remove Nutanix Cluster Authentication Type |
| Set-NTNCAuthType | Set Nutanix Cluster Authentication Details |
| Get-NTNXClientAuthState | Get Nutanix Cluster AD Aliententication |
| Set-NTNXClientAuthState | Set Nutanix Cluster AD Aliententication |
| Test-NTNXLDAPConnection | Test Nutanix Cluster LDAP Connection |
Read also: Nutanix Prism Supports Top 5 Web Browsers
Nutanix Backup & Administration CMDlets Commands
You can manage Nutanix cluster backup, Protection domain and DC – DR replication related task through CMDlets comannds.
Nutanix cluster DC – DR Backup and replication CMDlets commands are:
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Clear-NTNXCronSchedule | Clear Nutanix Cluster Cron Schedule |
| Restore-NTNXEntity | Restore Nutanix Entity |
| Add-NTNXOutOfBandSchedule | Add Nutanix Out of band Schedule |
| Get-NTNXOutOfBandSchedule | Get Nutanix Out of band Schedule |
| Remove-NTNXOutOfBandSchedule | Remove Nutanix TNXOut of band Schedule |
| Add-NTNXProtectioinDomain | Add Nutanix Protectioin Domain |
| Get-NTNXProtectioinDomain | Get Nutanix Protectioin Domain |
| Migrate-NTNXProtectioinDomain | Migrate Nutanix Protectioin Domain |
| Rollback-NTNXProtectioinDomain | Rollback Nutanix Protectioin Domain |
| Mark-NTNXProtectionDomainActive | Mark Nutanix Cluster Protectioin Domain Active |
| Get-NTNXProtectionDomainAlert | Get Nutanix Cluster Protection Domain Alet |
| Get-NTNXProtectionDomainConsistencyGroup | Get Protection domain consistency Group |
| Add-NTNXProtectionDomainCronSchedule | Add Protection domain cron Schedule |
| Get-NTNXProtectionDomainCronSchedule | Get Protection domain cron Schedule |
| Remove-NTNXProtectionDomainCronSchedule | Remove Protectionanix Protection domain cron Schedule |
| Replace-NTNXProtectionDomainCronSchedule | Replace NTNXProtection domain cron Schedule |
| Get-NTNXProtectionDomainEvent | Get Nutanix Cluster Protection Domain Event |
| Mark-NTNXProtectionDomainForRemoval | Mark Nutnaix Protection domain for Removal |
| Get-NTNXProtectionDomainHealthCheckSummary | Get Nutanix Protectioin Domain Health Checks Summary |
| Mark-NTNXProtectionDomainactive | Mark Nutanix Protection Domainactive |
| Get-NTNXProtectionDomainPendingReplication | GetNutanix Protection domain pending Replication |
| Abort-NTNXProtectionDomainReplication | Abort Nutanix Protection Domain Replication |
| Get-NTNXProtectionDomainReplication | Get Nutanix Protection Domain Replication |
| Set-NTNXProtectionDomainReplication | Set Nutanix Protection Domain Replication |
| Clear-NTNXProtectionDomainRetentionPolicy | Clear Nutnaix Protection domain retention Policy |
| Set-NTNXProtectionDomainRetentionPolicy | Set Nutanix Protection domain retention Policy |
| Get-NTNXProtectionDomainSnapshot | Get Nutanix Protection Domain Snapshot |
| Remove-NTNXProtectionDomainSnapshot | Remove Nutanix Protection Domain Snapshot |
| Set-NTNXProtectionDomainSnapshot | Set Nutanix Protection Domain Snapshot |
| Get-NTNXProtectionDomainStat | Get Nutanix Protection Domain Stat |
| Get-NTNXProtectionDomainStatus | Get Nutanix Protection Domain Status |
| Promote-NTNXProtectionDomainStretchCluster | Promote Nutanix Protection domain stretch Cluster |
| Start-NTNXProtectionDomainStretchCluster | Start Nrotectionanix NXProtection domain stretch Cluster |
| Stop-NTNXProtectionDomainStretchCluster | Stop Nutnaix Protection domain stretch Cluster |
| Update-NTNXProtectionDomainStretchClusterTimeout | Update Nutanix Cluster Domain Stretch Cluster Timeout |
| Add-NTNXProtectionDomainVM | Add Nutanix cluster VM in Protection Domain |
| Remove-NTNXProtectionDomainVM | Remove Nutanix cluster VM from Protection Domain |
| Get-NTNXUnprotectedVM | Get Nutanix Unprotected VM |
Read also: Shutdown / Start Nutanix vSphere Cluster – Best Practice
Nutanix Cluster Quick Configuration CMDlets Commands
You can do quick basic configuration i.e add, remove, NTP, DNS, SMTP, Domain joining etc.
| Nutanix CMDLets Commands | Command Description |
|---|---|
| Set-NTNXClusterJoiningToDomain | Join Nuttanix cluster to Domain |
| Get-NTNXClusterStat | Get Nutanix Cluster status |
| Send-NTNXEmailUsingSmtpServer | Send E-mail Via SMTP Service |
| Add-NTNXNameServer | Add Nutanix Cluster Name |
| Get-NTNXNameServer | Get Nutanix Cluster Name |
| Remove-NTNXNameServer | Remove Nutanix Cluster Name |
| Get-NTNXNfsSubnetWhiteList | Get NFS Container While List |
| Add-NTNXNfsSubnetWhiteList | Add NFS Container While List |
| Remove-NTNXNfsSubnetWhiteList | Remove NFS Container While List |
| Add-NTNXNtpServer | Add NTP Server |
| Get-NTNXNtpServer | Get NTP Server |
| Remove-NTNXNtpServer | Remove NTP Server |
| Add-NTNXPublicKey | Add SSH Public Key |
| Get-NTNXPublicKey | Get SSH Public Key |
| Remove-NTNXPublicKey | Remove SSH Public Key |
| Get-NTNXRackableUnit | Get Rackable Domain Unit |
| Remove-NTNXRackableUnit | Remove Rackable Domain Unit |
| Get-NTNXRemoteSupportSetting | Get Remote Cluster Setting |
| Set-NTNXRemoteSupportSetting | Set Remote Cluster Setting |
| Get-NTNXSmtpServer | Get SMTP Server Configuration |
| Remove-NTNXSmtpServer | Remove SMTP Server Configuration |
| Set-NTNXSmtpServer | Set SMTP Server Configuration |
| Get-NTNXSmtpServerSecurityModeType | Get SMTP Server Secrity Configuration |
| Get-NTNXSpotlightSearchResult | Get Nutanix cluster search result |
Read also: Nutanix AHV – Boot VM in BIOS UEFI Mode
Nutanix CMDlet is easier way to manage your cluster with command line without accessing Prism web console.
Thanks to being with HyperHCI Tech Blog to stay tuned for latest and trending techie updates.
Blog Author