API Ref AOS v6 - 0

AOS 6.
Acropolis v1 API Reference

June 14, 2021
Contents
1. Nutanix REST API...................................................................................................15

Accessing the REST API Explorer..................................................................................................................... 15
Status Codes.............................................................................................................................................................. 18
2. About Nutanix PowerShell Cmdlets..............................................................20

Installing PowerShell Cmdlets............................................................................................................................20
PowerShell Cmdlets Usage................................................................................................................................. 20
Object Creation and Referencing.....................................................................................................................24
Creating Object Lists.................................................................................................................................24
Creating Nested Objects with the Template Flag......................................................................... 25
Part I: REST API Reference.................................................................................... 26

3. Alerts........................................................................................................................................................................ 27
Get the list of Alerts..................................................................................................................................28
Acknowledge Alerts.................................................................................................................................. 30
Get the Alert configuration......................................................................................................................31
Modify the Alert configuration.............................................................................................................. 32
Update the Alert configuration............................................................................................................. 33
Get the list of hardware Alerts............................................................................................................. 33
Resolve Alerts...............................................................................................................................................35
Get the list of storage Alerts.................................................................................................................36
Acknowledge Alert..................................................................................................................................... 37
Resolve Alert.................................................................................................................................................38
4. Authconfig............................................................................................................................................................ 40
Delete Auth config...................................................................................................................................... 41
Get Auth configuration..............................................................................................................................41
Modify Auth configuration....................................................................................................................... 41
Update Auth configuration..................................................................................................................... 42
Add Auth types........................................................................................................................................... 43
Get Auth types............................................................................................................................................ 43
Update Auth types.....................................................................................................................................43
Get client authentication status........................................................................................................... 44
Enable/disable client authentication.................................................................................................. 45
Update client authentication..................................................................................................................45
Delete client chain certificate for authentication.......................................................................... 46
Get the list of Directories........................................................................................................................47
Modify Directory..........................................................................................................................................47
Add Directory...............................................................................................................................................48
Edit Directory............................................................................................................................................... 49
Test LDAP directory connection status.............................................................................................49
Delete Directory.......................................................................................................................................... 50
Get Directory................................................................................................................................................. 51
Remove Auth types.................................................................................................................................... 51
5. Cloud........................................................................................................................................................................53
Remove all cloud credentials.................................................................................................................54
Get cloud credentials................................................................................................................................ 54
Add a cloud credential............................................................................................................................. 55
ii
Remove a cloud credential..................................................................................................................... 56
Update a cloud credential.......................................................................................................................57
Get a list of CVMs...................................................................................................................................... 58
Set a default cloud credential to use.................................................................................................59
Deploy a cloud CVM and create a remote site.............................................................................. 60
Get a list of CVM images......................................................................................................................... 61
Get a list of subnets..................................................................................................................................63
6. Cluster..................................................................................................................................................................... 65
Get Cluster details......................................................................................................................................66
Modify Cluster params..............................................................................................................................69
Update Cluster params.............................................................................................................................69
Start block aware fixer............................................................................................................................. 70
Stop block aware fixer............................................................................................................................. 70
Add Witness VM details............................................................................................................................71
List All Metro Availability Witnesses................................................................................................... 72
Delete a Metro Availability Witness.....................................................................................................72
Update a Metro Availability Witness...................................................................................................73
Get the list of Name Servers................................................................................................................. 74
Add name server.........................................................................................................................................74
Delete the specified Name Server....................................................................................................... 75
Get NFS subnet whitelist.........................................................................................................................75
Add NFS subnet whitelist entry........................................................................................................... 76
Delete NFS the specified subnet whitelist entry........................................................................... 76
Get the list of NTP servers..................................................................................................................... 77
Add NTP server........................................................................................................................................... 77
Delete an NTP server................................................................................................................................ 78
Get the list of Public Keys...................................................................................................................... 78
Add a Public Key........................................................................................................................................ 79
Delete a Public Key....................................................................................................................................79
Get a Public Key......................................................................................................................................... 80
Get the list of Rackable Units................................................................................................................ 81
Delete the specified Rackable Unit...................................................................................................... 81
Get the specified Rackable Unit...........................................................................................................82
Get Remote Support settings................................................................................................................82
Update Remote Support settings........................................................................................................ 83
Get spotlight search results................................................................................................................... 83
Delete SMTP server config..................................................................................................................... 84
Get the SMTP server config................................................................................................................... 85
Modify the SMTP server config.............................................................................................................85
Update the SMTP server config........................................................................................................... 86
Get the SMTP security modes...............................................................................................................87
Get the list of Cluster stats.................................................................................................................... 87
7. Clusters....................................................................................................................................................................89
Get the list of clusters..............................................................................................................................90
Get the list of alerts generated on any Cluster...............................................................................91
Get the list of events generated on any Cluster............................................................................ 92
Get a Cluster.................................................................................................................................................93
Get the list of alerts generated on a specified Cluster................................................................97
Get the list of events generated on a specified Cluster............................................................. 98
Get the stats for a specified Cluster.................................................................................................. 99
8. Comments............................................................................................................................................................. 101
Create a new comment.......................................................................................................................... 102
9. Containers............................................................................................................................................................ 103
Get the list of Containers...................................................................................................................... 104
Modify a Container................................................................................................................................... 105
Add a Container........................................................................................................................................ 105
iii
Update a Container..................................................................................................................................106
Get the list of alerts generated on any Container.......................................................................107
Get the list of NFS Datastores............................................................................................................ 108
Add an NFS Datastore............................................................................................................................108
Remove an NFS Datastore....................................................................................................................109
Get the list of events generated on any Container.....................................................................109
Delete a Container.....................................................................................................................................110
Get a Container............................................................................................................................................ 111
Get the list of alerts generated on a specified Container..........................................................113
Get the list of events generated on a specified Container........................................................114
Get the stats for a specified Container.............................................................................................116
Get the list of VDisks............................................................................................................................... 116
10. Data at rest encryption................................................................................................................................. 118
Get encryption status............................................................................................................................... 119
Download encryption key....................................................................................................................... 119
Enable encryption..................................................................................................................................... 120
Get recent certificate test results.......................................................................................................120
Sets new passwords for encryption capable disks.......................................................................121
Test encryption configuration...............................................................................................................122
11. Data at rest encryption certificates.......................................................................................................... 123
Get all CA certificates............................................................................................................................. 124
Add trusted CA certificate.................................................................................................................... 124
Delete Certificate Authority.................................................................................................................. 125
Update the Certification information................................................................................................ 125
Get Certification information................................................................................................................126
Download CSR files.................................................................................................................................. 127
Download CSR files.................................................................................................................................. 127
Delete certificate........................................................................................................................................128
Add certificates.......................................................................................................................................... 128
Add certificates.......................................................................................................................................... 129
Replace expired svm certificate..........................................................................................................130
12. Disks...................................................................................................................................................................... 132
Get the list of Disks..................................................................................................................................133
Get the list of alerts generated on any Disk..................................................................................134
Get the list of events generated on any Disk................................................................................ 135
Get the health check summary for the Disks................................................................................ 136
Mark specified Disk for Removal........................................................................................................ 137
Get a Disk..................................................................................................................................................... 138
Get the list of alerts generated on a specified Disk................................................................... 140
Get the list of events generated on a specified Disk.................................................................. 141
Get the stats for a specified Disk.......................................................................................................142
13. Events...................................................................................................................................................................144
Get the list of Events.............................................................................................................................. 145
Acknowledge events................................................................................................................................146
Get the list of hardware Events.......................................................................................................... 147
Get the list of storage Events..............................................................................................................148
Acknowledge Event..................................................................................................................................149
14. File groups...........................................................................................................................................................151
List file groups............................................................................................................................................ 152
Remove files for a specific file group............................................................................................... 152
15. Health checks....................................................................................................................................................154
Get the list of Health Checks............................................................................................................... 155
Modify Health Check details................................................................................................................. 155
Update Health Check details................................................................................................................ 157
Get Health Check details....................................................................................................................... 158
16. Hosts...................................................................................................................................................................... 161
iv
Get the list of Physical Hosts............................................................................................................... 162
Get the list of alerts generated on any Host................................................................................. 163
Get the list of events generated on any Host............................................................................... 164
Get the health check summary for Hosts....................................................................................... 165
Get a Physical Host.................................................................................................................................. 166
Get the list of alerts generated on a specified Host...................................................................169
Get the list of events generated on a specified Host.................................................................. 171
Get the stats for a specified Physical Host.....................................................................................172
17. Http proxies........................................................................................................................................................174
Get the list of HTTP Proxies................................................................................................................. 175
Modify an HTTP Proxy............................................................................................................................ 175
Add an HTTP Proxy..................................................................................................................................175
Update an HTTP Proxy........................................................................................................................... 176
Get HTTP Proxy whitelist....................................................................................................................... 177
Set HTTP Proxy whitelist........................................................................................................................177
Delete an HTTP Proxy............................................................................................................................. 178
Get an HTTP Proxy................................................................................................................................... 178
18. Key management servers............................................................................................................................ 180
Get all Key Management Servers.........................................................................................................181
Modify the KeyManagementServer..................................................................................................... 181
Add a Key Management Server...........................................................................................................182
Update the KeyManagementServer................................................................................................... 182
Get Key Management Server Type.................................................................................................... 183
Select Key Management Server Type............................................................................................... 184
Delete the KeyManagementServer.....................................................................................................184
Get Key Management Server................................................................................................................185
19. License..................................................................................................................................................................187
Show current license file........................................................................................................................ 188
Apply license file....................................................................................................................................... 188
Get the list of alerts generated for any License...........................................................................189
Show allowances for all features........................................................................................................ 190
Show allowances for a particular feature....................................................................................... 190
Get Cluster Info........................................................................................................................................... 191
Get Cluster Info as a file........................................................................................................................ 192
Get the list of events generated for any License......................................................................... 192
20. Protection domains....................................................................................................................................... 194
Get the list of Protection Domains.................................................................................................... 195
Add a Protection Domain......................................................................................................................196
Get the list of alerts generated on any Protection Domain..................................................... 197
Get list of Consistency groups............................................................................................................ 198
Get the list of Snapshots....................................................................................................................... 199
Get the list of events generated on any Protection Domain..................................................200
Get the health check summary for the Protection Domain..................................................... 201
Get the list of Out-Of-Band schedules in Protection Domains..............................................202
Get list of pending actions.................................................................................................................. 202
Get list of pending replications..........................................................................................................203
Get list of replications............................................................................................................................203
Get the Data Protection status for all Protection Domains.................................................... 204
Get list of unprotected VMs in a cluster........................................................................................ 204
Get the stats for a specified Protection Domain........................................................................ 205
Delete a Protection Domain................................................................................................................ 206
Get a Protection Domain...................................................................................................................... 207
Activate a protection domain............................................................................................................. 208
Get the list of alerts generated on a specified Protection Domain......................................209
Updates Metro Availability timeout for a specific protection domain................................. 210
Get list of Consistency groups in a Protection Domain.............................................................212
v
Updates Consistency Group for a specific protection domain............................................... 212
Deactivate a protection domain..........................................................................................................213
Get the list of Snapshots in a Protection Domain....................................................................... 214
Get the list of events generated on a specified Protection Domain..................................... 215
Change failure handling mode for a protection domain........................................................... 216
Disables Metro Availability for a specific protection domain.................................................. 218
Enables Metro Availability for a specific protection domain................................................... 219
Migrate an active Protection Domain to a DR site...................................................................... 221
Add a out of band snapshot schedule in a Protection Domain.............................................222
Get the list of Out-Of-Band schedules in a Protection Domain.............................................222
Delete a Out-Of-Band schedule......................................................................................................... 223
Get list of pending actions in the Protection Domain...............................................................224
Get list of pending replications in the Protection Domain...................................................... 224
Promotes to active Metro Availability role for a specific protection domain....................225
Add Virtual Machines to a Protection Domain.............................................................................226
Get list of replications in a Protection Domain............................................................................ 228
Rollback Virtual Machines and/or NFS files.................................................................................. 228
Rollback an active Protection domain.............................................................................................229
Remove all snapshot schedules from a Protection Domain................................................... 230
Retrieve all snapshot schedules from a Protection Domain................................................... 230
Add a snapshot schedule to a Protection Domain......................................................................231
Remove a snapshot schedule from a Protection Domain........................................................ 232
Replace a snapshot schedule of a Protection Domain..............................................................232
Clear retention policies of a snapshot schedule of a Protection Domain.......................... 234
Set retention policies of a snapshot schedule of a Protection Domain.............................. 235
Restore Virtual Machines and/or NFS files....................................................................................236
Remove Virtual Machines from a Protection Domain................................................................ 237
Delete a snapshot.................................................................................................................................... 238
Retain a snapshot.....................................................................................................................................239
Abort a replication...................................................................................................................................239
Update the state of the replication..................................................................................................240
21. Remote sites..................................................................................................................................................... 242
Get the list of Remote Sites................................................................................................................ 243
Modify a Remote Site.............................................................................................................................244
Add a Remote Site.................................................................................................................................. 245
Update a Remote Site............................................................................................................................247
Get the list of alerts generated on any Remote Site.................................................................249
Get the list of Snapshots...................................................................................................................... 250
Get the list of events generated on any Remote Site................................................................ 251
Get the health check summary for the Remote Sites............................................................... 252
Get all pending replications................................................................................................................. 253
Delete a Remote Site..............................................................................................................................254
Get a Remote Site................................................................................................................................... 254
Get the list of alerts generated on a specified Remote Site...................................................256
Get the list of Snapshots...................................................................................................................... 258
Get the list of events generated on a specified Remote Site.................................................259
Get all pending replications for the specified Remote Site.................................................... 260
Get the stats for a specified Remote Site..................................................................................... 260
22. Snmp................................................................................................................................................................... 262
Get SNMP configuration........................................................................................................................ 263
Add SNMP Transports............................................................................................................................ 263
Remove SNMP Transports.................................................................................................................... 264
Get the SNMP status.............................................................................................................................. 264
Enable/Disable SNMP configuration................................................................................................ 264
Get the list of SNMP Transports........................................................................................................ 265
Get the list of SNMP Traps...................................................................................................................265
vi
Modify SNMP Trap................................................................................................................................... 266
Add SNMP Trap.........................................................................................................................................267
Edit SNMP Trap......................................................................................................................................... 267
Delete SNMP Trap.................................................................................................................................... 268
Get SNMP Trap..........................................................................................................................................269
Get the list of SNMP Users.................................................................................................................. 270
Modify SNMP User................................................................................................................................... 270
Add SNMP User..........................................................................................................................................271
Edit SNMP User.......................................................................................................................................... 271
Delete SNMP User.................................................................................................................................... 272
Get SNMP User..........................................................................................................................................273
23. Storage pools.................................................................................................................................................. 274
Get the list of Storage Pools............................................................................................................... 275
Update a Storage Pool...........................................................................................................................276
Add a Storage Pool................................................................................................................................. 277
Update a Storage Pool...........................................................................................................................277
Get the list of alerts generated on any Storage Pool................................................................278
Get the list of events generated on any Storage Pool..............................................................279
Delete a Storage Pool............................................................................................................................ 280
Get a Storage Pool................................................................................................................................... 281
Get the list of alerts generated on a specified Storage Pool..................................................282
Get the list of events generated on a specified Storage Pool................................................283
Get the stats for a specified Storage Pool.................................................................................... 285
24. Users................................................................................................................................................................... 286
Get Logged In Users Details................................................................................................................287
Get Logged In Details of a user.........................................................................................................287
25. Vdisks..................................................................................................................................................................289
Get the list of VDisks............................................................................................................................. 290
Update a VDisk......................................................................................................................................... 290
Add a VDisk.................................................................................................................................................291
Update a VDisk......................................................................................................................................... 292
Get the list of alerts generated on any VDisk.............................................................................. 293
Get the list of events generated on any VDisk............................................................................294
Get the complete list of Snapshots.................................................................................................. 295
Get a Snapshot......................................................................................................................................... 296
Delete a VDisk........................................................................................................................................... 297
Get a VDisk.................................................................................................................................................298
Get the list of alerts generated on a specified VDisk...............................................................300
Get the list of events generated on a specified VDisk.............................................................. 301
Snapshot a VDisk..................................................................................................................................... 302
Get the list of Snapshots......................................................................................................................304
Get the stats for a specified VDisk.................................................................................................. 304
26. Vfilers................................................................................................................................................................. 306
Get FileServers based on passed criteria...................................................................................... 307
Create a FileServer.................................................................................................................................. 308
Update file server configuration........................................................................................................ 308
Get the pulse configs.............................................................................................................................309
Get the list of Shares associated with all file servers................................................................309
Get File server snapshot info...............................................................................................................310
Upgrade given list of file servers.........................................................................................................311
Upgrade files module...............................................................................................................................312
Get the file servers usage......................................................................................................................313
Delete FileServer........................................................................................................................................313
Get a single FileServer's details.......................................................................................................... 314
Activate File Server.................................................................................................................................. 316
Add Dns Entries.........................................................................................................................................316
vii
Get the list of admin users....................................................................................................................317
Add new admin user................................................................................................................................318
Update Admin User.................................................................................................................................. 319
Delete Admin User....................................................................................................................................319
Get a single admin user........................................................................................................................ 320
Get built in groups per file server...................................................................................................... 321
Clone File Server........................................................................................................................................321
Configure Name services.......................................................................................................................322
Get the list of dns entries.....................................................................................................................323
Get the list of icap servers...................................................................................................................324
Add new icap server...............................................................................................................................324
Update Icap Server.................................................................................................................................. 325
Delete icap server.................................................................................................................................... 326
Get a icap server...................................................................................................................................... 327
Get the stats for a specified Icap server........................................................................................ 328
Test Icap Server Connection................................................................................................................329
Get the list of infected files.................................................................................................................330
Delete list of infected files.....................................................................................................................331
Quarantine list of infected files.......................................................................................................... 332
Rescan list of infected files.................................................................................................................. 333
Reset list of infected files..................................................................................................................... 334
Unquarantine list of infected files..................................................................................................... 334
Get infected file........................................................................................................................................ 335
Join Domain................................................................................................................................................336
LoadBalance File Server........................................................................................................................ 337
Protect File Server................................................................................................................................... 338
Remove Dns Entries................................................................................................................................ 339
Search User Mapping............................................................................................................................. 340
Get file server security details........................................................................................................... 340
Update FileServer security config......................................................................................................341
Get the list of Shares..............................................................................................................................342
Add new Share..........................................................................................................................................343
Update file server share configuration............................................................................................344
Delete File Server Share....................................................................................................................... 344
Get the Share.............................................................................................................................................345
Get principal type from principal name..........................................................................................348
Get the list of quota policies.............................................................................................................. 348
Add new Quota Policy...........................................................................................................................349
Update Quota Policy.............................................................................................................................. 350
Delete Quota Policy................................................................................................................................. 351
Get a single quota policy......................................................................................................................352
Get the stats for a specified share................................................................................................... 353
Delete Virus Scan Policy....................................................................................................................... 354
Get the list of snapshot policies........................................................................................................ 355
Add new Snapshot Policy.....................................................................................................................355
Update Snapshot Policy........................................................................................................................ 356
Delete Snapshot Policy.......................................................................................................................... 357
Get the list of snapshots.......................................................................................................................358
Get a file server share snapshot........................................................................................................ 358
Get the ssl certificate details of FileServer....................................................................................359
ReGenerate Self Signed Certificate.................................................................................................. 360
Get the stats for a specified FS..........................................................................................................361
Unjoin Domain........................................................................................................................................... 362
Get the user mapping............................................................................................................................ 363
Add new User Mapping......................................................................................................................... 363
Update User Mapping............................................................................................................................ 364
viii
Delete FileServer User............................................................................................................................365
Get the list of users................................................................................................................................ 366
Add new user.............................................................................................................................................366
Update User................................................................................................................................................367
Verify Dns Entries.....................................................................................................................................368
Get a virus scan policy.......................................................................................................................... 369
Add Virus Scan Policy............................................................................................................................370
Update Antivirus Server Scan Policy.................................................................................................371
27. Virtual disks...................................................................................................................................................... 373
Get the list of VirtualDisks................................................................................................................... 374
Get VirtualDisk........................................................................................................................................... 375
Get the stats for a specified VirtualDisk.........................................................................................376
28. Vms...................................................................................................................................................................... 378
Get the list of VMs.................................................................................................................................. 379
Create a Virtual Machine.......................................................................................................................380
Get the list of alerts generated on any VM...................................................................................380
Get the list of events generated on any VM................................................................................. 382
List Nutanix Guest Tools........................................................................................................................383
Get the health check summary for VMs......................................................................................... 383
Get VM..........................................................................................................................................................384
Get the list of alerts generated on a specified VM.................................................................... 386
Get the list of events generated on a specified VM.................................................................. 388
Update fingerPrintOnWrite on all VDisks of a VM..................................................................... 389
Get Nutanix Guest Tools........................................................................................................................ 391
Update Nutanix Guest Tools................................................................................................................ 392
Create Nutanix Guest Tools................................................................................................................. 393
Update Nutanix Guest Tools................................................................................................................ 393
Mount Nutanix Guest Tools..................................................................................................................394
Unmount Nutanix Guest Tools............................................................................................................ 395
Update OnDiskDedup on all VDisks of a VM................................................................................395
Get all snapshots of a VM.................................................................................................................... 397
Get snapshot info for given snapshot of a VM............................................................................ 398
Get the stats for a specified VM....................................................................................................... 399
Get the list of VDisks.............................................................................................................................400
Get the list of VirtualDisks.................................................................................................................. 400
Clone a Virtual Machine......................................................................................................................... 401
29. Vstores............................................................................................................................................................... 403
Get the list of VStores...........................................................................................................................404
Get a VStore.............................................................................................................................................. 404
Protect a VStore.......................................................................................................................................405
Unprotect a VStore................................................................................................................................. 406
Protect a VStore.......................................................................................................................................407
Part II: PowerShell Cmdlets Reference........................................................... 409

30. PowerShell Cmdlets Entities..................................................................................................................... 410
31. AcropolisVDisk..................................................................................................................................................416
32. AdminUser......................................................................................................................................................... 418
33. AdminUsers......................................................................................................................................................420
34. Alert.................................................................................................................................................................... 423
35. AlertConfiguration......................................................................................................................................... 427
36. Alerts.................................................................................................................................................................. 430
37. AllCloudCredentials....................................................................................................................................... 433
38. AllFileServerShares....................................................................................................................................... 435
39. AuthConfig....................................................................................................................................................... 437
40. AuthConfigDirectory................................................................................................................................... 440
ix
41. AuthType........................................................................................................................................................... 444
42. BuiltInGroupsFileServerByUuid................................................................................................................447
43. CACertificate...................................................................................................................................................449
44. CassandraBlockAwareFixer........................................................................................................................ 451
45. Certificate......................................................................................................................................................... 453
46. CertificatesViaMultiFile................................................................................................................................455
47. CertificationInformation...............................................................................................................................457
48. ClientAuth........................................................................................................................................................ 460
49. ClientAuthState.............................................................................................................................................. 462
50. CloudCredential............................................................................................................................................. 464
51. CloudCvm.......................................................................................................................................................... 468
52. CloudCvmImage.............................................................................................................................................470
53. CloudRemoteSite........................................................................................................................................... 472
54. Cluster................................................................................................................................................................ 474
55. ClusterDataState............................................................................................................................................ 479
56. ClusterExternalDetail.....................................................................................................................................481
57. ClusterExternalState......................................................................................................................................483
58. ClusterFromMulticluster.............................................................................................................................. 485
59. ClusterInfo........................................................................................................................................................ 487
60. ClusterLicenseInfo.........................................................................................................................................489
61. ClusterStat.......................................................................................................................................................... 491
62. ClusterToMulticluster.................................................................................................................................... 493
63. ConsistencyGroup......................................................................................................................................... 495
64. Container.......................................................................................................................................................... 497
65. ContainerAlert................................................................................................................................................ 504
66. ContainerEvent...............................................................................................................................................506
67. ContainerStat...................................................................................................................................................508
68. ContainerVDisk................................................................................................................................................510
69. CronSchedule................................................................................................................................................... 512
70. CurrentlyLoggedInUserInfo........................................................................................................................ 514
71. CurrentlyLoggedInUsersInfo........................................................................................................................516
72. Dns........................................................................................................................................................................ 518
73. DefaultCloudCredential............................................................................................................................... 520
74. Disk...................................................................................................................................................................... 522
75. DiskAlert............................................................................................................................................................ 525
76. DiskEvent...........................................................................................................................................................527
77. DiskForRemoval.............................................................................................................................................. 529
78. DiskHealthCheckSummary.......................................................................................................................... 531
79. DiskStat.............................................................................................................................................................. 533
80. Dns.......................................................................................................................................................................535
81. DnsEntries.......................................................................................................................................................... 537
82. Domain............................................................................................................................................................... 539
83. EncryptedBackup.......................................................................................................................................... 542
84. EncryptionConfiguration............................................................................................................................ 544
85. Entity.................................................................................................................................................................. 546
86. EntityFromTag................................................................................................................................................ 549
87. EntityToTag........................................................................................................................................................ 551
88. Event................................................................................................................................................................... 553
89. Events................................................................................................................................................................. 556
90. FSAdminUser...................................................................................................................................................558
91. FSPrincipalType...............................................................................................................................................560
92. FSQuotaPolicies............................................................................................................................................. 562
93. FSQuotaPolicy................................................................................................................................................ 564
94. FSStat.................................................................................................................................................................568
95. File....................................................................................................................................................................... 570
96. FileGroup...........................................................................................................................................................572
x
97. Fileserver........................................................................................................................................................... 574
98. FileServerByUuid........................................................................................................................................... 580
99. FileServerPulse................................................................................................................................................582
100. FileServershare............................................................................................................................................. 584
101. FileServerShares............................................................................................................................................ 586
102. FileServerUser............................................................................................................................................... 588
103. FileServerUsers.............................................................................................................................................. 591
104. FileServers...................................................................................................................................................... 593
105. FileServersUsage..........................................................................................................................................596
106. FileServershare............................................................................................................................................. 598
107. FileShare..........................................................................................................................................................600
108. Fileserver.........................................................................................................................................................602
109. FileserverSnapshot..................................................................................................................................... 608
110. FileserverSnapshots......................................................................................................................................610
111. FsShareStat........................................................................................................................................................ 612
112. GuestTool...........................................................................................................................................................614
113. HA......................................................................................................................................................................... 618
114. HardwareAlert..................................................................................................................................................621
115. HardwareEvent............................................................................................................................................... 623
116. HealthCheck.................................................................................................................................................... 625
117. Host..................................................................................................................................................................... 629
118. HostAlert............................................................................................................................................................631
119. HostEvent......................................................................................................................................................... 633
120. HostHealthCheckSummary.......................................................................................................................635
121. HostStat.............................................................................................................................................................637
122. HttpProxy.........................................................................................................................................................639
123. HttpProxyWhitelist.......................................................................................................................................643
124. IcapServer....................................................................................................................................................... 645
125. IcapServerStats............................................................................................................................................. 648
126. IcapServers..................................................................................................................................................... 650
127. Image................................................................................................................................................................. 653
128. InfectedFile..................................................................................................................................................... 658
129. InfectedFiles...................................................................................................................................................660
130. KeyManagementServer..............................................................................................................................665
131. KeyManagementServerType..................................................................................................................... 669
132. LDAPConnection............................................................................................................................................671
133. License.............................................................................................................................................................. 673
134. LicenseAlert....................................................................................................................................................675
135. LicenseAllowance......................................................................................................................................... 677
136. LicenseEvent.................................................................................................................................................. 679
137. MaintenanceMode..........................................................................................................................................681
138. MultiClusterAlert...........................................................................................................................................684
139. MultiClusterEvent......................................................................................................................................... 686
140. MultiClusterStat............................................................................................................................................ 688
141. NameServer.....................................................................................................................................................690
142. NameServices................................................................................................................................................ 693
143. Network............................................................................................................................................................695
144. NetworkAddressTable................................................................................................................................700
145. NetworkIP........................................................................................................................................................702
146. NfsDatastore.................................................................................................................................................. 705
147. NfsSubnetWhitelist...................................................................................................................................... 708
148. NfsSubnetWhitelist.......................................................................................................................................710
149. NtpServer..........................................................................................................................................................712
150. OutOfBandSchedule.................................................................................................................................... 715
151. PasswordProtection....................................................................................................................................... 718
152. PrincipalType..................................................................................................................................................720
xi
153. ProtectionDomain.........................................................................................................................................722
154. ProtectionDomainActive........................................................................................................................... 726
155. ProtectionDomainAlert...............................................................................................................................728
156. ProtectionDomainConsistencyGroup................................................................................................... 730
157. ProtectionDomainCronSchedule............................................................................................................. 732
158. ProtectionDomainEvent............................................................................................................................. 737
159. ProtectionDomainForRemoval................................................................................................................ 739
160. ProtectionDomainHealthCheckSummary............................................................................................ 741
161. ProtectionDomainInactive..........................................................................................................................743
162. ProtectionDomainPendingAction.......................................................................................................... 745
163. ProtectionDomainPendingReplication................................................................................................. 747
164. ProtectionDomainReplication................................................................................................................. 749
165. ProtectionDomainRetentionPolicy.........................................................................................................752
166. ProtectionDomainSnapshot..................................................................................................................... 755
167. ProtectionDomainStat.................................................................................................................................758
168. ProtectionDomainStatus........................................................................................................................... 760
169. ProtectionDomainStretchCluster........................................................................................................... 762
170. ProtectionDomainStretchTimeout.........................................................................................................766
171. ProtectionDomainVM...................................................................................................................................768
172. ProtectionStatus.............................................................................................................................................771
173. PublicKey..........................................................................................................................................................773
174. QuotaPolicies..................................................................................................................................................776
175. QuotaPolicy.....................................................................................................................................................778
176. RSyslogConfig................................................................................................................................................782
177. RSyslogServer................................................................................................................................................ 784
178. RSyslogServerModule................................................................................................................................. 788
179. RSyslogState................................................................................................................................................... 791
180. RSyslogStatus................................................................................................................................................793
181. RackableUnit................................................................................................................................................... 795
182. RecentCertificateTestResults................................................................................................................... 797
183. RemoteSite......................................................................................................................................................799
184. RemoteSiteAlert........................................................................................................................................... 805
185. RemoteSiteEvent..........................................................................................................................................807
186. RemoteSiteForRemoval.............................................................................................................................809
187. RemoteSiteHealthCheckSummary........................................................................................................... 811
188. RemoteSitePendingReplication............................................................................................................... 813
189. RemoteSiteSnapshot....................................................................................................................................815
190. RemoteSiteStat.............................................................................................................................................. 817
191. RemoteSupportSetting................................................................................................................................ 819
192. ServiceCenter.................................................................................................................................................. 821
193. Share..................................................................................................................................................................825
194. ShareInfectedFile...........................................................................................................................................831
195. ShareInfectedFiles........................................................................................................................................833
196. ShareStat......................................................................................................................................................... 835
197. ShareVirusScanPolicies............................................................................................................................... 837
198. ShareVirusScanPolicy.................................................................................................................................. 841
199. Shares............................................................................................................................................................... 843
200. SmtpServer................................................................................................................................................... 845
201. SmtpServerSecurityModeType............................................................................................................... 848
202. Snapshot.........................................................................................................................................................850
203. SnapshotForVDisk...................................................................................................................................... 855
204. SnapshotInfo.................................................................................................................................................857
205. SnapshotPolicies......................................................................................................................................... 859
206. SnapshotPolicy............................................................................................................................................. 861
207. SnmpInfo.........................................................................................................................................................865
208. SnmpProfile................................................................................................................................................... 867
xii
209. SnmpStatus................................................................................................................................................... 870
210. SnmpTransport.............................................................................................................................................. 872
211. SnmpTrap..........................................................................................................................................................875
212. SnmpUser........................................................................................................................................................ 879
213. SpotlightSearchResult................................................................................................................................ 883
214. StorageAlert................................................................................................................................................... 885
215. StorageEvent.................................................................................................................................................. 887
216. StoragePool.................................................................................................................................................... 889
217. StoragePoolAlert...........................................................................................................................................894
218. StoragePoolEvent.........................................................................................................................................896
219. StoragePoolStat............................................................................................................................................898
220. StretchFailureHandling.............................................................................................................................900
221. Subnets.............................................................................................................................................................902
222. Switch.............................................................................................................................................................. 904
223. SwitchCollectorConfig.............................................................................................................................. 906
224. SwitchConfig.................................................................................................................................................908
225. SwitchInterface.............................................................................................................................................. 912
226. SwitchInterfaceStat..................................................................................................................................... 914
227. Tag.......................................................................................................................................................................916
228. TaggedEntity.................................................................................................................................................920
229. Task................................................................................................................................................................... 922
230. UnprotectedVM............................................................................................................................................925
231. UserMapping...................................................................................................................................................927
232. VDisk..................................................................................................................................................................931
233. VDiskAlert.......................................................................................................................................................937
234. VDiskEvent.....................................................................................................................................................939
235. VDiskSnapshot.............................................................................................................................................. 941
236. VDiskStat........................................................................................................................................................ 943
237. VM...................................................................................................................................................................... 945
238. VMAlert........................................................................................................................................................... 947
239. VMDisk.............................................................................................................................................................949
240. VMEvent......................................................................................................................................................... 954
241. VMHealthCheckSummary......................................................................................................................... 956
242. VMMove...........................................................................................................................................................958
243. VMNIC..............................................................................................................................................................960
244. VMPowerOff..................................................................................................................................................964
245. VMPowerOn...................................................................................................................................................966
246. VMPowerState..............................................................................................................................................968
247. VMSnapshot...................................................................................................................................................970
248. VMStat............................................................................................................................................................. 972
249. VMVDisk..........................................................................................................................................................974
250. VMVirtualDisk............................................................................................................................................... 976
251. VStore................................................................................................................................................................978
252. VStoreProtection.......................................................................................................................................... 981
253. VirtualDisk...................................................................................................................................................... 983
254. VirtualDiskStat..............................................................................................................................................985
255. VirtualMachine.............................................................................................................................................. 987
256. VirusScanPolicy............................................................................................................................................995
257. VolumeDisk.................................................................................................................................................. 1000
258. VolumeGroup..............................................................................................................................................1004
259. VolumeGroups..............................................................................................................................................1013
xiii
Copyright............................................................................................................... 1015
License...................................................................................................................................................................... 1015
Conventions............................................................................................................................................................ 1015
Version...................................................................................................................................................................... 1015
1
NUTANIX REST API
The Nutanix REST APIs allow you to create scripts that run system administration commands
against the Nutanix cluster. The API enables the use of HTTP requests to get information about
the cluster as well as make changes to the configuration. Output from the commands are
returned in JSON format.
There are two versions of the Nutanix REST API.
• v1: The original Nutanix REST API.

• v2: An update of the v1 API. Users of the v1 API are encouraged to migrate to v2.
A complete list of REST API functions and parameters is available in the REST API Explorer
section of the Nutanix web console. In addition, the complete reference for the v2 Nutanix
API, including code samples in multiple languages, and tutorials are available at http://
developer.nutanix.com/.
Accessing the REST API Explorer

About this task
Nutanix provides a utility with the web console to help you get started with the REST API. The
Explorer displays the parameters and format for the API calls that can be included in scripts.
Sample API calls can be made to show the type of output you should expect to receive.
The v1 and v2 APIs can both be viewed in the REST API Explorer.
AOS | Nutanix REST API | 15

Procedure
1. Open the explorer for the desired version of the API.
» v1: Connect to the Nutanix web console, click the user icon in the upper-right corner of
the web console, and select REST API Explorer. In the explorer, select Version 1 from the
menu.
Figure 1: User menu

» v2: Connect to the Nutanix web console, click the user icon in the upper-right corner of
the web console, and select REST API Explorer. In the explorer, select Version 2 from the
menu.
Figure 2: API version selection

The REST API Explorer displays a list of the cluster objects that can be managed by the API.
Each line has four options:
• Show/Hide: Expand or reduce the detail shown for the object

• List Operations: Show all operations that can be run on this object
• Expand Operations: Show the detailed view of the operations that can be run on this
object

Figure 3: REST API Explorer
Tip: The objects are listed by a relative path that is appended to the base URL
https://management_ip_addr:9440/PrismGateway/services/rest/v[1,2,3]/api, where
management_ip_addr is the IP address of any Nutanix Controller VM in the cluster.
2. Find the line for the object you want to explore and click Expand Operations. For this
example, you will operate on a storage pool.
Figure 4: Cluster Operations

3. Click GET on the first line to show the details for this API call.
Figure 5: Get Cluster Details
The explorer displays the parameters that can be passed when this action is used.
4. Click Try it out! to test the API call when used with your cluster.
Figure 6: Get Cluster Details Response
The test displays the request URL required for scripting, as well as sample responses
expected from the API call.
Status Codes
The following status codes are implemented in the Nutanix REST API.

Table 1: REST API Status Codes
Status Code Definition

200 The API request was successful and received a response.
201 The API request was successful and created an object.

400 The API request was malformed and could not be processed.
401 You have no access and/or are not authorized.
403 You are authorized but do not have the privileges for this API.
404 The URL was not found.
405 The called method is not allowed or is not supported.
408 The request timed out (20 seconds maximum).

500 The API request was received but there was a server error.
503 Service unavailable at this time or too early to process.
505 HTTP other than 1.1 not supported.

2
ABOUT NUTANIX POWERSHELL
CMDLETS
Nutanix provides PowerShell cmdlets for interacting with a cluster.
The cmdlets are downloaded from a cluster and installed on a Windows workstation. Once they
are installed, clicking the NutanixCmdlets desktop shortcut launches a PowerShell window with
the Nutanix cmdlets loaded.
Installing PowerShell Cmdlets

Before you begin
Install PowerShell version 2 or higher and .NET framework 4.0 on the workstation.
Procedure
1. Sign in to the Nutanix web console.
2. Click the user icon in the upper-right corner of the web console and select Download
Cmdlets Installer.
3. After the installer completes downloading, double-click the installer and follow the prompts.
The cmdlets are installed and a desktop shortcut NutanixCmdlets is created. Double-click
the shortcut to start a PowerShell window that has the Nutanix cmdlets loaded.
PowerShell Cmdlets Usage

Cluster Connection
Before executing commands, the session must be connected to one or more Nutanix clusters.
> Connect-NutanixCluster -Server cluster_ip_address -UserName admin_username `
-Password admin_password
• Replace cluster_ip_address with the cluster virtual IP address or a Controller VM IP address.

• Replace admin_username with the Nutanix username (usually admin).
• Replace admin_password with the Nutanix user password.

Use multiple Connect-NutanixCluster statements to connect to multiple clusters. If the session
is connected to multiple clusters, use the Server parameter of other cmdlets to specify the
cluster for executing the command.
To disconnect from a connected cluster, run Disconnect-NutanixCluster with the IP address of
the server from which to disconnect.
AOS | About Nutanix PowerShell Cmdlets | 20

Connected cluster info
To get the details of the cluster you are connected to in a session, you can run the Get-
NutanixCluster cmdlet. In case of being connected to multiple clusters, you can run Get-
NutanixCluster -Server cvm_ip_addr to get the same output for each connected cluster.
Cmdlets version info

To get the version details of the cmdlets you are running, run the Get-NutanixCmdletsInfo
cmdlet.
Output parameters
Some cmdlets include the following options for output formatting.
Grid
Grid view output
Expand
Complete output in list format
By default, the output of some cmdlets contains only simple fields.
Enumerated Types
Some cmdlets take parameters that are enumerated types, but which are declared as type
string.
This table lists the valid values of enumerated types for the relevant cmdlets.
Cmdlet Name Parameter Name Valid Values
Set-NTNXSmtpServer SecureMode STARTTLS

SSL
NONE
Set-NTNXCluster SupportVerbosityType NOTHING

BASIC
BASIC_COREDUMP
ALL

Set-NTNXHealthCheck AffectedEntityTypes CLUSTER

HARDWARE
STORAGE
BACKUP
DR
DISK
STORAGE_TIER
HOST
NODE
MANAGEMENT_SERVER
VM SERVICE_VM
VDISK
VIRTUAL_DISK
STORAGE_POOL
CONTAINER
VZONE
SNAPSHOT
FAST_CLONE
REMOTE_SITE
PROTECTION_DOMAIN
CONSISTENCY_GROUP
REPLICATION
REPLICATION_LINK
VSTORE
New-NTNXRemoteSite Capabilities BACKUP

DISASTER_RECOVERY
Set-NTNXRemoteSite Capabilities BACKUP

DISASTER_RECOVERY
New-NTNXContainer FingerPrintOnWrite NONE

OFF
ON
New-NTNXContainer OnDiskDedup NONE

OFF
POST_PROCESS
Set-NTNXContainer FingerPrintOnWrite NONE

OFF
ON
Set-NTNXContainer OnDiskDedup NONE

OFF
POST_PROCESS

New-NTNXVdisk FingerPrintOnWrite NONE

OFF
ON
New-NTNXVdisk OnDiskDedup NONE

OFF
POST_PROCESS
Set-NTNXVdisk FingerPrintOnWrite NONE

OFF
ON
Set-NTNXVdisk OnDiskDedup NONE

OFF
POST_PROCESS
Add-NTNXAuthType InputList LOCAL

DIRECTORY_SERVICE
Add-NTNXDirectoryConfig DirectoryType ACTIVE_DIRECTORY
Add-NTNXDirectoryConfig ConnectionType LDAP
Remove-NTNXAuthType InputList LOCAL

DIRECTORY_SERVICE
Set-NTNXDirectoryConfig DirectoryType ACTIVE_DIRECTORY
Set-NTNXDirectoryConfig ConnectionType LDAP
Set-NTNXAuthType InputList LOCAL

DIRECTORY_SERVICE
Set-NTNXAuthConfig AuthTypeList LOCAL

DIRECTORY_SERVICE
Remove-NTNXSnmpTransport TransportProtocol TCP

TCP_6
UDP
UDP_6
Add-NTNXSnmpTransport TransportProtocol TCP

TCP_6
UDP
UDP_6
Add-NTNXSnmpUser AuthType MD_5

SHA

Add-NTNXSnmpUser privType DES

AES
Set-NTNXSnmpTrap TransportProtocol TCP

TCP_6
UDP
UDP_6
Set-NTNXSnmpUser AuthType MD_5

SHA
Set-NTNXSnmpUser privType DES

AES
Add-NTNXProtectionDomainCronSchedule Type MINUTELY

HOURLY
DAILY
WEEKLY
MONTHLY
Replace- Type MINUTELY

NTNXProtectionDomainCronSchedule HOURLY
DAILY
WEEKLY
MONTHLY
Object Creation and Referencing

Many Acropolis data transfer objects (DTOs) have nested or lists of DTOs that cannot be
exposed to the command line. The New-NTNXObject cmdlet creates a variable of the DTO that can
now be used for the Acropolis cmdlets. With this new cmdlet, you can provide lists or nested
DTOs to Acropolis cmdlets.
New-NTNXObject -Name dto_name
Replace dto_name with the name of the DTO.

1. To create a list of DTOs, use the New-NTNXObject cmdlet to assign a DTO to the parameters.
See Creating Object Lists on page 24.
2. To create nested DTOs, you can use the Template flag for completing additional fields. See
Creating Nested Objects with the Template Flag on page 25.
Creating Object Lists

This topic shows you how to use the New-NTNXObject cmdlet to create data transfer object (DTO)
lists. You can use the New-NTNXObject cmdlet to create object lists for a single object or for
multiple objects.
Procedure
1. Create a single null object. and store the object in a PowerShell variable to provide nested
DTOs or a list of DTOs and assign it to a specific DTO. Enter the cmdlet and assign it to a

variable for the DTO to store in PowerShell. You can also assign the fields related to the
DTO.
For example, the command looks similar to the following:
$null_object_name = New-NTNXObject -Name dto_name
Replace null_object_name with the null object name.

Replace dto_name with the DTO name.
2. Create multiple null objects. Create multiple null objects and assign them to a single DTO. To
create a list of DTOs for objects, create null objects for each DTO.
a. Create null objects and assign the DTOs to the null object to be used in the list of DTOs.
Specify the variables and DTOs for that list.
For example, to assign multiple null objects to a single DTO named Snappy....
$DTO1 = New-NTNXObject –Name SnapshotSpecDTO

$DTO2 = New-NTNXObject –Name SnapshotSpecDTO
Replace DTO1 and DTO2 with the names of the DTOs.
Creating Nested Objects with the Template Flag

The Template flag displays available fields for nested data transfer objects (DTOs) for POST,
PUT, and PATCH cmdlets. The Template flag is not supported for GET commands.
About this task
Procedure
1. Add the Template flag after the cmdlet and press the tab key to complete the fields.
Note: Add Format-Custom for preferred formatting.
For example, if you are using the Set-NTNXVMDisk cmdlet, the command might look similar to
the following.
$input = Set-NTNXVMDisk –Template | Format-Custom
2. If you know any fields for the cmdlet, add the fields to the command with the Template flag.
For example, entering additional fields and the Template flag might look similar to the
following.
$input = Set-NTNXVMDisk –Template –diskId “id” | Format-Custom

Part
I
REST API REFERENCE
This reference covers the v1 Nutanix API. The complete reference for the v2 Nutanix
API, including code samples in multiple languages, and tutorials are available at http://
developer.nutanix.com/
3
AOS | Alerts | 27

ALERTS
Get the list of Alerts
GET /alerts/
Table 2: Details
path /alerts/
method GET
nickname getAlerts
type get.base.EntityCollection<get.dto.alerts.AlertDTO>
Table 3: Parameters
Parameter Description Details
startTimeInUsecs Start time in microseconds paramType query
required false
type integer
endTimeInUsecs End time in microseconds paramType query
required false
type integer
count Maximum number of alerts paramType query
required false
type integer
resolved Alerts which have been resolved paramType query
required false
type boolean
autoResolved Alerts which have been auto paramType query

resolved
required false
type boolean
acknowledged Alerts which have been paramType query

acknowledged
required false
type boolean
severity Alert severities paramType query
AOS | Alerts | 28

required false
type string
alertTypeUuid Alert type ids paramType query
required false
type string
page Page number paramType query
required false
type integer
entityType Entity type paramType query
required false
type string
entityIds Entity ids paramType query
required false
type string
categories Categories paramType query
required false
type string
alertIds Alert ids paramType query
required false
type string
impacts Impacts paramType query
required false
type string
getCauses Get causes paramType query
required false
type boolean
clusterUuid Proxy Cluster Uuid paramType header
required false
type string
AOS | Alerts | 29

Table 4: get.base.EntityCollection<get.dto.alerts.AlertDTO>
Property Type Format
entities array
errorInfo get.base.ErrorInfo
metadata get.base.Metadata
Acknowledge Alerts
POST /alerts/acknowledge
Table 5: Details
path /alerts/acknowledge
method POST
nickname acknowledgeAlerts
type create.dto.alerts.ManageAlertsDTO
Table 6: Parameters
required false
type integer
required false
type integer
severity Severity paramType query
required false
type string
categories Categories of alerts paramType query
required false
type string
entityType Entity Type paramType query
required false
type string
entityTypeIds Entity Type Ids paramType query
AOS | Alerts | 30

required false
type string
required false
type integer
Table 7: create.dto.alerts.ManageAlertsDTO
alertStatusList array
numFailedUpdates integer int32
numSuccessfulUpdates integer int32
Get the Alert configuration

GET /alerts/configuration
Table 8: Details
path /alerts/configuration
method GET
nickname getAlertConfig
type get.dto.appliance.configuration.AlertConfigDTO
Table 9: get.dto.appliance.configuration.AlertConfigDTO
defaultNutanixEmail string
emailConfigRules array
emailContactList array
emailTemplate get.dto.appliance.configuration.AlertConfigDTO
$EmailTemplate
enable boolean
enableDefaultNutanixEmail boolean
enableEmailDigest boolean
skipEmptyAlertEmailDigest boolean
AOS | Alerts | 31

smtpServer get.dto.appliance.configuration.SmtpServerDTO
tunnelDetails get.dto.appliance.configuration.RemoteTunnelDetailsDTO
Modify the Alert configuration

PATCH /alerts/configuration
Table 10: Details
method PATCH
nickname patchAlertConfig
type patch.dto.appliance.configuration.AlertConfigDTO
Table 11: Parameters
new Alert configuration. paramType body
required true
type patch.dto.RequestDTO<patch.
Table 12: patch.dto.appliance.configuration.AlertConfigDTO
emailTemplate patch.dto.appliance.configuration.AlertConfigDTO
$EmailTemplate
enable boolean
smtpServer patch.dto.appliance.configuration.SmtpServerDTO
tunnelDetails patch.dto.appliance.configuration.RemoteTunnelDetailsDTO
AOS | Alerts | 32

Update the Alert configuration
PUT /alerts/configuration
Table 13: Details
method PUT
nickname updateAlertConfig
type update.dto.appliance.configuration.AlertConfigDTO
new Alert configuration. paramType body
required true
type update.dto.appliance.configura
Table 15: update.dto.appliance.configuration.AlertConfigDTO
emailTemplate update.dto.appliance.configuration.AlertConfigDTO
$EmailTemplate
enable boolean
smtpServer update.dto.appliance.configuration.SmtpServerDTO
tunnelDetails update.dto.appliance.configuration.RemoteTunnelDetailsDTO
Get the list of hardware Alerts

GET /alerts/hardware
AOS | Alerts | 33

Table 16: Details
path /alerts/hardware
method GET
nickname getHardwareAlerts
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
AOS | Alerts | 34

required false
type string
entities array
Resolve Alerts
POST /alerts/resolve
Table 19: Details
path /alerts/resolve
method POST
nickname resolveAlerts
required false
type integer
required false
type integer
required false
type string
categories Categories of alerts paramType query
required false
AOS | Alerts | 35

type string
required false
type string
required false
type string
required false
type integer
Get the list of storage Alerts

GET /alerts/storage
Table 22: Details
path /alerts/storage
method GET
nickname getStorageAlerts
required false
type integer
AOS | Alerts | 36

required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
required false
type string
entities array
Acknowledge Alert
POST /alerts/{id}/acknowledge
AOS | Alerts | 37

Table 25: Details
path /alerts/{id}/acknowledge
method POST
nickname acknowledgeAlert
type create.dto.alerts.ResolveAcknowledgeAlertDTO
id Alert Id paramType path
required true
type string
Table 27: create.dto.alerts.ResolveAcknowledgeAlertDTO
id string
message string
successful boolean
Resolve Alert
POST /alerts/{id}/resolve
Table 28: Details
path /alerts/{id}/resolve
method POST
nickname resolveAlert
type create.dto.alerts.ResolveAcknowledgeAlertDTO
id Alert Id paramType path
required true
type string
AOS | Alerts | 38

Table 30: create.dto.alerts.ResolveAcknowledgeAlertDTO
id string
message string
successful boolean
AOS | Alerts | 39

4
AOS | Authconfig | 40

AUTHCONFIG
Delete Auth config
DELETE /authconfig/
Table 31: Details
path /authconfig/
method DELETE
nickname deleteAuthConfig
type delete.dto.PrimitiveDTO<java.lang.Boolean>
Table 32: delete.dto.PrimitiveDTO<java.lang.Boolean>
value boolean
Get Auth configuration

GET /authconfig/
Table 33: Details
path /authconfig/
method GET
nickname getAuthConfig
type get.auth.dto.config.AuthConfigDTO
Table 34: get.auth.dto.config.AuthConfigDTO
authTypeList array
directoryList array
Modify Auth configuration

PATCH /authconfig/

Table 35: Details
path /authconfig/
method PATCH
nickname patchAuthConfig
type patch.auth.dto.config.AuthConfigDTO
an AuthConfigDTO instance paramType body
required true
Table 37: patch.auth.dto.config.AuthConfigDTO
authTypeList array
directoryList array
Update Auth configuration

PUT /authconfig/
Table 38: Details
path /authconfig/
method PUT
nickname updateAuthConfig
type update.auth.dto.config.AuthConfigDTO
an AuthConfigDTO instance paramType body
required true
type update.auth.dto.config.AuthCo

Table 40: update.auth.dto.config.AuthConfigDTO
authTypeList array
directoryList array
Add Auth types

POST /authconfig/add_auth_types
Table 41: Details
path /authconfig/add_auth_types
method POST
nickname addAuthTypes
type Array of
List of Auth types paramType body
required true
type array
Get Auth types

GET /authconfig/auth_types
Table 43: Details
path /authconfig/auth_types
method GET
nickname getAuthTypes
type Array of
Update Auth types

PUT /authconfig/auth_types

Table 44: Details
path /authconfig/auth_types
method PUT
nickname setAuthTypes
type update.auth.dto.config.AuthConfigDTO
required true
type array
Table 46: update.auth.dto.config.AuthConfigDTO
authTypeList array
directoryList array
Get client authentication status

GET /authconfig/client_auth/
Table 47: Details
path /authconfig/client_auth/
method GET
nickname getClientAuth
type get.auth.dto.config.ClientAuthDTO
Table 48: get.auth.dto.config.ClientAuthDTO
autoLoginInfo get.auth.dto.config.AutoLoginInfoDTO
caChainInfo get.auth.dto.config.CaChainDTO
certRevocationInfo get.auth.dto.config.CertRevocationInfoDTO

Enable/disable client authentication
POST /authconfig/client_auth/
Table 49: Details
method POST
nickname setClientAuthState
type create.auth.dto.config.CaChainDTO
Enable client auth paramType body
required true
type create.dto.PrimitiveDTO<java.l
Table 51: create.auth.dto.config.CaChainDTO
caChain array
enableClientAuth boolean
name string
Update client authentication

PUT /authconfig/client_auth/
Table 52: Details
method PUT
nickname updateClientAuth
type update.auth.dto.config.ClientAuthDTO

Client auth updates paramType body
required true
type update.auth.dto.config.ClientA
Table 54: update.auth.dto.config.ClientAuthDTO
autoLoginInfo update.auth.dto.config.AutoLoginInfoDTO
caChainInfo update.auth.dto.config.CaChainDTO
certRevocationInfo update.auth.dto.config.CertRevocationInfoDTO
Delete client chain certificate for authentication

DELETE /authconfig/client_auth/{name}
Table 55: Details
path /authconfig/client_auth/{name}
method DELETE
nickname deleteClientAuthChain
name Name of the Certificate paramType path
required true
type string
value boolean

Get the list of Directories
GET /authconfig/directories/
Table 58: Details
path /authconfig/directories/
method GET
nickname getAllDirectoryConfigs
type Array of get.auth.dto.config.DirectoryConfigDTO
Modify Directory
PATCH /authconfig/directories/
Table 59: Details
method PATCH
nickname patchDirectoryConfig
type patch.auth.dto.config.DirectoryConfigDTO
A Directory instance paramType body
required true
Table 61: patch.auth.dto.config.DirectoryConfigDTO
connectionType string
directoryType string
directoryUrl string
domain string
groupSearchType string
name string

openLdapConfig patch.auth.dto.config.OpenLdapConfigDTO
serviceAccountPassword string
serviceAccountUsername string
Add Directory
POST /authconfig/directories/
Table 62: Details
method POST
nickname addDirectoryConfig
type create.auth.dto.config.DirectoryConfigDTO
required true
type create.auth.dto.config.Director
Table 64: create.auth.dto.config.DirectoryConfigDTO
directoryUrl string
domain string
name string
openLdapConfig create.auth.dto.config.OpenLdapConfigDTO

Edit Directory
PUT /authconfig/directories/
Table 65: Details
method PUT
nickname updateDirectoryConfig
type update.auth.dto.config.DirectoryConfigDTO
required true
type update.auth.dto.config.Directo
Table 67: update.auth.dto.config.DirectoryConfigDTO
directoryUrl string
domain string
name string
openLdapConfig update.auth.dto.config.OpenLdapConfigDTO
Test LDAP directory connection status

POST /authconfig/directories/connection_status
Table 68: Details
path /authconfig/directories/connection_status

method POST
nickname testConnection
type create.dto.PrimitiveDTO<java.lang.Boolean>
Username, active directory name paramType body

and password to authenticate
required true
type create.auth.dto.config.TestDire
Table 70: create.dto.PrimitiveDTO<java.lang.Boolean>
value boolean
Delete Directory
DELETE /authconfig/directories/{name}
Table 71: Details
path /authconfig/directories/{name}
method DELETE
nickname deleteDirectoryConfig
name Name of the Directory paramType path
required true
type string

value boolean
Get Directory
GET /authconfig/directories/{name}
Table 74: Details
path /authconfig/directories/{name}
method GET
nickname getDirectoryConfig
type get.auth.dto.config.DirectoryConfigDTO
name Name of the Directory paramType path
required true
type string
Table 76: get.auth.dto.config.DirectoryConfigDTO
directoryUrl string
domain string
name string
openLdapConfig get.auth.dto.config.OpenLdapConfigDTO
Remove Auth types

POST /authconfig/remove_auth_types

Table 77: Details
path /authconfig/remove_auth_types
method POST
nickname deleteAuthTypes
type Array of
required true
type array
5
AOS | Cloud | 53

CLOUD
Remove all cloud credentials
DELETE /cloud/{cloudType}/credentials
Table 79: Details
path /cloud/{cloudType}/credentials
method DELETE
nickname removeAllCredentials
cloudType Cloud type paramType path
required true
type string
value boolean
Get cloud credentials

GET /cloud/{cloudType}/credentials
Table 82: Details
method GET
nickname getCredentials
type get.base.EntityCollection<get.dto.dr.CloudCredentialsDTO>
AOS | Cloud | 54

required true
type string
count Maximum number of cloud paramType query

credentials to retrieve
required false
type integer
filterCriteria Filter criteria paramType query
required false
type string
sortCriteria Sort criteria paramType query
required false
type string
Table 84: get.base.EntityCollection<get.dto.dr.CloudCredentialsDTO>
entities array
Add a cloud credential

POST /cloud/{cloudType}/credentials
Table 85: Details
method POST
nickname addCredentials
type create.dto.dr.CloudCredentialsDTO
AOS | Cloud | 55

required true
type string
An instance of CloudCredentialsDTO paramType body
required true
type create.dto.dr.CloudCredentials
Table 87: create.dto.dr.CloudCredentialsDTO
awsCredential create.dto.dr.AwsCredentialDTO
azureCredential create.dto.dr.AzureCredentialDTO
credentialID integer int64
name string
useAsDefault boolean
Remove a cloud credential

DELETE /cloud/{cloudType}/credentials/{name}
Table 88: Details
path /cloud/{cloudType}/credentials/{name}
method DELETE
nickname removeCredentials
required true
type string
name Name of the credential paramType path
AOS | Cloud | 56

required true
type string
value boolean
Update a cloud credential

PUT /cloud/{cloudType}/credentials/{name}
Table 91: Details
path /cloud/{cloudType}/credentials/{name}
method PUT
nickname updateCredentials
type update.dto.PrimitiveDTO<java.lang.Boolean>
required true
type string
name Name of the credential paramType path
required true
type string
An instance of CloudCredentialsDTO paramType body
required true
type update.dto.dr.CloudCredential
Table 93: update.dto.PrimitiveDTO<java.lang.Boolean>
value boolean
AOS | Cloud | 57

Get a list of CVMs
GET /cloud/{cloudType}/cvms
Table 94: Details
path /cloud/{cloudType}/cvms
method GET
nickname getCvms
type get.base.EntityCollection<get.dto.dr.CloudCvmDTO>
required true
type string
region Region paramType query
required true
type string
credentialName Name of the credential paramType query
required false
type string
count Maximum number of cloud cvms to paramType query

retrieve
required false
type integer
required false
type string
required false
type string
AOS | Cloud | 58

Table 96: get.base.EntityCollection<get.dto.dr.CloudCvmDTO>
entities array
Set a default cloud credential to use

POST /cloud/{cloudType}/default-credentials
Table 97: Details
path /cloud/{cloudType}/default-credentials
method POST
nickname setDefaultCredentials
type create.dto.dr.CloudCredentialsDTO
required true
type string
Name of the credential paramType body
required true
Table 99: create.dto.dr.CloudCredentialsDTO
awsCredential create.dto.dr.AwsCredentialDTO
azureCredential create.dto.dr.AzureCredentialDTO
credentialID integer int64
name string
useAsDefault boolean
AOS | Cloud | 59

Deploy a cloud CVM and create a remote site
POST /cloud/{cloudType}/deploy_remote_site
Table 100: Details
path /cloud/{cloudType}/deploy_remote_site
method POST
nickname deployRemoteSite
type create.dto.dr.RemoteSiteDTO
required true
type string
An instance of paramType body

DeployCloudRemoteSiteRequestDTO
required false
type create.dto.dr.DeployCloudRem
Table 102: create.dto.dr.RemoteSiteDTO
alertSummary create.dto.alerts.AlertSummaryDTO
bandwidthPolicy create.dto.dr.BandwidthPolicyDTO
bandwidthPolicyEnabled boolean
capabilities array
cloudType string
clusterExternalDataServicesAddress create.common.Address
clusterExternalDataServicesIPAddress string
clusterId integer int64
clusterIncarnationId integer int64
compressionEnabled boolean
credentialName string
cvmName string
AOS | Cloud | 60

healthSummary create.dto.health.check.HealthSummaryDTO
latencyInUsecs integer int64
markedForRemoval boolean
maxBps integer int32
metroReady boolean
name string
networkMapping create.dto.dr.NetworkMappingDTO
proxyEnabled boolean
region string
remoteDrExternalSubnet string
remoteDrExternalSubnetAddress create.common.Address
remoteIpAddressPorts java.util.Map<java.lang.String,
java.lang.Integer>
remoteIpPorts java.util.Map<java.lang.String,
java.lang.Integer>
remoteVStoreInfo java.util.Map<java.lang.String,
create.dto.dr.RemoteSiteDTO
$VStoreInfo>
replicationLinks array
sshEnabled boolean
stats java.util.Map<java.lang.String,
java.lang.String>
status string
usageStats java.util.Map<java.lang.String,
java.lang.String>
uuid string
vstoreNameMap java.util.Map<java.lang.String,
java.lang.String>
Get a list of CVM images

GET /cloud/{cloudType}/images
Table 103: Details
path /cloud/{cloudType}/images
method GET
AOS | Cloud | 61

nickname getCvmImages
type get.base.EntityCollection<get.dto.dr.CloudCvmImageDTO>
required true
type string
required false
type string
region Region of the cvm image paramType query
required false
type string
count Maximum number of cloud images paramType query

to retrieve
required false
type integer
required false
type string
required false
type string
listLocalOnly Is list local, to be specified only for paramType query

Azure cloud type
required false
type boolean
Table 105: get.base.EntityCollection<get.dto.dr.CloudCvmImageDTO>
entities array
AOS | Cloud | 62

Get a list of subnets
GET /cloud/{cloudType}/subnets
Table 106: Details
path /cloud/{cloudType}/subnets
method GET
nickname getSubnets
type get.base.EntityCollection<get.dto.dr.SubnetDTO>
required true
type string
region Region paramType query
required true
type string
required false
type string
count Maximum number of subnets to paramType query

retrieve
required false
type integer
required false
type string
required false
type string
AOS | Cloud | 63

Table 108: get.base.EntityCollection<get.dto.dr.SubnetDTO>
entities array
6
AOS | Cluster | 65

CLUSTER
Get Cluster details
GET /cluster/
Table 109: Details
path /cluster/
method GET
nickname getClusterInfo
type get.dto.appliance.configuration.ClusterDTO
Table 110: get.dto.appliance.configuration.ClusterDTO
alertSummary get.dto.alerts.AlertSummaryDTO
allHypervNodesInFailoverCluster boolean
blockSerials array
cloudcluster boolean
clusterArch string
clusterDataState get.dto.multicluster.ClusterDataStateDTO
clusterExternalAddress array
clusterExternalDataServicesAddress get.common.Address
clusterExternalIPAddress string
clusterFullyQualifiedDomainName string
clusterFunctions array
clusterGpus array
clusterMasqueradingAddress get.common.Address
clusterMasqueradingIPAddress string
clusterMasqueradingPort integer int32
clusterRedundancyState get.dto.appliance.configuration.ClusterRedundancyStateDTO
clusterUsageCriticalAlertThresholdPct integer int32
AOS | Cluster | 66

clusterUsageWarningAlertThresholdPct integer int32
clusterUuid string
commonCriteriaMode boolean
credential get.dto.hyperv.CredentialDTO
disableDegradedNodeMonitoring boolean
domain string
enableEfficientMetricSync boolean
enableLockDown boolean
enableOnDiskDedup boolean
enablePasswordRemoteLoginToCluster boolean
enableRebuildReservation boolean
enableRf1Container boolean
enableShadowClones boolean
encrypted boolean
enforceRackableUnitAwarePlacement boolean
externalAddress array
externalSubnet string
faultToleranceDomainType string
fingerprintContentCachePercentage integer int32
fullVersion string
globalNfsWhiteList array
globalNfsWhiteListAddress array
gpuDriverVersion string
hasSelfEncryptingDrive boolean
healthSummary get.dto.health.check.HealthSummaryDTO
httpProxies array
hypervisorLldpConfig get.dto.appliance.configuration.ClusterDTO
$HypervisorLldpConfigDTO
hypervisorSecurityComplianceConfig get.dto.appliance.configuration.ClusterDTO
$HypervisorSecurityComplianceConfigDTO
hypervisorTypes array
id string
internalAddress array
AOS | Cluster | 67

internalSubnet string
isLTS boolean
isNSEnabled boolean
isRegisteredToPC boolean
isSspEnabled boolean
isUpgradeInProgress boolean
iscsiConfig get.dto.appliance.configuration.ClusterDTO
$IscsiConfig
managementServers array
multicluster boolean
name string
nameServers array
nameServersList array
nccVersion string
nosClusterAndHostsDomainJoined boolean
ntpServers array
ntpServersList array
numNodes integer int64
operationMode string
publicKeys array
rackableUnits array
recycleBinDTO get.dto.appliance.configuration.RecycleBinDTO
securityComplianceConfig get.dto.appliance.configuration.ClusterDTO
$SecurityComplianceConfigDTO
segmentedIscsiDataServicesAddress array
segmentedIscsiDataServicesIPAddress string
serviceCenters array
ssdPinningPercentageLimit integer int32
java.lang.String>
storageType string
supportVerbosityType string
targetVersion string
AOS | Cluster | 68

thresholdForStorageThinProvision number double
timezone string
java.lang.String>
uuid string
version string
Modify Cluster params

PATCH /cluster/
Table 111: Details
path /cluster/
method PATCH
nickname patchClusterParams
type patch.dto.PrimitiveDTO<java.lang.Boolean>
A Cluster instance paramType body
required true
Table 113: patch.dto.PrimitiveDTO<java.lang.Boolean>
value boolean
Update Cluster params

PUT /cluster/
Table 114: Details
path /cluster/
method PUT
AOS | Cluster | 69

nickname editClusterParams
A Cluster instance paramType body
required true
value boolean
Start block aware fixer

POST /cluster/block_aware_fixer/start/
Table 117: Details
path /cluster/block_aware_fixer/start/
method POST
nickname cassandraBlockAwareFixerStart
value boolean
Stop block aware fixer

POST /cluster/block_aware_fixer/stop/
Table 119: Details
path /cluster/block_aware_fixer/stop/
method POST
AOS | Cluster | 70

nickname cassandraBlockAwareFixerStop
value boolean
Add Witness VM details

POST /cluster/metro_witness
Table 121: Details
path /cluster/metro_witness
method POST
nickname addMAWitness
type create.dto.dr.WitnessSiteDTO
Witness VM details paramType body
required true
type create.dto.dr.WitnessSiteDTO
testOnly Witness VM details paramType query
required false
type boolean
Table 123: create.dto.dr.WitnessSiteDTO
addressList array
clusterName string
clusterTimestampUsecs integer int64
clusterUuid string
ipAddresses array
AOS | Cluster | 71

nosFullVersion string
nosVersion string
password string
username string
uuid string
witnessName string
List All Metro Availability Witnesses

GET /cluster/metro_witness/
Table 124: Details
path /cluster/metro_witness/
method GET
nickname getAllMAWitnesses
type Array of get.dto.dr.WitnessSiteDTO
Delete a Metro Availability Witness

DELETE /cluster/metro_witness/{uuid}
Table 125: Details
path /cluster/metro_witness/{uuid}
method DELETE
nickname removeWitnessSite
uuid MA Witness uuid paramType path
required true
type string
AOS | Cluster | 72

recover recover from an unsuccessful delete paramType query

operation
required false
type boolean
value boolean
Update a Metro Availability Witness

PUT /cluster/metro_witness/{uuid}
Table 128: Details
path /cluster/metro_witness/{uuid}
method PUT
nickname updateWitnessSite
type update.dto.dr.WitnessSiteDTO
uuid MA Witness uuid paramType path
required true
type string
MA Witness update details paramType body
required true
type update.dto.dr.WitnessSiteDTO
$UpdateWitnessSiteDTO
Table 130: update.dto.dr.WitnessSiteDTO
addressList array
clusterName string
AOS | Cluster | 73

clusterTimestampUsecs integer int64
clusterUuid string
ipAddresses array
nosFullVersion string
nosVersion string
password string
username string
uuid string
witnessName string
Get the list of Name Servers

GET /cluster/name_servers
Table 131: Details
path /cluster/name_servers
method GET
nickname getNameServers
type Array of java.lang.Object
Add name server

POST /cluster/name_servers
Table 132: Details
path /cluster/name_servers
method POST
nickname addNameServer
Name of a name server paramType body
AOS | Cluster | 74

required true
type create.common.Address
$PrimitiveDTOCompatible
value boolean
Delete the specified Name Server

DELETE /cluster/name_servers/{nameServer}
Table 135: Details
path /cluster/name_servers/{nameServer}
method DELETE
nickname removeNameServer
nameServer Name of a name server paramType path
required true
type string
value boolean
Get NFS subnet whitelist

GET /cluster/nfs_whitelist
AOS | Cluster | 75

Table 138: Details
path /cluster/nfs_whitelist
method GET
nickname getNfsSubnetWhitelist
Add NFS subnet whitelist entry

POST /cluster/nfs_whitelist
Table 139: Details
path /cluster/nfs_whitelist
method POST
nickname addNfsSubnetWhitelist
NFS Whilelist paramType body
required true
value boolean
Delete NFS the specified subnet whitelist entry

DELETE /cluster/nfs_whitelist/{name:.+}
Table 142: Details
path /cluster/nfs_whitelist/{name:.+}
method DELETE
nickname removeNfsSubnetWhitelist
AOS | Cluster | 76

name NFS Whitelist paramType path
required true
type string
value boolean
Get the list of NTP servers

GET /cluster/ntp_servers
Table 145: Details
path /cluster/ntp_servers
method GET
nickname getNtpServers
Add NTP server

POST /cluster/ntp_servers
Table 146: Details
path /cluster/ntp_servers
method POST
nickname addNtpServer
AOS | Cluster | 77

Name of NTP server paramType body
required true
value boolean
Delete an NTP server

DELETE /cluster/ntp_servers/{ntpServer}
Table 149: Details
path /cluster/ntp_servers/{ntpServer}
method DELETE
nickname removeNtpServer
ntpServer Name of NTP server paramType path
required true
type string
value boolean
Get the list of Public Keys

GET /cluster/public_keys
AOS | Cluster | 78

Table 152: Details
path /cluster/public_keys
method GET
nickname getPublicKeys
type Array of get.dto.appliance.configuration.ClusterDTO

$PublicKeyDTO
Add a Public Key

POST /cluster/public_keys/
Table 153: Details
path /cluster/public_keys/
method POST
nickname addPublicKey
type create.dto.appliance.configuration.ClusterDTO$PublicKeyDTO
A Public Key instance paramType body
required true
type create.dto.appliance.configura
$PublicKeyDTO
Table 155: create.dto.appliance.configuration.ClusterDTO$PublicKeyDTO
key string
name string
Delete a Public Key

DELETE /cluster/public_keys/{name}
Table 156: Details
path /cluster/public_keys/{name}
AOS | Cluster | 79

method DELETE
nickname deletePublicKey
name Name of the Public Key paramType path
required true
type string
value boolean
Get a Public Key

GET /cluster/public_keys/{name}
Table 159: Details
path /cluster/public_keys/{name}
method GET
nickname getPublicKey
type get.dto.appliance.configuration.ClusterDTO$PublicKeyDTO
name Name of the Public Key paramType path
required true
type string
AOS | Cluster | 80

Table 161: get.dto.appliance.configuration.ClusterDTO$PublicKeyDTO
key string
name string
Get the list of Rackable Units

GET /cluster/rackable_units
Table 162: Details
path /cluster/rackable_units
method GET
nickname getRackableUnits
type Array of get.dto.appliance.configuration.RackableUnitDTO
Delete the specified Rackable Unit

DELETE /cluster/rackable_units/{id}
Table 163: Details
path /cluster/rackable_units/{id}
method DELETE
nickname deleteRackableUnit
id Id of a Rackable Unit paramType path
required true
type string
value boolean
AOS | Cluster | 81

Get the specified Rackable Unit
GET /cluster/rackable_units/{id}
Table 166: Details
path /cluster/rackable_units/{id}
method GET
nickname getRackableUnit
type get.dto.appliance.configuration.RackableUnitDTO
id Id of a Rackable Unit paramType path
required true
type string
Table 168: get.dto.appliance.configuration.RackableUnitDTO
id integer int64
location string
model string
modelName string
nodeUuids array
nodes array
positions array
rackableUnitUuid string
serial string
Get Remote Support settings

GET /cluster/remote_support
Table 169: Details
path /cluster/remote_support
AOS | Cluster | 82

method GET
nickname getRemoteSupportStatus
type get.dto.appliance.configuration.RemoteSupportConfigDTO
Table 170: get.dto.appliance.configuration.RemoteSupportConfigDTO
enable get.dto.appliance.configuration.TimedBoolDTO
tunnelDetails get.dto.appliance.configuration.RemoteTunnelDetailsDTO
Update Remote Support settings

PUT /cluster/remote_support
Table 171: Details
path /cluster/remote_support
method PUT
nickname editRemoteSupport
A Timed Bool instance paramType body
required true
value boolean
Get spotlight search results

GET /cluster/search/
AOS | Cluster | 83

Table 174: Details
path /cluster/search/
method GET
nickname doSpotlightSearch
type Array of
get.dto.appliance.configuration.SpotlightSearchResultDTO
searchString Search string paramType query
required true
type string
entityTypes Entity types paramType query
required false
type array
fieldNames Field Names paramType query
required false
type array
maxCount Maximum entities to retrieve, the paramType query

default value is 100
required false
type integer
Delete SMTP server config

DELETE /cluster/smtp
Table 176: Details
path /cluster/smtp
method DELETE
nickname removeSmtpServer
AOS | Cluster | 84

value boolean
Get the SMTP server config

GET /cluster/smtp
Table 178: Details
path /cluster/smtp
method GET
nickname getSmtpServer
type get.dto.appliance.configuration.SmtpServerDTO
Table 179: get.dto.appliance.configuration.SmtpServerDTO
address string
emailStatus get.dto.base.CommunicationStatusDTO
fromEmailAddress string
password string
port integer int32
secureMode string
serverAddress get.common.Address
username string
Modify the SMTP server config

PATCH /cluster/smtp
Table 180: Details
path /cluster/smtp
method PATCH
nickname patchSmtpServer
type patch.dto.appliance.configuration.SmtpServerDTO
AOS | Cluster | 85

An SMTP Server instance paramType body
required true
Table 182: patch.dto.appliance.configuration.SmtpServerDTO
address string
emailStatus patch.dto.base.CommunicationStatusDTO
password string
port integer int32
secureMode string
serverAddress patch.common.Address
username string
Update the SMTP server config

PUT /cluster/smtp
Table 183: Details
path /cluster/smtp
method PUT
nickname updateSmtpServer
type update.dto.appliance.configuration.SmtpServerDTO
An SMTP Server instance paramType body
required false
AOS | Cluster | 86

Table 185: update.dto.appliance.configuration.SmtpServerDTO
address string
emailStatus update.dto.base.CommunicationStatusDTO
password string
port integer int32
secureMode string
serverAddress update.common.Address
username string
Get the SMTP security modes

GET /cluster/smtp/security_modes
Table 186: Details
path /cluster/smtp/security_modes
method GET
nickname getSmtpServerSecurityModeType
type Array of
Get the list of Cluster stats

GET /cluster/stats/
Table 187: Details
path /cluster/stats/
method GET
nickname getClusterStats
type get.data.StatsResponse
metrics List of metrics paramType query
required true
AOS | Cluster | 87

type array
required true
type integer
required true
type integer
intervalInSecs Sampling interval of stats paramType query
required true
type integer
Table 189: get.data.StatsResponse
statsSpecificResponses array
7
AOS | Clusters | 89

CLUSTERS
Get the list of clusters
GET /clusters/
Table 190: Details
path /clusters/
method GET
nickname getClusters
type get.base.EntityCollection<get.dto.appliance.configuration.ClusterDTO>
count Number of Clusters to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
searchAttributeListSearch attribute list paramType query
required false
type array
required false
type integer
projection Projections on the attributes paramType query
AOS | Clusters | 90

required false
type string
Table 192: get.base.EntityCollection<get.dto.appliance.configuration.ClusterDTO>
entities array
Get the list of alerts generated on any Cluster

GET /clusters/alerts
Table 193: Details
path /clusters/alerts
method GET
nickname getClusterAlerts
required false
type integer
required false
type integer
required false
type integer
required false
AOS | Clusters | 91

type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on any Cluster

GET /clusters/events
Table 196: Details
path /clusters/events
method GET
nickname getClusterEvents
AOS | Clusters | 92

required false
type integer
required false
type integer
count Maximum number of events paramType query
required false
type integer
acknowledged Events which have been paramType query

acknowledged
required false
type boolean
required false
type integer
entities array
Get a Cluster
GET /clusters/{id}
Table 199: Details
path /clusters/{id}
method GET
nickname getCluster
type get.dto.appliance.configuration.ClusterDTO
AOS | Clusters | 93

id Id of the cluster paramType path
required true
type string
required false
type string
Table 201: get.dto.appliance.configuration.ClusterDTO
allHypervNodesInFailoverCluster boolean
blockSerials array
cloudcluster boolean
clusterArch string
clusterDataState get.dto.multicluster.ClusterDataStateDTO
clusterExternalAddress array
clusterExternalIPAddress string
clusterFullyQualifiedDomainName string
clusterFunctions array
clusterGpus array
clusterMasqueradingAddress get.common.Address
clusterMasqueradingIPAddress string
clusterMasqueradingPort integer int32
clusterRedundancyState get.dto.appliance.configuration.ClusterRedundancyStateDTO
clusterUsageCriticalAlertThresholdPct integer int32
clusterUsageWarningAlertThresholdPct integer int32
clusterUuid string
commonCriteriaMode boolean
AOS | Clusters | 94

credential get.dto.hyperv.CredentialDTO
disableDegradedNodeMonitoring boolean
domain string
enableEfficientMetricSync boolean
enableLockDown boolean
enableOnDiskDedup boolean
enablePasswordRemoteLoginToCluster boolean
enableRebuildReservation boolean
enableRf1Container boolean
enableShadowClones boolean
encrypted boolean
enforceRackableUnitAwarePlacement boolean
externalAddress array
externalSubnet string
faultToleranceDomainType string
fingerprintContentCachePercentage integer int32
fullVersion string
globalNfsWhiteList array
globalNfsWhiteListAddress array
hasSelfEncryptingDrive boolean
httpProxies array
hypervisorLldpConfig get.dto.appliance.configuration.ClusterDTO
$HypervisorLldpConfigDTO
hypervisorSecurityComplianceConfig get.dto.appliance.configuration.ClusterDTO
$HypervisorSecurityComplianceConfigDTO
hypervisorTypes array
id string
internalAddress array
internalSubnet string
isLTS boolean
isNSEnabled boolean
AOS | Clusters | 95

isRegisteredToPC boolean
isSspEnabled boolean
isUpgradeInProgress boolean
iscsiConfig get.dto.appliance.configuration.ClusterDTO
$IscsiConfig
managementServers array
multicluster boolean
name string
nameServers array
nameServersList array
nccVersion string
nosClusterAndHostsDomainJoined boolean
ntpServers array
ntpServersList array
numNodes integer int64
operationMode string
publicKeys array
rackableUnits array
recycleBinDTO get.dto.appliance.configuration.RecycleBinDTO
securityComplianceConfig get.dto.appliance.configuration.ClusterDTO
$SecurityComplianceConfigDTO
segmentedIscsiDataServicesAddress array
segmentedIscsiDataServicesIPAddress string
serviceCenters array
ssdPinningPercentageLimit integer int32
java.lang.String>
storageType string
supportVerbosityType string
targetVersion string
thresholdForStorageThinProvision number double
timezone string
AOS | Clusters | 96

java.lang.String>
uuid string
version string
Get the list of alerts generated on a specified Cluster

GET /clusters/{id}/alerts
Table 202: Details
path /clusters/{id}/alerts
method GET
nickname getAlertsForCluster
id Id of a Cluster paramType path
required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean
AOS | Clusters | 97


acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on a specified Cluster

GET /clusters/{id}/events
Table 205: Details
path /clusters/{id}/events
method GET
nickname getEventsForClusters
AOS | Clusters | 98

required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the stats for a specified Cluster

GET /clusters/{id}/stats/
Table 208: Details
path /clusters/{id}/stats/
method GET
nickname getStatsForCluster
AOS | Clusters | 99

required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer
8
AOS | Comments | 101

COMMENTS
Create a new comment
POST /comments/
Table 211: Details
path /comments/
method POST
nickname createComment
type create.dto.comment.CommentDTO
Comment to create. paramType body
required true
type create.dto.comment.Comment
Table 213: create.dto.comment.CommentDTO
content string
conversationUuid string
createdTimestampUsecs string
creationUsername string
lastModifiedTimestampUsecs string
referenceEntityType string
referenceEntityUuid string
uuid string
9
AOS | Containers | 103

CONTAINERS
Get the list of Containers
GET /containers/
Table 214: Details
path /containers/
method GET
nickname getContainers
type get.base.EntityCollection<get.dto.appliance.configuration.ContainerDTO>
count Number of Containers to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
required false
type array
required false
type integer

required false
type string
Table 216: get.base.EntityCollection<get.dto.appliance.configuration.ContainerDTO>
entities array
Modify a Container
PATCH /containers/
Table 217: Details
path /containers/
method PATCH
nickname patchContainer
A Container instance paramType body
required true
value boolean
Add a Container
POST /containers/

Table 220: Details
path /containers/
method POST
nickname addContainer
required true
value boolean
Update a Container
PUT /containers/
Table 223: Details
path /containers/
method PUT
nickname editContainer
required true

value boolean
Get the list of alerts generated on any Container

GET /containers/alerts
Table 226: Details
path /containers/alerts
method GET
nickname getContainerAlerts
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string

required false
type string
required false
type integer
entities array
Get the list of NFS Datastores

GET /containers/datastores
Table 229: Details
path /containers/datastores
method GET
nickname getNfsDatastores
type Array of get.dto.esx.NfsDatastoreInfoDTO
Add an NFS Datastore

POST /containers/datastores/add_datastore
Table 230: Details
path /containers/datastores/add_datastore
method POST
nickname createNfsDatastores
type create.dto.esx.CreateNfsDatastoreStatusDTO

Add request paramType body
required true
type create.dto.esx.CreateNfsDatas
Table 232: create.dto.esx.CreateNfsDatastoreStatusDTO
nodeSpecificStatus array
Remove an NFS Datastore

POST /containers/datastores/remove_datastore
Table 233: Details
path /containers/datastores/remove_datastore
method POST
nickname deleteNfsDatastores
type create.dto.esx.DeleteNfsDatastoreStatusDTO
Remove request paramType body
required true
type create.dto.esx.DeleteNfsDatast
Table 235: create.dto.esx.DeleteNfsDatastoreStatusDTO
nodeSpecificStatus array
Get the list of events generated on any Container

GET /containers/events

Table 236: Details
path /containers/events
method GET
nickname getContainerEvents
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Delete a Container
DELETE /containers/{id}

Table 239: Details
path /containers/{id}
method DELETE
nickname deleteContainer
id Id of the Container paramType path
required true
type string
ignoreSmallFiles Ignore small file paramType query
required false
type boolean
value boolean
Get a Container
GET /containers/{id}
Table 242: Details
path /containers/{id}
method GET
nickname getContainer
type get.dto.appliance.configuration.ContainerDTO
id Id of the Container paramType path
required true

type string
required false
type string
Table 244: get.dto.appliance.configuration.ContainerDTO
advertisedCapacity integer int64
affinityHostUuid string
clusterUuid string
compressionDelayInSecs integer int32
containerUuid string
downMigrateTimesInSecs java.util.Map<java.lang.String,
java.lang.Integer>
enableSoftwareEncryption boolean
encrypted boolean
erasureCode string
erasureCodeDelaySecs integer int32
fingerPrintOnWrite string
id string
ilmPolicy string
inlineEcEnabled boolean
isNutanixManaged boolean
mappedRemoteContainers java.util.Map<java.lang.String,
java.lang.String>
maxCapacity integer int64
name string
nfsWhitelist array
nfsWhitelistAddress array

nfsWhitelistInherited boolean
onDiskDedup string
oplogReplicationFactor integer int32
preferHigherECFaultDomain boolean
randomIoPreference array
replicationFactor integer int32
seqIoPreference array
java.lang.String>
storagePoolId string
storagePoolUuid string
totalExplicitReservedCapacity integer int64
totalImplicitReservedCapacity integer int64
java.lang.String>
vstoreNameList array
Get the list of alerts generated on a specified Container

GET /containers/{id}/alerts
Table 245: Details
path /containers/{id}/alerts
method GET
nickname getAlertsForContainer
id Id of a Container paramType path
required true
type string
required false

type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on a specified Container

GET /containers/{id}/events

Table 248: Details
path /containers/{id}/events
method GET
nickname getEventsForContainer
required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array

Get the stats for a specified Container
GET /containers/{id}/stats/
Table 251: Details
path /containers/{id}/stats/
method GET
nickname getContainerStats
required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer
Get the list of VDisks

GET /containers/{id}/vdisks

Table 254: Details
path /containers/{id}/vdisks
method GET
nickname getVDisksInContainer
type Array of get.dto.appliance.configuration.VDiskDTO
required true
type string

10
AOS | Data at rest encryption | 118

DATA AT REST ENCRYPTION
Get encryption status
GET /data_at_rest_encryption/
Table 256: Details
path /data_at_rest_encryption/
method GET
nickname getEncryptionStatus
type get.dto.encryption.ClusterEncryptionStatusDTO
Table 257: get.dto.encryption.ClusterEncryptionStatusDTO
PCKeyManagerStatus string
desiredPasswordProtection boolean
diskEncryptionStatus java.util.Map<java.lang.String,
java.lang.Boolean>
isClusterEmpty boolean
isReadyForPasswordProtection boolean
isReadyForSoftwareEncryption boolean
softwareEncryptionScope string
storageContainerEncryptionStatus java.util.Map<java.lang.String,
java.lang.Boolean>
Download encryption key

POST /data_at_rest_encryption/download_encryption_key
Table 258: Details
path /data_at_rest_encryption/download_encryption_key
method POST
nickname downloadEncryptionKey
type create.dto.encryption.KeyBackupResponseDTO

password used to encrypt the key. paramType body
required true
type create.dto.encryption.KeyBack
Table 260: create.dto.encryption.KeyBackupResponseDTO
backupData array
Enable encryption
POST /data_at_rest_encryption/enable
Table 261: Details
path /data_at_rest_encryption/enable
method POST
nickname enableEncryption
Desired cluster protection status paramType body
required true
type create.dto.encryption.EnableEn
value boolean
Get recent certificate test results

GET /data_at_rest_encryption/recent_certificate_test_results

Table 264: Details
path /data_at_rest_encryption/recent_certificate_test_results
method GET
nickname getRecentCertificateTestResults
type Array of get.dto.encryption.KMSTestResultsDTO
hostIds List of Host ids paramType query
required false
type array
kmsServerNames List of Key Management Server paramType query

names
required false
type array
Sets new passwords for encryption capable disks

POST /data_at_rest_encryption/rekey
Table 266: Details
path /data_at_rest_encryption/rekey
method POST
nickname rekey
List of disk ids on which rekey needs paramType body

to be performed
required true
type array

value boolean
Test encryption configuration

POST /data_at_rest_encryption/test
Table 269: Details
path /data_at_rest_encryption/test
method POST
nickname testEncryptionConfiguration
type create.dto.encryption.TestEncryptionConfigurationResponseDTO
List of host ids and key management paramType body

server names on which test to be
performed required true
type create.dto.encryption.TestEncr
Table 271: create.dto.encryption.TestEncryptionConfigurationResponseDTO
hasFailures boolean
11
AOS | Data at rest encryption certificates | 123

DATA AT REST ENCRYPTION
CERTIFICATES
Get all CA certificates
GET /data_at_rest_encryption_certificates/ca_certificates/
Table 272: Details
path /data_at_rest_encryption_certificates/ca_certificates/
method GET
nickname getCACertificates
type Array of
get.dto.appliance.configuration.CertificateAuthorityDTO
Add trusted CA certificate

POST /data_at_rest_encryption_certificates/ca_certificates/
Table 273: Details
method POST
nickname addCACertificate
type create.dto.appliance.configuration.CertificateAuthorityDTO
Certificate file paramType body
required true
type org.apache.cxf.jaxrs.ext.multip
name name paramType query
required true
type string

Table 275: create.dto.appliance.configuration.CertificateAuthorityDTO
certificate string
name string
Delete Certificate Authority

DELETE /data_at_rest_encryption_certificates/ca_certificates/{name}
Table 276: Details
{name}
method DELETE
nickname deleteCACertificate
name Certificate Authority name paramType path
required true
type string
value boolean
Update the Certification information

PUT /data_at_rest_encryption_certificates/certification_information
Table 279: Details
path /data_at_rest_encryption_certificates/
certification_information
method PUT
nickname updateCertificationInformation

type update.dto.appliance.configuration.CertificationInformationDTO
CertificationInformation instance paramType body
required false
Table 281: update.dto.appliance.configuration.CertificationInformationDTO
city string
countryCode string
domainName string
emailAddress string
organizationName string
organizationalUnitList array
state string
Get Certification information

GET /data_at_rest_encryption_certificates/certification_information/
Table 282: Details
certification_information/
method GET
nickname getCertificationInformation
type get.dto.appliance.configuration.CertificationInformationDTO
Table 283: get.dto.appliance.configuration.CertificationInformationDTO
city string
countryCode string

domainName string
emailAddress string
state string
Download CSR files

GET /data_at_rest_encryption_certificates/csr_for_discovered_node
Table 284: Details
csr_for_discovered_node
method GET
nickname downloadCSRFromDiscoveredNode
type DataHandler
nodeIp Discovered node's IPv6 address paramType query
required true
type string
Download CSR files

GET /data_at_rest_encryption_certificates/csrs
Table 286: Details
path /data_at_rest_encryption_certificates/csrs
method GET
nickname downloadCSRs
type javax.ws.rs.core.Response

nodeIdList List of node ids paramType query
required false
type array
Delete certificate
DELETE /data_at_rest_encryption_certificates/svm_certificate/
Table 288: Details
path /data_at_rest_encryption_certificates/svm_certificate/
method DELETE
nickname deleteCertificate
nodeId Id of the node on which certificate is paramType query

installed
required true
type string
serverName Key management Server name for paramType query

which certificate is installed
required true
type string
value boolean
Add certificates
POST /data_at_rest_encryption_certificates/svm_certificates/

Table 291: Details
path /data_at_rest_encryption_certificates/svm_certificates/
method POST
nickname uploadCertificates
type create.dto.PrimitiveDTO<java.lang.String>
required true
keyManagementServerName
Key Management Server name paramType query
required true
type string
Table 293: create.dto.PrimitiveDTO<java.lang.String>
value string
Add certificates
POST /data_at_rest_encryption_certificates/svm_certificates/multi_file
Table 294: Details
multi_file
method POST
nickname uploadCertificatesViaMultiFile
Certificate list paramType body

required true
value string
Replace expired svm certificate

POST /data_at_rest_encryption_certificates/svm_certificates/replace
Table 297: Details
replace
method POST
nickname replaceExpiredCertificate
required true
keyManagementServerName
Key Management Server name paramType query
required true
type string
nodeId ServiceVmId of the node paramType query
required true
type string

value string

12
AOS | Disks | 132

DISKS
Get the list of Disks
GET /disks/
Table 300: Details
path /disks/
method GET
nickname getDisks
type get.base.EntityCollection<get.dto.appliance.configuration.DiskDTO>
count Number of Disks to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
required false
type array
required false
type integer
AOS | Disks | 133

required false
type string
Table 302: get.base.EntityCollection<get.dto.appliance.configuration.DiskDTO>
entities array
Get the list of alerts generated on any Disk

GET /disks/alerts
Table 303: Details
path /disks/alerts
method GET
nickname getDiskAlerts
required false
type integer
required false
type integer
required false
type integer
required false
AOS | Disks | 134

type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on any Disk

GET /disks/events
Table 306: Details
path /disks/events
method GET
nickname getDiskEvents
AOS | Disks | 135

required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the health check summary for the Disks

GET /disks/health_check_summary
Table 309: Details
path /disks/health_check_summary
method GET
nickname getHealthCheckSummaryForDisks
type get.dto.health.check.EntityTypeHealthCheckSummaryDTO
AOS | Disks | 136

required false
type string
detailedSummary Detailed summary paramType query
required false
type boolean
Table 311: get.dto.health.check.EntityTypeHealthCheckSummaryDTO
checksInError java.util.Map<java.lang.String,
get.dto.health.check.HealthCheckErrorsDTO>
detailedCheckSummary java.util.Map<java.lang.String,
java.util.Map<get.dto.health.check.HealthStatus,
java.lang.Integer>>
entityType string
filterCriteria string
healthSummary java.util.Map<get.dto.health.check.HealthStatus,
java.lang.Integer>
Mark specified Disk for Removal

DELETE /disks/{id}
Table 312: Details
path /disks/{id}
method DELETE
nickname beginRemoveDisk
type delete.dto.appliance.configuration.EntityRemovalDTO
id Id of a Disk paramType path
required true
AOS | Disks | 137

type string
force Force the operation paramType query
required false
type boolean
bypassUpgradeCheck
Skip upgrade check paramType query
required false
type boolean
onlyFetchPostRemovalFaultTolerantCapacityBytes
Do a dry run to check sufficient paramType query
resilient capacity
required false
type boolean
Table 314: delete.dto.appliance.configuration.EntityRemovalDTO
postRemovalFaultTolerantCapacityBytesinteger int64
value boolean
Get a Disk
GET /disks/{id}
Table 315: Details
path /disks/{id}
method GET
nickname getDisk
type get.dto.appliance.configuration.DiskDTO
id Id of the Disk paramType path
required true
type string
AOS | Disks | 138

required false
type string
Table 317: get.dto.appliance.configuration.DiskDTO
clusterUuid string
cvmIpAddress string
dataMigrated boolean
diskHardwareConfig get.dto.appliance.configuration.DiskHardwareConfigDTO
diskSize integer int64
diskStatus string
diskUuid string
dynamicRingChangingNode get.dto.appliance.configuration.NodeDTO
hostName string
id string
lastNodeUuid string
lastServiceVMId string
location integer int32
mountPath string
nodeName string
nodeUuid string
online boolean
passwordProtected boolean
selfEncryptingDrive boolean
selfManagedNvme boolean
serviceVMId string
java.lang.String>
AOS | Disks | 139

storageTierName string
java.lang.String>
Get the list of alerts generated on a specified Disk

GET /disks/{id}/alerts
Table 318: Details
path /disks/{id}/alerts
method GET
nickname getAlertsForDisk
required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean
AOS | Disks | 140


acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on a specified Disk

GET /disks/{id}/events
Table 321: Details
path /disks/{id}/events
method GET
nickname getEventsForDisks
AOS | Disks | 141

required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the stats for a specified Disk

GET /disks/{id}/stats/
Table 324: Details
path /disks/{id}/stats/
method GET
nickname getDiskStats
AOS | Disks | 142

required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer
AOS | Disks | 143

13
AOS | Events | 144

EVENTS
Get the list of Events
GET /events/
Table 327: Details
path /events/
method GET
nickname getEvents
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entityType Entity type paramType query
required false
type string
entityIds Entity ids paramType query
AOS | Events | 145

required false
type string
typeIds Type ids for events paramType query
required false
type string
entities array
Acknowledge events
POST /events/acknowledge
Table 330: Details
path /events/acknowledge
method POST
nickname acknowledgeEvents
required false
type integer
required false
type integer
required false
AOS | Events | 146

type string
required false
type string
required false
type string
required false
type integer
Get the list of hardware Events

GET /events/hardware
Table 333: Details
path /events/hardware
method GET
nickname getHardwareEvents
required false
type integer
AOS | Events | 147

required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the list of storage Events

GET /events/storage
Table 336: Details
path /events/storage
method GET
nickname getStorageEvents
AOS | Events | 148

required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Acknowledge Event
PUT /events/{id}/acknowledge
Table 339: Details
path /events/{id}/acknowledge
method PUT
nickname acknowledgeEvent
AOS | Events | 149

id Event Id paramType path
required true
type string
value boolean
14
AOS | File groups | 151

FILE GROUPS
List file groups
GET /file_groups/
Table 342: Details
path /file_groups/
method GET
nickname listFileGroups
type get.base.EntityCollection<get.dto.dr.FileGroupDTO>
fileGroupUuid UUID of file group paramType query
required false
type string
Table 344: get.base.EntityCollection<get.dto.dr.FileGroupDTO>
entities array
Remove files for a specific file group

POST /file_groups/{fileGroupUuid}/delete_files
Table 345: Details
path /file_groups/{fileGroupUuid}/delete_files
method POST
nickname deleteFiles

fileGroupUuid UUID of file group paramType path
required true
type string
value boolean

15
AOS | Health checks | 154

HEALTH CHECKS
Get the list of Health Checks
GET /health_checks/
Table 348: Details
path /health_checks/
method GET
nickname getHealthChecks
type Array of get.dto.health.check.HealthCheckDTO
checkIds Check Ids paramType query
required false
type array
globalConfig Whether to get the global config list paramType query

or not.
required false
type boolean
includeInternalChecks
Whether to include internal checks paramType query
or not.
required false
type boolean
categoryTypes Categories of the Health Check. paramType query
required false
type array
Modify Health Check details

PATCH /health_checks/
Table 350: Details
method PATCH

nickname patchHealthCheck
type patch.dto.health.check.HealthCheckDTO
An Health Check instance paramType body
required true
Table 352: patch.dto.health.check.HealthCheckDTO
affectedEntityTypes array
alertConfigurableParameters array
alertTypeId string
applicableForMultiCluster boolean
applicableForSingleCluster boolean
autoResolve string
categoryTypes array
causes array
checkType string
description string
enabled boolean
id string
impacts array
isGlobalConfig boolean
isUserDefined boolean
kbList array
message string
metrics array
modifiedByUsername string
modifiedTimeStampInUsecs integer int64
name string

parameters java.util.Map<java.lang.String,
patch.dto.health.check.HealthCheckDTO
$HealthCheckParameterDTO>
policyUuid string
resolutions array
scheduleIntervalInSecs integer int32
scope string
severityThresholdInfos array
subCategoryTypes array
Update Health Check details

PUT /health_checks/
Table 353: Details
method PUT
nickname updateHealthCheck
type update.dto.health.check.HealthCheckDTO
An Health Check instance paramType body
required true
type update.dto.health.check.Health
Table 355: update.dto.health.check.HealthCheckDTO
alertTypeId string

autoResolve string
categoryTypes array
causes array
checkType string
description string
enabled boolean
id string
impacts array
kbList array
message string
metrics array
name string
update.dto.health.check.HealthCheckDTO
policyUuid string
resolutions array
scope string
Get Health Check details

GET /health_checks/{id}
Table 356: Details
path /health_checks/{id}
method GET
nickname getHealthCheck

type get.dto.health.check.HealthCheckDTO
id Id of the health check paramType path
required true
type string
globalConfig Whether to get the global config list paramType query

or not.
required false
type boolean
Table 358: get.dto.health.check.HealthCheckDTO
alertConfigExceptionGroups array
alertTypeId string
autoResolve string
categoryTypes array
causes array
checkType string
description string
enabled boolean
exceptionCount integer int64
id string
impacts array
kbList array
message string

metrics array
name string
get.dto.health.check.HealthCheckDTO
policyUuid string
resolutions array
scope string
title string
16
AOS | Hosts | 161

HOSTS
Get the list of Physical Hosts
GET /hosts/
Table 359: Details
path /hosts/
method GET
nickname getHosts
type get.base.EntityCollection<get.dto.appliance.configuration.NodeDTO>
count Number of Physical Hosts to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
required false
type array
required false
type integer
AOS | Hosts | 162

required false
type string
Table 361: get.base.EntityCollection<get.dto.appliance.configuration.NodeDTO>
entities array
Get the list of alerts generated on any Host

GET /hosts/alerts
Table 362: Details
path /hosts/alerts
method GET
nickname getHostAlerts
required false
type integer
required false
type integer
required false
type integer
required false
AOS | Hosts | 163

type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on any Host

GET /hosts/events
Table 365: Details
path /hosts/events
method GET
nickname getHostEvents
AOS | Hosts | 164

required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the health check summary for Hosts

GET /hosts/health_check_summary
Table 368: Details
path /hosts/health_check_summary
method GET
nickname getHealthCheckSummaryForHosts
AOS | Hosts | 165

required false
type string
required false
type boolean
java.lang.Integer>>
entityType string
java.lang.Integer>
Get a Physical Host

GET /hosts/{id}
Table 371: Details
path /hosts/{id}
method GET
nickname getHost
type get.dto.appliance.configuration.NodeDTO
id Id of a Physical Host paramType path
required true
AOS | Hosts | 166

type string
required false
type string
Table 373: get.dto.appliance.configuration.NodeDTO
KeyManagementDeviceToCertificateStatus
java.util.Map<java.lang.String,
java.lang.Boolean>
acropolisConnectionState string
backplaneAddress array
backplaneIp string
biosModel string
biosVersion string
blockLocation string
blockModel string
blockModelName string
blockSerial string
bmcModel string
bmcVersion string
bootTimeInUsecs integer int64
clusterUuid string
controllerVmBackplaneAddress array
controllerVmBackplaneIp string
cpuCapacityInHz integer int64
cpuFrequencyInHz integer int64
cpuModel string
defaultVhdContainerId string
defaultVhdContainerUuid string
defaultVhdLocation string
defaultVmContainerId string
AOS | Hosts | 167

defaultVmContainerUuid string
defaultVmLocation string
diskHardwareConfigs java.util.Map<java.lang.Integer,
get.dto.appliance.configuration.DiskHardwareConfigDTO>
dynamicRingChangingNode get.dto.appliance.configuration.NodeDTO
failoverClusterFqdn string
failoverClusterNodeState string
hasCsr boolean
hbaFirmwaresList array
hostGpus array
hostInMaintenanceMode boolean
hostMaintenanceModeReason string
hostNicIds array
hostType string
hypervisorAddress string
hypervisorAddressValue array
hypervisorFullName string
hypervisorKey string
hypervisorPassword string
hypervisorState string
hypervisorType string
hypervisorUsername string
ipmiAddress string
ipmiAddressValue array
ipmiPassword string
ipmiUsername string
isDegraded boolean
isHardwareVirtualized boolean
isSecureBooted boolean
managementServerName string
memoryCapacityInBytes integer int64
AOS | Hosts | 168

metadataStoreStatus string
metadataStoreStatusMessage string
monitored boolean
name string
numCpuCores integer int64
numCpuSockets integer int64
numCpuThreads integer int64
numVMs integer int64
oplogDiskPct number float
oplogDiskSize integer int64
position get.dto.appliance.configuration.NodePositionDTO
rdmaBackplaneAddressList array
rdmaBackplaneIps array
rebootPending boolean
removalStatus array
serial string
serviceVMExternalAddress array
serviceVMExternalIP string
serviceVMId string
serviceVMNatIP string
serviceVMNatPort integer int32
state string
java.lang.String>
java.lang.String>
uuid string
vzoneName string
Get the list of alerts generated on a specified Host

GET /hosts/{id}/alerts
AOS | Hosts | 169

Table 374: Details
path /hosts/{id}/alerts
method GET
nickname getAlertsForHost
id Id of a Host paramType path
required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
AOS | Hosts | 170

required false
type integer
entities array
Get the list of events generated on a specified Host

GET /hosts/{id}/events
Table 377: Details
path /hosts/{id}/events
method GET
nickname getEventsForHost
id Id of a Host paramType path
required true
type string
required false
type integer
required false
type integer
required false
AOS | Hosts | 171

type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the stats for a specified Physical Host

GET /hosts/{id}/stats/
Table 380: Details
path /hosts/{id}/stats/
method GET
nickname getHostStats
id Id of a Physical Host paramType path
required true
type string
required true
type array
AOS | Hosts | 172

required false
type integer
required false
type integer
required false
type integer
AOS | Hosts | 173

17
AOS | Http proxies | 174

HTTP PROXIES
Get the list of HTTP Proxies
GET /http_proxies/
Table 383: Details
path /http_proxies/
method GET
nickname getHttpProxies
type Array of get.dto.appliance.configuration.HttpProxyDTO
Modify an HTTP Proxy

PATCH /http_proxies/
Table 384: Details
path /http_proxies/
method PATCH
nickname patchHttpProxy
An HTTP Proxy instance paramType body
required true
value boolean
Add an HTTP Proxy

POST /http_proxies/

Table 387: Details
path /http_proxies/
method POST
nickname addHttpProxy
required true
value boolean
Update an HTTP Proxy

PUT /http_proxies/
Table 390: Details
path /http_proxies/
method PUT
nickname editHttpProxy
required true

value boolean
Get HTTP Proxy whitelist

GET /http_proxies/whitelist
Table 393: Details
path /http_proxies/whitelist
method GET
nickname getHttpProxyWhitelist
type get.dto.appliance.configuration.HttpProxyWhitelistDTO
Table 394: get.dto.appliance.configuration.HttpProxyWhitelistDTO
whitelist array
Set HTTP Proxy whitelist

PUT /http_proxies/whitelist
Table 395: Details
path /http_proxies/whitelist
method PUT
nickname setHttpProxyWhitelist
type update.dto.appliance.configuration.HttpProxyWhitelistDTO
HTTP Proxy whitelist instance paramType body
required true

Table 397: update.dto.appliance.configuration.HttpProxyWhitelistDTO
whitelist array
Delete an HTTP Proxy

DELETE /http_proxies/{name}
Table 398: Details
path /http_proxies/{name}
method DELETE
nickname deleteHttpProxy
name Name of an HTTP Proxy paramType path
required true
type string
value boolean
Get an HTTP Proxy

GET /http_proxies/{name}
Table 401: Details
path /http_proxies/{name}
method GET
nickname getHttpProxy
type get.dto.appliance.configuration.HttpProxyDTO

name Name of an HTTP Proxy paramType path
required true
type string
Table 403: get.dto.appliance.configuration.HttpProxyDTO
address string
addressValue get.common.Address
name string
password string
port integer int32
proxyTypes array
username string

18
AOS | Key management servers | 180

KEY MANAGEMENT SERVERS
Get all Key Management Servers
GET /key_management_servers/
Table 404: Details
path /key_management_servers/
method GET
nickname getKeyManagementServers
type Array of
get.dto.appliance.configuration.KeyManagementServerDTO
Modify the KeyManagementServer

PATCH /key_management_servers/
Table 405: Details
method PATCH
nickname patchKeyManagementServer
type patch.dto.appliance.configuration.KeyManagementServerDTO
A Key Management Server instance paramType body
required false
Table 407: patch.dto.appliance.configuration.KeyManagementServerDTO
active boolean
addressList array

ipAddressPortMap java.util.Map<java.lang.String,
java.lang.Integer>
name string
uuid string
Add a Key Management Server

POST /key_management_servers/
Table 408: Details
method POST
nickname addKeyManagementServer
type create.dto.appliance.configuration.KeyManagementServerDTO
required true
Table 410: create.dto.appliance.configuration.KeyManagementServerDTO
active boolean
addressList array
java.lang.Integer>
name string
uuid string
Update the KeyManagementServer

PUT /key_management_servers/

Table 411: Details
method PUT
nickname updateKeyManagementServer
type update.dto.appliance.configuration.KeyManagementServerDTO
required false
forceUpdate Set when you need to updateKey paramType query

Management Server that is currently
storing encryption keys for the required false
cluster type boolean
Table 413: update.dto.appliance.configuration.KeyManagementServerDTO
active boolean
addressList array
java.lang.Integer>
name string
uuid string
Get Key Management Server Type

GET /key_management_servers/type
Table 414: Details
path /key_management_servers/type
method GET
nickname getKeyManagementServerType
type get.dto.appliance.configuration.KMSTypeDTO

Table 415: get.dto.appliance.configuration.KMSTypeDTO
forceUpdateConfig boolean
kmsType string
skipClusterSizeCheck boolean
Select Key Management Server Type

PUT /key_management_servers/type
Table 416: Details
path /key_management_servers/type
method PUT
nickname selectKeyManagementServerType
Type of the Key Management Server paramType body
required true
value boolean
Delete the KeyManagementServer

DELETE /key_management_servers/{name}
Table 419: Details
path /key_management_servers/{name}
method DELETE
nickname deleteKeyManagementServer

name Name of the Key Management paramType path

Server
required true
type string
value boolean
Get Key Management Server

GET /key_management_servers/{name}
Table 422: Details
path /key_management_servers/{name}
method GET
nickname getKeyManagementServer
type get.dto.appliance.configuration.KeyManagementServerDTO
name Name of the Key Management paramType path

Server
required true
type string
Table 424: get.dto.appliance.configuration.KeyManagementServerDTO
active boolean
addressList array

java.lang.Integer>
name string
uuid string
19
AOS | License | 187

LICENSE
Show current license file
GET /license/
Table 425: Details
path /license/
method GET
nickname getCurrentLicense
type get.dto.license.GetLicenseResponseDTO
Table 426: get.dto.license.GetLicenseResponseDTO
licenseDTO get.dto.license.LicenseDTO
licenseInfoDTO get.dto.license.LicenseInfoDTO
Apply license file

POST /license/
Table 427: Details
path /license/
method POST
nickname applyLicense
type create.dto.license.GetLicenseResponseDTO
License file paramType body
required true
AOS | License | 188

Table 429: create.dto.license.GetLicenseResponseDTO
licenseDTO create.dto.license.LicenseDTO
licenseInfoDTO create.dto.license.LicenseInfoDTO
Get the list of alerts generated for any License

GET /license/alerts
Table 430: Details
path /license/alerts
method GET
nickname getLicenseAlerts
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
AOS | License | 189

type string
required false
type string
required false
type integer
entities array
Show allowances for all features

GET /license/allowances
Table 433: Details
path /license/allowances
method GET
nickname getAllowances
type java.util.Map<get.services.license.LicenseFeature,
get.dto.license.AllowancesDTO>
Show allowances for a particular feature

GET /license/allowances/{featureName}
Table 434: Details
path /license/allowances/{featureName}
method GET
nickname getAllowanceForFeature
type get.dto.license.AllowancesDTO
AOS | License | 190

featureName Feature name paramType path
required true
type string
Table 436: get.dto.license.AllowancesDTO
allowancesType string
boolValue get.dto.license.AllowanceDTO
clusterUuids array
displayName string
intValues array
Get Cluster Info

GET /license/cluster_info
Table 437: Details
path /license/cluster_info
method GET
nickname getClusterLicenseInfo
type get.dto.license.csf.GetClusterInfoResponseDTO
csfVersion CSF version paramType query
required false
type integer
Table 439: get.dto.license.csf.GetClusterInfoResponseDTO
licenseClusterInfoDTO get.dto.license.LicenseClusterInfoDTO
AOS | License | 191

prismCentralDTO get.dto.license.csf.PrismCentralDTO
Get Cluster Info as a file

GET /license/cluster_summary_file
Table 440: Details
path /license/cluster_summary_file
method GET
nickname getClusterInfoFile
type javax.ws.rs.core.Response
csfVersion CSF version paramType query
required false
type integer
Get the list of events generated for any License

GET /license/events
Table 442: Details
path /license/events
method GET
nickname getLicenseEvents
required false
type integer
AOS | License | 192

required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
AOS | License | 193

20
AOS | Protection domains | 194

PROTECTION DOMAINS
Get the list of Protection Domains
GET /protection_domains/
Table 445: Details
path /protection_domains/
method GET
nickname getProtectionDomains
type Array of get.dto.dr.ProtectionDomainDTO
names Protection Domain names paramType query
required false
type array
metroAvail Metro Availability Protection Domain paramType query
required false
type boolean
vStoreName vStore name paramType query
required false
type string
remoteSiteName Remote Site name paramType query
required false
type string
includeDeleted Include deleted paramType query
required false
type boolean
required false
type string

Add a Protection Domain
POST /protection_domains/
Table 447: Details
path /protection_domains/
method POST
nickname addProtectionDomain
type create.dto.dr.ProtectionDomainDTO
A Protection Domain instance paramType body
required true
type create.dto.dr.ProtectionDomai
Table 449: create.dto.dr.ProtectionDomainDTO
active boolean
annotations array
cronSchedules array
metroAvail create.dto.dr.ProtectionDomainDTO
$Stretch
minSnapshotToRetain integer int32
name string
nextSnapshotTimeUsecs integer int64
nfsFiles array
ongoingReplicationCount integer int64
pendingReplicationCount integer int64
remoteSiteNames array

java.lang.String>
syncReplications array
totalUserWrittenBytes integer int64
java.lang.String>
vms array
volumeGroups array
vstoreId integer int64
Get the list of alerts generated on any Protection Domain

GET /protection_domains/alerts
Table 450: Details
path /protection_domains/alerts
method GET
nickname getProtectionDomainAlerts
required false
type integer
required false
type integer
required false
type integer
required false

type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get list of Consistency groups

GET /protection_domains/consistency_groups/
Table 453: Details
path /protection_domains/consistency_groups/
method GET
nickname getConsistencyGroups
type Array of get.dto.dr.ConsistencyGroupDTO

protectionDomainsProtection Domain names paramType query
required false
type array
consistencyGroupsConsistency Group names paramType query
required false
type array
required false
type boolean
Get the list of Snapshots

GET /protection_domains/dr_snapshots/
Table 455: Details
path /protection_domains/dr_snapshots/
method GET
nickname getAllProtectionDomainSnapshots
type get.base.EntityCollection<get.dto.dr.SnapshotDTO>
count Number of DR Snapshots to retrieve paramType query
required false
type integer
required false
type string
required false
type string

fullDetails Whether to include consistency paramType query

group / vm details
required false
type boolean
Table 457: get.base.EntityCollection<get.dto.dr.SnapshotDTO>
entities array
Get the list of events generated on any Protection Domain

GET /protection_domains/events
Table 458: Details
path /protection_domains/events
method GET
nickname getProtectionDomainEvents
required false
type integer
required false
type integer
required false
type integer


acknowledged
required false
type boolean
required false
type integer
entities array
Get the health check summary for the Protection Domain

GET /protection_domains/health_check_summary
Table 461: Details
path /protection_domains/health_check_summary
method GET
nickname getHealthCheckSummaryForProtectionDomains
required false
type string
required false
type boolean

java.lang.Integer>>
entityType string
java.lang.Integer>
Get the list of Out-Of-Band schedules in Protection Domains

GET /protection_domains/oob_schedules/
Table 464: Details
path /protection_domains/oob_schedules/
method GET
nickname getOutOfBandSchedules
type Array of get.dto.dr.OutOfBandSchedulePoliciesDTO
protectionDomainNames
Names of Protection Domains paramType query
required false
type array
Get list of pending actions

GET /protection_domains/pending_actions/
Table 466: Details
path /protection_domains/pending_actions/
method GET
nickname getPendingActions
type Array of get.dto.dr.PdPendingActionsDTO

required false
type array
Get list of pending replications

GET /protection_domains/pending_replications/
Table 468: Details
path /protection_domains/pending_replications/
method GET
nickname getProtectionDomainPendingReplications
type Array of get.dto.dr.PendingReplicationDTO
Protection Domain names paramType query
required false
type array
remoteSiteNames Remote Site names paramType query
required false
type array
Get list of replications

GET /protection_domains/replications/
Table 470: Details
path /protection_domains/replications/
method GET
nickname getReplications
type Array of get.dto.dr.ReplicationDTO

Protection Domain names paramType query
required false
type array
remoteSiteNames Remote Site names paramType query
required false
type array
Get the Data Protection status for all Protection Domains

GET /protection_domains/status
Table 472: Details
path /protection_domains/status
method GET
nickname getStatus
type get.dto.dr.BackupAndDrStatus
Table 473: get.dto.dr.BackupAndDrStatus
activeReplications boolean
pdSuspendedSchedulesMap java.util.Map<java.lang.String,
java.lang.Boolean>
Get list of unprotected VMs in a cluster

GET /protection_domains/unprotected_vms/
Table 474: Details
path /protection_domains/unprotected_vms/
method GET
nickname getUnprotectedVms
type Array of get.dto.stats.VMDTO

hostIds Host IDs paramType query
required false
type array
vmIds VM IDs paramType query
required false
type array
vmNames VM Names paramType query
required false
type array
containerNames Container Names paramType query
required false
type array
Get the stats for a specified Protection Domain

GET /protection_domains/{name}/stats/
Table 476: Details
path /protection_domains/{name}/stats/
method GET
nickname getProtectionDomainStats
type get.base.StatsResponse
name Name of the Protection Domain paramType path
required true
type string
required true
type array

required false
type integer
required false
type integer
required false
type integer
Table 478: get.base.StatsResponse
Delete a Protection Domain

DELETE /protection_domains/{pdName}
Table 479: Details
path /protection_domains/{pdName}
method DELETE
nickname markProtectionDomainForRemoval
skipRemoteCheck Skip checking remote Protection paramType query

Domain
required false
type boolean
pdName Name of the Protection Domain paramType path
required true
type string

value boolean
Get a Protection Domain

GET /protection_domains/{pdName}
Table 482: Details
path /protection_domains/{pdName}
method GET
nickname getProtectionDomainByName
type get.dto.dr.ProtectionDomainDTO
required true
type string
metroAvail Whether to include only Metro paramType query

Availability related protection
domains required false
type boolean
vStoreName vStore name paramType query
required false
type string
remoteSiteName Remote Site name paramType query
required false
type string
required false
type string

Table 484: get.dto.dr.ProtectionDomainDTO
active boolean
annotations array
cronSchedules array
hybridSchedulesCount integer int32
metroAvail get.dto.dr.ProtectionDomainDTO
$Stretch
name string
nfsFiles array
schedulesSuspended boolean
java.lang.String>
java.lang.String>
vms array
volumeGroups array
Activate a protection domain

POST /protection_domains/{pdName}/activate
Table 485: Details
path /protection_domains/{pdName}/activate

method POST
nickname markProtectionDomainActive
required true
type string
Id of the snapshot paramType body
required false
value boolean
Get the list of alerts generated on a specified Protection Domain

GET /protection_domains/{pdName}/alerts
Table 488: Details
path /protection_domains/{pdName}/alerts
method GET
nickname getAlertsForProtectionDomain
required true
type string

required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Updates Metro Availability timeout for a specific protection domain

PUT /protection_domains/{pdName}/break_replication_timeout

Table 491: Details
path /protection_domains/{pdName}/break_replication_timeout
method PUT
nickname updateStretchCluster
type update.dto.dr.ProtectionDomainDTO
required true
type string
Metro Availability setting paramType body
required true
type update.dto.dr.ProtectionDoma
$Stretch
Table 493: update.dto.dr.ProtectionDomainDTO
active boolean
alertSummary update.dto.alerts.AlertSummaryDTO
annotations array
cronSchedules array
healthSummary update.dto.health.check.HealthSummaryDTO
metroAvail update.dto.dr.ProtectionDomainDTO
$Stretch
name string
nfsFiles array

java.lang.String>
java.lang.String>
vms array
volumeGroups array
Get list of Consistency groups in a Protection Domain

GET /protection_domains/{pdName}/consistency_groups/
Table 494: Details
path /protection_domains/{pdName}/consistency_groups/
method GET
nickname getConsistencyGroupsInPd
type Array of get.dto.dr.ConsistencyGroupDTO
required true
type string
Updates Consistency Group for a specific protection domain

PUT /protection_domains/{pdName}/consistency_groups/{cgName}
Table 496: Details
path /protection_domains/{pdName}/consistency_groups/{cgName}
method PUT
nickname updateConsistencyGroup

type update.dto.dr.ConsistencyGroupDTO
required true
type string
cgName Name of the Consistency Group paramType path
required true
type string
Consistency group details paramType body
required true
type update.dto.dr.ConsistencyGrou
Table 498: update.dto.dr.ConsistencyGroupDTO
appConsistentSnapshots boolean
consistencyGroupName string
nfsFileCount integer int32
protectionDomainName string
totalFileCount integer int32
totalFileSizeBytes integer int64
vmCount integer int32
withinSnapshot boolean
Deactivate a protection domain

POST /protection_domains/{pdName}/deactivate
Table 499: Details
path /protection_domains/{pdName}/deactivate
method POST

nickname markProtectionDomainInactive
required true
type string
value boolean
Get the list of Snapshots in a Protection Domain

GET /protection_domains/{pdName}/dr_snapshots/
Table 502: Details
path /protection_domains/{pdName}/dr_snapshots/
method GET
nickname getSnapshotsForPd
required true
type string
count Number of DR Snapshots to retrieve paramType query
required false
type integer
required false

type string
required false
type string

group / vm details
required false
type boolean
oobScheduleIds OOB Schedule Ids for filtering paramType query
required false
type array
entities array
Get the list of events generated on a specified Protection Domain

GET /protection_domains/{pdName}/events
Table 505: Details
path /protection_domains/{pdName}/events
method GET
nickname getEventsForProtectionDomain
required true
type string

required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Change failure handling mode for a protection domain

PUT /protection_domains/{pdName}/failure_handling
Table 508: Details
path /protection_domains/{pdName}/failure_handling
method PUT
nickname updateStretchFailureHandling
type update.dto.dr.ProtectionDomainDTO

required true
type string
Protection domain name and Failure paramType body

handling mode
required true
type update.dto.dr.FailureHandlingD
Table 510: update.dto.dr.ProtectionDomainDTO
active boolean
annotations array
cronSchedules array
metroAvail update.dto.dr.ProtectionDomainDTO
$Stretch
name string
nfsFiles array
java.lang.String>
java.lang.String>
vms array

volumeGroups array
Disables Metro Availability for a specific protection domain

POST /protection_domains/{pdName}/metro_avail_disable
Table 511: Details
path /protection_domains/{pdName}/metro_avail_disable
method POST
nickname stopStretchCluster

Domain
required false
type boolean
required true
type string
active boolean
annotations array
cronSchedules array
$Stretch

name string
nfsFiles array
java.lang.String>
java.lang.String>
vms array
volumeGroups array
Enables Metro Availability for a specific protection domain

POST /protection_domains/{pdName}/metro_avail_enable
Table 514: Details
path /protection_domains/{pdName}/metro_avail_enable
method POST
nickname startStretchCluster
required true
type string
reEnable Re-enable operation paramType query
required false

type boolean

Domain
required false
type boolean
force Skip checking remote container paramType query

emptiness
required false
type boolean
VStore name and Remote site name paramType body
required false
type create.dto.dr.ProtectionDomai
$Stretch
active boolean
annotations array
cronSchedules array
$Stretch
name string
nfsFiles array
java.lang.String>

java.lang.String>
vms array
volumeGroups array
Migrate an active Protection Domain to a DR site

POST /protection_domains/{pdName}/migrate
Table 517: Details
path /protection_domains/{pdName}/migrate
method POST
nickname migrateProtectionDomain
type create.base.EntityCollection<create.dto.dr.VirtualMachine>
required true
type string
Name of the Remote Site paramType body
required true
skipVmMobilityCheck
Flag to specify whether mobility paramType query
check has to be skipped
required false
type boolean
Table 519: create.base.EntityCollection<create.dto.dr.VirtualMachine>
entities array
errorInfo create.base.ErrorInfo

metadata create.base.Metadata
Add a out of band snapshot schedule in a Protection Domain

POST /protection_domains/{pdName}/oob_schedules
Table 520: Details
path /protection_domains/{pdName}/oob_schedules
method POST
nickname addOutOfBandSchedule
type create.dto.dr.OutOfBandSchedulePoliciesDTO$Schedule
required true
type string
A Out of band snapshot schedule paramType body

instance
required true
type create.dto.dr.OutOfBandSched
$Schedule
Table 522: create.dto.dr.OutOfBandSchedulePoliciesDTO$Schedule
appConsistent boolean
scheduleId integer int64
scheduleStartTimeUsecs integer int64
snapshotRetentionTimeSecs integer int32
Get the list of Out-Of-Band schedules in a Protection Domain

GET /protection_domains/{pdName}/oob_schedules/

Table 523: Details
path /protection_domains/{pdName}/oob_schedules/
method GET
nickname getOutOfBandSchedulesForPd
type Array of get.dto.dr.OutOfBandSchedulePoliciesDTO
required true
type string
Delete a Out-Of-Band schedule

DELETE /protection_domains/{pdName}/oob_schedules/{scheduleId}
Table 525: Details
path /protection_domains/{pdName}/oob_schedules/{scheduleId}
method DELETE
nickname removeOutOfBandSchedule
required true
type string
scheduleId Id of the Out-Of-Band schedule paramType path
required true
type integer

value boolean
Get list of pending actions in the Protection Domain

GET /protection_domains/{pdName}/pending_actions/
Table 528: Details
path /protection_domains/{pdName}/pending_actions/
method GET
nickname getPendingActionsForPd
type Array of get.dto.dr.PdPendingActionsDTO
required true
type string
Get list of pending replications in the Protection Domain

GET /protection_domains/{pdName}/pending_replications/
Table 530: Details
path /protection_domains/{pdName}/pending_replications/
method GET
nickname getPendingReplicationsInPd
required true

type string
remoteSiteNames Names of Remote Sites paramType query
required false
type array
Promotes to active Metro Availability role for a specific protection

domain
POST /protection_domains/{pdName}/promote
Table 532: Details
path /protection_domains/{pdName}/promote
method POST
nickname promoteStretchCluster

Domain
required false
type boolean
required true
type string
force Force to perform the action paramType query
required false
type boolean
active boolean

annotations array
cronSchedules array
$Stretch
name string
nfsFiles array
java.lang.String>
java.lang.String>
vms array
volumeGroups array
Add Virtual Machines to a Protection Domain

POST /protection_domains/{pdName}/protect_vms
Table 535: Details
path /protection_domains/{pdName}/protect_vms
method POST
nickname addVmsByNamesToProtectionDomain

required true
type string
Add VMs request instance paramType body
required true
type create.dto.dr.AddVMsToPdReq
active boolean
annotations array
cronSchedules array
$Stretch
name string
nfsFiles array
java.lang.String>
java.lang.String>
vms array

volumeGroups array
Get list of replications in a Protection Domain

GET /protection_domains/{pdName}/replications/
Table 538: Details
path /protection_domains/{pdName}/replications/
method GET
nickname getReplicationsForPd
type Array of get.dto.dr.ReplicationDTO
required true
type string
Rollback Virtual Machines and/or NFS files

POST /protection_domains/{pdName}/restore_entities
Table 540: Details
path /protection_domains/{pdName}/restore_entities
method POST
nickname restoreEntities
required true

type string
Restore request instance paramType body
required true
type create.dto.dr.RestoreEntitiesRe
value boolean
Rollback an active Protection domain

POST /protection_domains/{pdName}/rollback
Table 543: Details
path /protection_domains/{pdName}/rollback
method POST
nickname rollbackProtectionDomain
required true
type string
Id of the snapshot paramType body
required true
value boolean

Remove all snapshot schedules from a Protection Domain
DELETE /protection_domains/{pdName}/schedules
Table 546: Details
path /protection_domains/{pdName}/schedules
method DELETE
nickname clearCronSchedules
required true
type string
value boolean
Retrieve all snapshot schedules from a Protection Domain

GET /protection_domains/{pdName}/schedules
Table 549: Details
method GET
nickname getCronSchedules
type Array of get.dto.dr.CronScheduleDTO

required true
type string
Add a snapshot schedule to a Protection Domain

POST /protection_domains/{pdName}/schedules
Table 551: Details
method POST
nickname addCronSchedule
type create.dto.dr.CronScheduleDTO
required true
type string
A snapshot schedule instance paramType body
required true
type create.dto.dr.CronScheduleDT
Table 553: create.dto.dr.CronScheduleDTO
durationInUsecs integer int64
endTimeInUsecs integer int64
everyNth integer int32
id string
pdName string
retentionPolicy create.dto.dr.RetentionPolicyDTO
startTimesInUsecs array

suspended boolean
timezoneOffset integer int32
type string
userStartTimeInUsecs integer int64
values array
Remove a snapshot schedule from a Protection Domain

DELETE /protection_domains/{pdName}/schedules/{id}
Table 554: Details
path /protection_domains/{pdName}/schedules/{id}
method DELETE
nickname removeCronSchedule
required true
type string
id Id of the snapshot schedule paramType path
required true
type string
value boolean
Replace a snapshot schedule of a Protection Domain

PUT /protection_domains/{pdName}/schedules/{id}

Table 557: Details
path /protection_domains/{pdName}/schedules/{id}
method PUT
nickname replaceCronSchedule
type update.dto.dr.CronScheduleDTO
required true
type string
id Id of the snapshot schedule paramType path
required true
type string
A snapshot schedule instance paramType body
required true
type update.dto.dr.CronScheduleDT
Table 559: update.dto.dr.CronScheduleDTO
id string
pdName string
retentionPolicy update.dto.dr.RetentionPolicyDTO
suspended boolean
type string

values array
Clear retention policies of a snapshot schedule of a Protection Domain

DELETE /protection_domains/{pdName}/schedules/{id}/retention_policies
Table 560: Details
path /protection_domains/{pdName}/schedules/{id}/
retention_policies
method DELETE
nickname clearRetentionPolicy
type delete.dto.dr.CronScheduleDTO
required true
type string
id ID of the snapshot schedule paramType path
required true
type string
Table 562: delete.dto.dr.CronScheduleDTO
id string
pdName string
retentionPolicy delete.dto.dr.RetentionPolicyDTO
suspended boolean

type string
values array
Set retention policies of a snapshot schedule of a Protection Domain

POST /protection_domains/{pdName}/schedules/{id}/retention_policies
Table 563: Details
path /protection_domains/{pdName}/schedules/{id}/
retention_policies
method POST
nickname setRetentionPolicy
type create.dto.dr.CronScheduleDTO
required true
type string
id ID of the snapshot schedule paramType path
required true
type string
The retention polcies instance paramType body
required true
type create.dto.dr.RetentionPolicyD
Table 565: create.dto.dr.CronScheduleDTO

id string
pdName string
retentionPolicy create.dto.dr.RetentionPolicyDTO
suspended boolean
type string
values array
Restore Virtual Machines and/or NFS files

POST /protection_domains/{pdName}/snapshots/{snapshotId}/clone
Table 566: Details
path /protection_domains/{pdName}/snapshots/{snapshotId}/
clone
method POST
nickname restoreSnapshot
type create.dto.dr.FileGroupDTO
required true
type string
snapshotId Snapshot Id paramType path
required true
type string
Restore request instance paramType body
required true
type create.dto.dr.RestoreEntitiesRe

Remove Virtual Machines from a Protection Domain
POST /protection_domains/{pdName}/unprotect_vms
Table 568: Details
path /protection_domains/{pdName}/unprotect_vms
method POST
nickname removeVmsFromProtectionDomain
required true
type string
List of VMs paramType body
required true
type array
active boolean
annotations array
cronSchedules array
$Stretch
name string
nfsFiles array

java.lang.String>
java.lang.String>
vms array
volumeGroups array
Delete a snapshot
DELETE /protection_domains/{protectionDomainName}/dr_snapshots/{snapshotId}
Table 571: Details
path /protection_domains/{protectionDomainName}/dr_snapshots/
{snapshotId}
method DELETE
nickname removeSnapshot
protectionDomainName
Name of the Protection Domain paramType path
required true
type string
snapshotId Id of the snapshot paramType path
required true
type string

value boolean
Retain a snapshot
POST /protection_domains/{protectionDomainName}/dr_snapshots/{snapshotId}/retain
Table 574: Details
path /protection_domains/{protectionDomainName}/dr_snapshots/
{snapshotId}/retain
method POST
nickname modifySnapshot
required true
type string
snapshotId Id of the snapshot paramType path
required true
type string
retention time in microseconds paramType body
required true
value boolean
Abort a replication
DELETE /protection_domains/{protectionDomainName}/replications/{id}

Table 577: Details
path /protection_domains/{protectionDomainName}/replications/
{id}
method DELETE
nickname abortReplication
required true
type string
id Id of the replication paramType path
required true
type integer
value boolean
Update the state of the replication

PUT /protection_domains/{protectionDomainName}/replications/{id}
Table 580: Details
path /protection_domains/{protectionDomainName}/replications/
{id}
method PUT
nickname updateReplication

required true
type string
id Id of the replication paramType path
required true
type integer
One of pause, resume or abort paramType body
required true
type update.dto.PrimitiveDTO<java
value boolean

21
AOS | Remote sites | 242

REMOTE SITES
Get the list of Remote Sites
GET /remote_sites/
Table 583: Details
path /remote_sites/
method GET
nickname getAllRemoteSites
type Array of get.dto.dr.RemoteSiteDTO
names Remote Site names paramType query
required false
type array
metroCompatible Remote Site stretchable paramType query
required false
type boolean
fullDetails Remote cluster detail paramType query
required false
type boolean
remoteContainers Remote container to fetch paramType query
required false
type array
required false
type boolean
required false
type string

Modify a Remote Site
PATCH /remote_sites/
Table 585: Details
path /remote_sites/
method PATCH
nickname patchRemoteSite
type patch.dto.dr.RemoteSiteDTO
A Remote Site instance paramType body
required true
Table 587: patch.dto.dr.RemoteSiteDTO
alertSummary patch.dto.alerts.AlertSummaryDTO
bandwidthPolicy patch.dto.dr.BandwidthPolicyDTO
capabilities array
cloudType string
clusterExternalDataServicesAddress patch.common.Address
cvmName string
healthSummary patch.dto.health.check.HealthSummaryDTO

metroReady boolean
name string
networkMapping patch.dto.dr.NetworkMappingDTO
region string
remoteDrExternalSubnetAddress patch.common.Address
java.lang.Integer>
java.lang.Integer>
patch.dto.dr.RemoteSiteDTO
$VStoreInfo>
sshEnabled boolean
java.lang.String>
status string
java.lang.String>
uuid string
java.lang.String>
Add a Remote Site

POST /remote_sites/
Table 588: Details
path /remote_sites/
method POST
nickname addRemoteSite

required true
Table 590: create.dto.dr.RemoteSiteDTO
bandwidthPolicy create.dto.dr.BandwidthPolicyDTO
capabilities array
cloudType string
clusterExternalDataServicesAddress create.common.Address
cvmName string
metroReady boolean
name string
networkMapping create.dto.dr.NetworkMappingDTO
region string
remoteDrExternalSubnetAddress create.common.Address
java.lang.Integer>

java.lang.Integer>
create.dto.dr.RemoteSiteDTO
$VStoreInfo>
sshEnabled boolean
java.lang.String>
status string
java.lang.String>
uuid string
java.lang.String>
Update a Remote Site

PUT /remote_sites/
Table 591: Details
path /remote_sites/
method PUT
nickname updateRemoteSite
type update.dto.dr.RemoteSiteDTO
required true
type update.dto.dr.RemoteSiteDTO
Table 593: update.dto.dr.RemoteSiteDTO

bandwidthPolicy update.dto.dr.BandwidthPolicyDTO
capabilities array
cloudType string
clusterExternalDataServicesAddress update.common.Address
cvmName string
metroReady boolean
name string
networkMapping update.dto.dr.NetworkMappingDTO
region string
remoteDrExternalSubnetAddress update.common.Address
java.lang.Integer>
java.lang.Integer>
update.dto.dr.RemoteSiteDTO
$VStoreInfo>
sshEnabled boolean
java.lang.String>
status string

java.lang.String>
uuid string
java.lang.String>
Get the list of alerts generated on any Remote Site

GET /remote_sites/alerts
Table 594: Details
path /remote_sites/alerts
method GET
nickname getRemoteSiteAlerts
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean

required false
type string
required false
type string
required false
type integer
entities array

GET /remote_sites/dr_snapshots/
Table 597: Details
path /remote_sites/dr_snapshots/
method GET
nickname getAllRemoteSiteSnapshots
count Maximum number of DR Snapshots paramType query

to retrieve
required false
type integer
required false

type string
required false
type string

group / vm details
required false
type boolean
entities array
Get the list of events generated on any Remote Site

GET /remote_sites/events
Table 600: Details
path /remote_sites/events
method GET
nickname getRemoteSiteEvents
required false
type integer
required false
type integer

required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the health check summary for the Remote Sites

GET /remote_sites/health_check_summary
Table 603: Details
path /remote_sites/health_check_summary
method GET
nickname getHealthCheckSummaryForRemoteSites
required false
type string

required false
type boolean
java.lang.Integer>>
entityType string
java.lang.Integer>
Get all pending replications

GET /remote_sites/pending_replications/
Table 606: Details
path /remote_sites/pending_replications/
method GET
nickname getPendingReplications
Protection Domain Names paramType query
required false
type array
remoteSiteNames Remote Site Names paramType query
required false
type array

Delete a Remote Site
DELETE /remote_sites/{name}
Table 608: Details
path /remote_sites/{name}
method DELETE
nickname markRemoteSiteForRemoval
name Name of the Remote Site paramType path
required true
type string
value boolean
Get a Remote Site

GET /remote_sites/{name}
Table 611: Details
path /remote_sites/{name}
method GET
nickname getRemoteSite
type get.dto.dr.RemoteSiteDTO

required true
type string
required false
type string
fullDetails Remote cluster details paramType query
required false
type boolean
remoteContainers Remote container to fetch paramType query
required false
type array
Table 613: get.dto.dr.RemoteSiteDTO
bandwidthPolicy get.dto.dr.BandwidthPolicyDTO
capabilities array
cloudType string
clusterArch string
clusterType array
cvmName string

metroReady boolean
name string
networkMapping get.dto.dr.NetworkMappingDTO
region string
remoteDrExternalSubnetAddress get.common.Address
java.lang.Integer>
java.lang.Integer>
get.dto.dr.RemoteSiteDTO$VStoreInfo>
sshEnabled boolean
java.lang.String>
status string
java.lang.String>
uuid string
java.lang.String>
Get the list of alerts generated on a specified Remote Site

GET /remote_sites/{name}/alerts
Table 614: Details
path /remote_sites/{name}/alerts
method GET
nickname getAlertsForRemoteSite

required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array


GET /remote_sites/{name}/dr_snapshots/
Table 617: Details
path /remote_sites/{name}/dr_snapshots/
method GET
nickname getSnapshotsForRemoteSite
required true
type string
count Maximum number of DR Snapshots paramType query

to retrieve
required false
type integer
required false
type string
required false
type string

group / vm details
required false
type boolean

entities array
Get the list of events generated on a specified Remote Site

GET /remote_sites/{name}/events
Table 620: Details
path /remote_sites/{name}/events
method GET
nickname getEventsForRemoteSite
required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean

required false
type integer
entities array
Get all pending replications for the specified Remote Site

GET /remote_sites/{name}/pending_replications/
Table 623: Details
path /remote_sites/{name}/pending_replications/
method GET
nickname getPendingReplicationsInRemote
required true
type string
required false
type array
Get the stats for a specified Remote Site

GET /remote_sites/{name}/stats/

Table 625: Details
path /remote_sites/{name}/stats/
method GET
nickname getRemoteSiteStats
required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer

22
AOS | Snmp | 262

SNMP
Get SNMP configuration
GET /snmp/
Table 628: Details
path /snmp/
method GET
nickname getSnmpInfo
type get.dto.appliance.configuration.SnmpInfoDTO
Table 629: get.dto.appliance.configuration.SnmpInfoDTO
enabled boolean
snmpTransports array
snmpTraps array
snmpUsers array
Add SNMP Transports

POST /snmp/add_transports
Table 630: Details
path /snmp/add_transports
method POST
nickname addSnmpTransports
type Array of
create.dto.appliance.configuration.SnmpTransportDTO
List of SNMP Transports paramType body
required true
AOS | Snmp | 263

type array
Remove SNMP Transports

POST /snmp/remove_transports
Table 632: Details
path /snmp/remove_transports
method POST
nickname deleteSnmpTransports
type Array of
create.dto.appliance.configuration.SnmpTransportDTO
List of SNMP Transports paramType body
required true
type array
Get the SNMP status

GET /snmp/status
Table 634: Details
path /snmp/status
method GET
nickname getSnmpStatus
type get.dto.PrimitiveDTO<java.lang.Boolean>
Table 635: get.dto.PrimitiveDTO<java.lang.Boolean>
value boolean
Enable/Disable SNMP configuration

PUT /snmp/status
AOS | Snmp | 264

Table 636: Details
path /snmp/status
method PUT
nickname setSnmpStatus
type update.dto.appliance.configuration.SnmpInfoDTO
Enable SNMP Status paramType body
required true
type update.dto.PrimitiveDTO<java
Table 638: update.dto.appliance.configuration.SnmpInfoDTO
enabled boolean
snmpTransports array
snmpTraps array
snmpUsers array
Get the list of SNMP Transports

GET /snmp/transports
Table 639: Details
path /snmp/transports
method GET
nickname getSnmpTransports
type Array of get.dto.appliance.configuration.SnmpTransportDTO
Get the list of SNMP Traps

GET /snmp/traps
AOS | Snmp | 265

Table 640: Details
path /snmp/traps
method GET
nickname getSnmpTraps
type Array of get.dto.appliance.configuration.SnmpTrapDTO
Modify SNMP Trap

PATCH /snmp/traps
Table 641: Details
path /snmp/traps
method PATCH
nickname patchSnmpTrap
type patch.dto.appliance.configuration.SnmpTrapDTO
An SNMP Trap instance paramType body
required true
Table 643: patch.dto.appliance.configuration.SnmpTrapDTO
communityString string
engineId string
inform boolean
log org.slf4j.Logger
port integer int32
receiverName string
transportProtocol string
trapAddress string
trapUsername string
AOS | Snmp | 266

version string
Add SNMP Trap

POST /snmp/traps
Table 644: Details
path /snmp/traps
method POST
nickname addSnmpTrap
type create.dto.appliance.configuration.SnmpTrapDTO
required true
Table 646: create.dto.appliance.configuration.SnmpTrapDTO
engineId string
inform boolean
port integer int32
receiverName string
trapAddress string
trapUsername string
version string
Edit SNMP Trap

PUT /snmp/traps
AOS | Snmp | 267

Table 647: Details
path /snmp/traps
method PUT
nickname editSnmpTrap
type update.dto.appliance.configuration.SnmpTrapDTO
required true
Table 649: update.dto.appliance.configuration.SnmpTrapDTO
engineId string
inform boolean
port integer int32
receiverName string
trapAddress string
trapUsername string
version string
Delete SNMP Trap

DELETE /snmp/traps/{trapAddress}
Table 650: Details
path /snmp/traps/{trapAddress}
method DELETE
nickname deleteSnmpTrap
AOS | Snmp | 268

trapAddress Address of the SNMP Trap paramType path
required true
type string
value boolean
Get SNMP Trap

GET /snmp/traps/{trapAddress}
Table 653: Details
path /snmp/traps/{trapAddress}
method GET
nickname getSnmpTrap
type get.dto.appliance.configuration.SnmpTrapDTO
trapAddress Address of the SNMP Trap paramType path
required true
type string
Table 655: get.dto.appliance.configuration.SnmpTrapDTO
engineId string
AOS | Snmp | 269

inform boolean
port integer int32
receiverName string
trapAddress string
trapUsername string
version string
Get the list of SNMP Users

GET /snmp/users
Table 656: Details
path /snmp/users
method GET
nickname getSnmpUsers
type Array of get.dto.appliance.configuration.SnmpUserDTO
Modify SNMP User

PATCH /snmp/users
Table 657: Details
path /snmp/users
method PATCH
nickname patchSnmpUser
type patch.dto.appliance.configuration.SnmpUserDTO
An SNMP User instance paramType body
required true
AOS | Snmp | 270

Table 659: patch.dto.appliance.configuration.SnmpUserDTO
authKey string
authType string
privKey string
privType string
username string
Add SNMP User

POST /snmp/users
Table 660: Details
path /snmp/users
method POST
nickname addSnmpUser
type create.dto.appliance.configuration.SnmpUserDTO
required true
Table 662: create.dto.appliance.configuration.SnmpUserDTO
authKey string
authType string
privKey string
privType string
username string
Edit SNMP User

PUT /snmp/users
AOS | Snmp | 271

Table 663: Details
path /snmp/users
method PUT
nickname editSnmpUser
type update.dto.appliance.configuration.SnmpUserDTO
required true
Table 665: update.dto.appliance.configuration.SnmpUserDTO
authKey string
authType string
privKey string
privType string
username string
Delete SNMP User

DELETE /snmp/users/{username}
Table 666: Details
path /snmp/users/{username}
method DELETE
nickname deleteSnmpUser
username Name of the SNMP User paramType path
AOS | Snmp | 272

required true
type string
value boolean
Get SNMP User

GET /snmp/users/{username}
Table 669: Details
path /snmp/users/{username}
method GET
nickname getSnmpUser
type get.dto.appliance.configuration.SnmpUserDTO
username Name of the SNMP User paramType path
required true
type string
Table 671: get.dto.appliance.configuration.SnmpUserDTO
authKey string
authType string
privKey string
privType string
username string
AOS | Snmp | 273

23
AOS | Storage pools | 274

STORAGE POOLS
Get the list of Storage Pools
GET /storage_pools/
Table 672: Details
path /storage_pools/
method GET
nickname getStoragePools
type get.base.EntityCollection<get.dto.appliance.configuration.StoragePoolDTO>
count Number of Storage Pools to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
required false
type array
required false
type integer

required false
type string
Table 674: get.base.EntityCollection<get.dto.appliance.configuration.StoragePoolDTO>
entities array
Update a Storage Pool

PATCH /storage_pools/
Table 675: Details
method PATCH
nickname patchStoragePool
An Storage Pool instance paramType body
required true
required false
type boolean
value boolean

Add a Storage Pool
POST /storage_pools/
Table 678: Details
method POST
nickname addStoragePool
A Storage Pool instance paramType body
required true
required false
type boolean
value boolean
Update a Storage Pool

PUT /storage_pools/
Table 681: Details
method PUT
nickname editStoragePool

An Storage Pool instance paramType body
required true
required false
type boolean
value boolean
Get the list of alerts generated on any Storage Pool

GET /storage_pools/alerts/
Table 684: Details
path /storage_pools/alerts/
method GET
nickname getStoragePoolAlerts
required false
type integer
required false
type integer
required false

type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on any Storage Pool

GET /storage_pools/events/
Table 687: Details
path /storage_pools/events/
method GET
nickname getStoragePoolEvents

required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Delete a Storage Pool

DELETE /storage_pools/{id}
Table 690: Details
path /storage_pools/{id}
method DELETE
nickname deleteStoragePool

id Id of the Storage Pool paramType path
required true
type string
value boolean
Get a Storage Pool

GET /storage_pools/{id}
Table 693: Details
path /storage_pools/{id}
method GET
nickname getStoragePool
type get.dto.appliance.configuration.StoragePoolDTO
id Id of the Storage Pool paramType path
required true
type string
required false
type string
Table 695: get.dto.appliance.configuration.StoragePoolDTO
capacity integer int64

clusterUuid string
diskUuids array
disks array
id string
ilmDownMigratePctThreshold integer int32
name string
reservedCapacity integer int64
java.lang.String>
tierwiseFreeCapacityMap java.util.Map<java.lang.String,
java.lang.Long>
java.lang.String>
Get the list of alerts generated on a specified Storage Pool

GET /storage_pools/{id}/alerts/
Table 696: Details
path /storage_pools/{id}/alerts/
method GET
nickname getAlertsForStoragePool
id Id of a Storage Pool paramType path
required true
type string
required false

type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on a specified Storage Pool

GET /storage_pools/{id}/events/

Table 699: Details
path /storage_pools/{id}/events/
method GET
nickname getEventsForStoragePool
required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array

Get the stats for a specified Storage Pool
GET /storage_pools/{id}/stats/
Table 702: Details
path /storage_pools/{id}/stats/
method GET
nickname getStoragePoolStats
required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer

24
AOS | Users | 286

USERS
Get Logged In Users Details
GET /users/logged_in_users
Table 705: Details
path /users/logged_in_users
method GET
nickname getAllLoggedInUsersInfo
type get.base.EntityCollection<get.auth.dto.UserDTO>
Table 706: get.base.EntityCollection<get.auth.dto.UserDTO>
entities array
Get Logged In Details of a user

GET /users/logged_in_users/{userName}
Table 707: Details
path /users/logged_in_users/{userName}
method GET
nickname getLoggedInUserInfo
type get.auth.dto.UserDTO
userName UserName of the Logged in User paramType path
required true
type string
AOS | Users | 287

Table 709: get.auth.dto.UserDTO
creationTimeUsecs integer int64
enabled boolean
lastAccessTimeUsecs integer int64
lastUpdatedByUser string
loginSessionInfo get.auth.dto.UserDTO
$LoginSessionInfoDTO
profile get.auth.dto.UserProfileDTO
roles array
25
AOS | Vdisks | 289

VDISKS
GET /vdisks/
Table 710: Details
path /vdisks/
method GET
nickname getAllVDisks
includedeleted Include deleted paramType query
required false
type boolean
vdiskNames vdisk names paramType query
required false
type array
required false
type string
Update a VDisk
PATCH /vdisks/
Table 712: Details
path /vdisks/
method PATCH
nickname patchVDisk
AOS | Vdisks | 290

A VDisk instance paramType body
required true
value boolean
Add a VDisk
POST /vdisks/
Table 715: Details
path /vdisks/
method POST
nickname addVDisk
type create.dto.appliance.configuration.VDiskDTO
required true
Table 717: create.dto.appliance.configuration.VDiskDTO
containerId string
containerName string
creationTimeInMicrosSinceEpoch integer int64
AOS | Vdisks | 291

disabled boolean
erasureCode string
immutable boolean
iscsiLun integer int32
iscsiTargetName string
maxCapacityBytes integer int64
name string
nfsFile boolean
nfsFileName string
onDiskDedup string
parentNfsFileName string
qosFairshare string
qosPriority string
shared boolean
snapshot boolean
snapshots array
java.lang.String>
storagePoolName string
totalReservedCapacityBytes integer int64
java.lang.String>
vdiskUuid string
Update a VDisk
PUT /vdisks/
AOS | Vdisks | 292

Table 718: Details
path /vdisks/
method PUT
nickname editVDisk
required true
value boolean
Get the list of alerts generated on any VDisk

GET /vdisks/alerts
Table 721: Details
path /vdisks/alerts
method GET
nickname getVDiskAlerts
required false
type integer
required false
AOS | Vdisks | 293

type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
Get the list of events generated on any VDisk

GET /vdisks/events
Table 724: Details
path /vdisks/events
method GET
AOS | Vdisks | 294

nickname getVDiskEvents
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Get the complete list of Snapshots

GET /vdisks/snapshots/
Table 727: Details
path /vdisks/snapshots/
AOS | Vdisks | 295

method GET
nickname getAllSnapshots
Get a Snapshot
GET /vdisks/snapshots/{name}/
Table 728: Details
path /vdisks/snapshots/{name}/
method GET
nickname getSnapshotByName
type get.dto.appliance.configuration.VDiskDTO
name Name of the snapshot paramType path
required true
type string
Table 730: get.dto.appliance.configuration.VDiskDTO
clusterUuid string
containerId string
disabled boolean
erasureCode string
AOS | Vdisks | 296

immutable boolean
name string
nfsFile boolean
nfsFileName string
onDiskDedup string
qosFairshare string
qosPriority string
shared boolean
snapshot boolean
snapshots array
java.lang.String>
java.lang.String>
vdiskUuid string
Delete a VDisk
DELETE /vdisks/{name}
Table 731: Details
path /vdisks/{name}
method DELETE
nickname deleteVDisk
AOS | Vdisks | 297

name Name of the VDisk paramType path
required true
type string
value boolean
Get a VDisk
GET /vdisks/{name}
Table 734: Details
path /vdisks/{name}
method GET
nickname getVDisk
type get.dto.appliance.configuration.VDiskDTO
required true
type string
required false
type string
Table 736: get.dto.appliance.configuration.VDiskDTO
clusterUuid string
AOS | Vdisks | 298

containerId string
disabled boolean
erasureCode string
immutable boolean
name string
nfsFile boolean
nfsFileName string
onDiskDedup string
qosFairshare string
qosPriority string
shared boolean
snapshot boolean
snapshots array
java.lang.String>
java.lang.String>
vdiskUuid string
AOS | Vdisks | 299

Get the list of alerts generated on a specified VDisk
GET /vdisks/{name}/alerts
Table 737: Details
path /vdisks/{name}/alerts
method GET
nickname getAlertsForVDisk
required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
AOS | Vdisks | 300

required false
type string
required false
type integer
entities array
Get the list of events generated on a specified VDisk

GET /vdisks/{name}/events
Table 740: Details
path /vdisks/{name}/events
method GET
nickname getEventsForVDisk
required true
type string
required false
type integer
AOS | Vdisks | 301

required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
entities array
Snapshot a VDisk
POST /vdisks/{name}/snapshots
Table 743: Details
path /vdisks/{name}/snapshots
method POST
nickname createSnapshot
type create.dto.appliance.configuration.VDiskDTO
required true
AOS | Vdisks | 302

type string
Name of the Snapshot paramType body
required true
Table 745: create.dto.appliance.configuration.VDiskDTO
containerId string
disabled boolean
erasureCode string
immutable boolean
name string
nfsFile boolean
nfsFileName string
onDiskDedup string
qosFairshare string
qosPriority string
shared boolean
snapshot boolean
snapshots array
AOS | Vdisks | 303

java.lang.String>
java.lang.String>
vdiskUuid string

GET /vdisks/{name}/snapshots/
Table 746: Details
path /vdisks/{name}/snapshots/
method GET
nickname getVDiskSnapshots
required true
type string
Get the stats for a specified VDisk

GET /vdisks/{name}/stats/
Table 748: Details
path /vdisks/{name}/stats/
method GET
nickname getVDiskStats
AOS | Vdisks | 304

required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer
AOS | Vdisks | 305

26
AOS | Vfilers | 306

VFILERS
Get FileServers based on passed criteria
GET /vfilers/
Table 751: Details
path /vfilers/
method GET
nickname getFileServers
type get.base.EntityCollection<get.dto.minerva.FileServerDTO>
required false
type integer
required false
type string
required false
type string
required false
type string
Table 753: get.base.EntityCollection<get.dto.minerva.FileServerDTO>
entities array
AOS | Vfilers | 307

Create a FileServer
POST /vfilers/
Table 754: Details
path /vfilers/
method POST
nickname addFileServer
type create.dto.ResponseDTO
Create a FileServer paramType body
required true
type create.dto.minerva.FileServerO
Table 756: create.dto.ResponseDTO
dtos java.util.Map<java.lang.String,
unknown>
errorList array
message string
successList array
taskUuid string
Update file server configuration

PUT /vfilers/
Table 757: Details
path /vfilers/
method PUT
nickname updateFileServer
type update.dto.ResponseDTO
AOS | Vfilers | 308

Update file server configuration paramType body
required true
type update.dto.minerva.FileServerU
Table 759: update.dto.ResponseDTO
unknown>
errorList array
message string
successList array
taskUuid string
Get the pulse configs

GET /vfilers/pulse/
Table 760: Details
path /vfilers/pulse/
method GET
nickname getPulseConfigs
type Array of get.dto.minerva.FileServerPulseConfigDTO
Get the list of Shares associated with all file servers

GET /vfilers/shares/
Table 761: Details
path /vfilers/shares/
method GET
nickname getAllFileServersShares
type get.base.EntityCollection<get.dto.minerva.ShareDTO>
AOS | Vfilers | 309

count Number of shares to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type array
required false
type string
Table 763: get.base.EntityCollection<get.dto.minerva.ShareDTO>
entities array
Get File server snapshot info

POST /vfilers/snapshot_info
Table 764: Details
path /vfilers/snapshot_info
method POST
nickname getFileServerSnapshotInfo
type Array of create.dto.minerva.FileServerPDSnapshotDTO
AOS | Vfilers | 310

Snapshot info DTO paramType body
required true
type create.dto.minerva.FileServerS
Upgrade given list of file servers

POST /vfilers/upgrade
Table 766: Details
path /vfilers/upgrade
method POST
nickname upgradeFileServer
Upgrade File Server List paramType body
required true
type array
skipCompatibilityCheck
Skip NOS compatibility check paramType query
required false
type boolean
taskUuid Task Uuid paramType query
required false
type string
parentTaskUuid Parent task Uuid paramType query
required false
type string
AOS | Vfilers | 311

unknown>
errorList array
message string
successList array
taskUuid string
Upgrade files module

POST /vfilers/upgradeFilesModule
Table 769: Details
path /vfilers/upgradeFilesModule
method POST
nickname upgradeFilesModule
Upgrade Files Module paramType body
required true
type create.dto.minerva.UpgradeFil
unknown>
errorList array
message string
successList array
taskUuid string
AOS | Vfilers | 312

Get the file servers usage
GET /vfilers/usage/
Table 772: Details
path /vfilers/usage/
method GET
nickname getFileServersUsage
type Array of get.dto.minerva.FileServersUsageDTO
Delete FileServer
DELETE /vfilers/{uuid}
Table 773: Details
path /vfilers/{uuid}
method DELETE
nickname deleteFileServer
type delete.dto.ResponseDTO
uuid UUID of the FileServer paramType path
required true
type string
force force delete file server paramType query
required false
type boolean
deletePdAndSnapshots
delete pd and all snapshots paramType query
required false
type boolean
deleteContainer delete container associated with file paramType query

server
required false
type boolean
AOS | Vfilers | 313

Table 775: delete.dto.ResponseDTO
unknown>
errorList array
message string
successList array
taskUuid string
Get a single FileServer's details

GET /vfilers/{uuid}
Table 776: Details
path /vfilers/{uuid}
method GET
nickname getFileServer
type get.dto.minerva.FileServerDTO
uuid uuid of the FileServer paramType path
required true
type string
required false
type string
Table 778: get.dto.minerva.FileServerDTO
clusterUuid string
containerId string
createdTimeStampInUsecs integer int64
AOS | Vfilers | 314

description string
dnsDomainName string
dnsEntries array
dnsServerIpAddresses array
domainDirectoryDTO get.dto.minerva.DomainDirectoryDTO
externalIpAddress string
externalNetworks array
externalVirtualNetworkUuids array
fileBlockingExtensions array
fileServerCompression boolean
fileServerState string
internalNetwork get.dto.minerva.FileServerNetworkDTO
internalVirtualNetworkUuid string
isRebalanceNeeded boolean
lastModifiedTimeStampInUsecs integer int64
name string
nameServicesDTO get.dto.minerva.NameServicesDTO
ntpServers array
numHomeShares integer int64
numNestedShares integer int64
numShares integer int64
nvms array
objectVersion string
pdStatus boolean
protectionDomainState boolean
recommendation get.dto.minerva.FileServerRecommendationsDTO
java.lang.String>
upgradeInProgress boolean
java.lang.String>
uuid string
AOS | Vfilers | 315

version string
vms array
Activate File Server

POST /vfilers/{uuid}/activate
Table 779: Details
path /vfilers/{uuid}/activate
method POST
nickname activateFileServer
required true
type string
Activate paramType body
required true
unknown>
errorList array
message string
successList array
taskUuid string
Add Dns Entries

POST /vfilers/{uuid}/addDns
AOS | Vfilers | 316

Table 782: Details
path /vfilers/{uuid}/addDns
method POST
nickname AddDNS
required true
type string
Add Dns Entries paramType body
required true
type create.dto.minerva.FileServerD
unknown>
errorList array
message string
successList array
taskUuid string
Get the list of admin users

GET /vfilers/{uuid}/admin_users/
Table 785: Details
path /vfilers/{uuid}/admin_users/
method GET
nickname getAdminUsers
type get.base.EntityCollection<get.dto.minerva.AdminUserDTO>
AOS | Vfilers | 317

uuid uuid of the file server paramType path
required true
type string
Table 787: get.base.EntityCollection<get.dto.minerva.AdminUserDTO>
entities array
Add new admin user

POST /vfilers/{uuid}/admin_users/
Table 788: Details
method POST
nickname addAdminUser
type create.dto.minerva.AdminUserDTO
uuid Uuid of the file server that admin paramType path

user is associated with
required true
type string
Add admin user paramType body
required true
type create.dto.minerva.AdminUser
AOS | Vfilers | 318

Table 790: create.dto.minerva.AdminUserDTO
fileServerUuid string
role string
user string
Update Admin User

PUT /vfilers/{uuid}/admin_users/
Table 791: Details
method PUT
nickname updateAdminUser
type update.dto.minerva.AdminUserDTO

required true
type string
Update Admin User paramType body
required true
type update.dto.minerva.AdminUse
Table 793: update.dto.minerva.AdminUserDTO
role string
user string
uuid string
Delete Admin User

DELETE /vfilers/{uuid}/admin_users/{adminUserUuid}
AOS | Vfilers | 319

Table 794: Details
path /vfilers/{uuid}/admin_users/{adminUserUuid}
method DELETE
nickname deleteAdminUser

required true
type string
adminUserUuid uuid of the admin user paramType path
required true
type string
value boolean
Get a single admin user

GET /vfilers/{uuid}/admin_users/{adminUserUuid}
Table 797: Details
path /vfilers/{uuid}/admin_users/{adminUserUuid}
method GET
nickname getAdminUser
type get.dto.minerva.AdminUserDTO

required true
AOS | Vfilers | 320

type string
adminUserUuid uuid of the admin user paramType path
required true
type string
Table 799: get.dto.minerva.AdminUserDTO
role string
user string
uuid string
Get built in groups per file server

GET /vfilers/{uuid}/builtin_groups
Table 800: Details
path /vfilers/{uuid}/builtin_groups
method GET
nickname getBuiltInGroups
type Array of get.dto.minerva.BuiltInGroupDTO
uuid uuid of the FileServer paramType path
required true
type string
required false
type string
Clone File Server

POST /vfilers/{uuid}/clone
AOS | Vfilers | 321

Table 802: Details
path /vfilers/{uuid}/clone
method POST
nickname cloneFileServer
required true
type string
Clone paramType body
required true
unknown>
errorList array
message string
successList array
taskUuid string
Configure Name services

POST /vfilers/{uuid}/configureNameServices
Table 805: Details
path /vfilers/{uuid}/configureNameServices
method POST
nickname configureNameServices
AOS | Vfilers | 322

required true
type string
Name Services paramType body
required true
type create.dto.minerva.NameServic
unknown>
errorList array
message string
successList array
taskUuid string
Get the list of dns entries

GET /vfilers/{uuid}/dnsEntries/
Table 808: Details
path /vfilers/{uuid}/dnsEntries/
method GET
nickname getDnsEntries
type Array of get.dto.minerva.FileServerDNSEntryDTO
required true
type string
AOS | Vfilers | 323

Get the list of icap servers
GET /vfilers/{uuid}/icap_servers/
Table 810: Details
path /vfilers/{uuid}/icap_servers/
method GET
nickname getIcapServers
type get.base.EntityCollection<get.dto.minerva.IcapServerDTO>
required true
type string
Table 812: get.base.EntityCollection<get.dto.minerva.IcapServerDTO>
entities array
Add new icap server

POST /vfilers/{uuid}/icap_servers/
Table 813: Details
method POST
nickname addIcapServer
type create.dto.minerva.IcapServerDTO
AOS | Vfilers | 324

uuid Uuid of the file server that icap paramType path

server is associated with
required true
type string
Add icap server paramType body
required false
type create.dto.minerva.IcapServerA
Table 815: create.dto.minerva.IcapServerDTO
avgLatency number float
connectionStatus string
description string
enable boolean
endTimeInUsces string
ipAddress string
numDisconnectCount integer int64
numFileScanned integer int64
partnerType string
portNumber string
startTimeInUsecs string
uuid string
Update Icap Server

PUT /vfilers/{uuid}/icap_servers/
Table 816: Details
method PUT
nickname updateIcapServer
type update.dto.minerva.IcapServerDTO
AOS | Vfilers | 325

uuid Uuid of the file server that Icap is paramType path

associated with
required true
type string
Update Icap Server paramType body
required true
type update.dto.minerva.IcapServer
Table 818: update.dto.minerva.IcapServerDTO
description string
enable boolean
ipAddress string
partnerType string
portNumber string
uuid string
Delete icap server

DELETE /vfilers/{uuid}/icap_servers/{icapServerUuid}
Table 819: Details
path /vfilers/{uuid}/icap_servers/{icapServerUuid}
method DELETE
nickname deleteIcapServer
AOS | Vfilers | 326

uuid Uuid of the file server that icap is paramType path

associated with
required true
type string
icapServerUuid uuid of the icap server paramType path
required true
type string
value boolean
Get a icap server

GET /vfilers/{uuid}/icap_servers/{icapServerUuid}
Table 822: Details
path /vfilers/{uuid}/icap_servers/{icapServerUuid}
method GET
nickname getIcapServer
type get.dto.minerva.IcapServerDTO
required true
type string
required true
type string
AOS | Vfilers | 327

Table 824: get.dto.minerva.IcapServerDTO
description string
enable boolean
ipAddress string
partnerType string
portNumber string
uuid string
Get the stats for a specified Icap server

GET /vfilers/{uuid}/icap_servers/{icapServerUuid}/stats
Table 825: Details
path /vfilers/{uuid}/icap_servers/{icapServerUuid}/stats
method GET
nickname getIcapServerStats
required true
type string
required true
type string
AOS | Vfilers | 328

required true
type string
required false
type integer
required false
type integer
required false
type integer
Test Icap Server Connection

POST /vfilers/{uuid}/icap_servers/{icapServerUuid}/test_connection
Table 828: Details
path /vfilers/{uuid}/icap_servers/{icapServerUuid}/
test_connection
method POST
nickname testIcapServerConnection
uuid Uuid of the file server that icap paramType path

server is associated with
required true
type string
AOS | Vfilers | 329

required true
type string
value string
Get the list of infected files

GET /vfilers/{uuid}/infected_files/
Table 831: Details
path /vfilers/{uuid}/infected_files/
method GET
nickname getInfectedFiles
type get.base.EntityCollection<get.dto.minerva.InfectedFileDTO>
required true
type string
shareUuid Uuid of the share paramType query
required false
type string
quarantined Quarantined paramType query
required true
type boolean
count Number of infected files to retrieve paramType query
required false
type integer
AOS | Vfilers | 330

required false
type integer
required false
type string
required false
type string
required false
type string
Table 833: get.base.EntityCollection<get.dto.minerva.InfectedFileDTO>
entities array
Delete list of infected files

POST /vfilers/{uuid}/infected_files/delete
Table 834: Details
path /vfilers/{uuid}/infected_files/delete
method POST
nickname deleteInfectedFiles
AOS | Vfilers | 331

required true
type string
infected files dto paramType body
required true
type create.dto.minerva.InfectedFile
unknown>
errorList array
message string
successList array
taskUuid string
Quarantine list of infected files

POST /vfilers/{uuid}/infected_files/quarantine
Table 837: Details
path /vfilers/{uuid}/infected_files/quarantine
method POST
nickname quarantineInfectedFiles
required true
type string
required true
AOS | Vfilers | 332

unknown>
errorList array
message string
successList array
taskUuid string
Rescan list of infected files

POST /vfilers/{uuid}/infected_files/rescan
Table 840: Details
path /vfilers/{uuid}/infected_files/rescan
method POST
nickname rescanInfectedFiles
required true
type string
required true
unknown>
errorList array
message string
AOS | Vfilers | 333

successList array
taskUuid string
Reset list of infected files

POST /vfilers/{uuid}/infected_files/reset
Table 843: Details
path /vfilers/{uuid}/infected_files/reset
method POST
nickname resetInfectedFiles
required true
type string
required true
unknown>
errorList array
message string
successList array
taskUuid string
Unquarantine list of infected files

POST /vfilers/{uuid}/infected_files/unquarantine
AOS | Vfilers | 334

Table 846: Details
path /vfilers/{uuid}/infected_files/unquarantine
method POST
nickname unquarantineInfectedFiles
required true
type string
required true
unknown>
errorList array
message string
successList array
taskUuid string
Get infected file

GET /vfilers/{uuid}/infected_files/{infectedFileUuid}
Table 849: Details
path /vfilers/{uuid}/infected_files/{infectedFileUuid}
method GET
nickname getInfectedFile
type get.dto.minerva.InfectedFileDTO
AOS | Vfilers | 335

required true
type string
infectedFileUuid uuid of the infected file paramType path
required true
type string
quarantined Quarantined paramType query
required false
type boolean
Table 851: get.dto.minerva.InfectedFileDTO
filePath string
fsUuid string
icapServer string
quarantined boolean
scanTimestampUsecs integer int64
shareName string
shareUuid string
threatDescription string
uuid string
Join Domain
POST /vfilers/{uuid}/joinDomain
Table 852: Details
path /vfilers/{uuid}/joinDomain
method POST
nickname joinDomain
AOS | Vfilers | 336

required true
type string
Join Domain paramType body
required true
type create.dto.minerva.DomainDire
unknown>
errorList array
message string
successList array
taskUuid string
LoadBalance File Server

POST /vfilers/{uuid}/loadBalance
Table 855: Details
path /vfilers/{uuid}/loadBalance
method POST
nickname loadBalanceFileServer
required true
type string
LoadBalance paramType body
AOS | Vfilers | 337

required true
type create.dto.minerva.FileServerU
unknown>
errorList array
message string
successList array
taskUuid string
Protect File Server

POST /vfilers/{uuid}/protect
Table 858: Details
path /vfilers/{uuid}/protect
method POST
nickname protectFileServer
required true
type string
pdName pd name paramType query
required false
type string
AOS | Vfilers | 338

unknown>
errorList array
message string
successList array
taskUuid string
Remove Dns Entries

POST /vfilers/{uuid}/removeDns
Table 861: Details
path /vfilers/{uuid}/removeDns
method POST
nickname removeDNS
required true
type string
Remove Dns Entries paramType body
required true
type create.dto.minerva.FileServerD
unknown>
errorList array
message string
AOS | Vfilers | 339

successList array
taskUuid string
Search User Mapping

POST /vfilers/{uuid}/searchUserMappings/
Table 864: Details
path /vfilers/{uuid}/searchUserMappings/
method POST
nickname searchUserMapping
type Array of create.dto.minerva.SearchUserMappingResponseDTO
uuid uuid of the File Server paramType path
required true
type string
Search User Mapping paramType body
required true
type create.dto.minerva.SearchUser
Get file server security details

GET /vfilers/{uuid}/security-info/
Table 866: Details
path /vfilers/{uuid}/security-info/
method GET
nickname getFileServerSecurityInfo
type get.dto.minerva.FileServerSecurityComplianceConfigDTO
AOS | Vfilers | 340

uuid Uuid of the FileServer paramType path
required true
type string
Table 868: get.dto.minerva.FileServerSecurityComplianceConfigDTO
enableAide boolean
enableBanner boolean
enableCore boolean
enableHighStrengthPassword boolean
schedule string
Update FileServer security config

PUT /vfilers/{uuid}/security-info/
Table 869: Details
path /vfilers/{uuid}/security-info/
method PUT
nickname editFileServerParams
required true
type string
A FileServer Security config instance paramType body
required true
type update.dto.minerva.FileServerS
AOS | Vfilers | 341

value boolean
Get the list of Shares

GET /vfilers/{uuid}/shares/
Table 872: Details
path /vfilers/{uuid}/shares/
method GET
nickname getFileServersShares
type get.base.EntityCollection<get.dto.minerva.ShareDTO>
required true
type string
required false
type integer
required false
type string
required false
type string
required false
type array
required false
type string
AOS | Vfilers | 342

Table 874: get.base.EntityCollection<get.dto.minerva.ShareDTO>
entities array
Add new Share

POST /vfilers/{uuid}/shares/
Table 875: Details
method POST
nickname addFileServerShare
required true
type string
Add Share paramType body
required true
type create.dto.minerva.AddShareD
unknown>
errorList array
message string
successList array
taskUuid string
AOS | Vfilers | 343

Update file server share configuration
PUT /vfilers/{uuid}/shares/
Table 878: Details
method PUT
nickname updateFileServerShare
required true
type string
Update file server share paramType body

configuration
required true
type update.dto.minerva.UpdateSha
unknown>
errorList array
message string
successList array
taskUuid string
Delete File Server Share

DELETE /vfilers/{uuid}/shares/{shareUuid}
Table 881: Details
path /vfilers/{uuid}/shares/{shareUuid}
AOS | Vfilers | 344

method DELETE
nickname deleteFileServerShare
required true
type string
shareUuid uuid of the FileServer share paramType path
required true
type string
force force delete Share paramType query
required false
type boolean
unknown>
errorList array
message string
successList array
taskUuid string
Get the Share

GET /vfilers/{uuid}/shares/{shareUuid}
Table 884: Details
path /vfilers/{uuid}/shares/{shareUuid}
method GET
nickname getFileServerShare
type get.dto.minerva.ShareDTO
AOS | Vfilers | 345

required true
type string
shareUuid uuid of the FileServer share paramType path
required true
type string
required false
type string
Table 886: get.dto.minerva.ShareDTO
anonymousGid integer int32
anonymousUid integer int32
authenticationType string
blockedClients get.dto.minerva.ShareUserBlockingDTO
caseSensitiveNamespaceEnabled boolean
clientNoAccess string
clientReadOnly string
clientReadWrite string
clusterUuid string
concurrentReadsEnabled boolean
containerId string
createdTimeStampInUsecs integer int64
defaultQuotaLimitGiB number float
defaultQuotaPolicyUuid string
defaultShareAccessType string
description string
enableAccessBasedEnumeration boolean
AOS | Vfilers | 346

enablePreviousVersion boolean
enableSmb3Encryption boolean
fileBlockingExtensions array
fileServerDnsDomainName string
fileServerName string
lastModifiedTimeStampInUsecs integer int64
maxSizeGiB integer int64
name string
nestedShares java.util.Map<java.lang.String,
java.lang.String>
noAccessMask boolean
objectVersion string
parentShareUuid string
protocolType string
quotaEnforcementType string
quotaNotificationRecipients array
roAccessMask boolean
secondaryProtocolType string
sendQuotaNotificationsToUser boolean
sharePath string
shareState string
shareType string
simultaneousAccessEnabled boolean
squashType string
java.lang.String>
symlinkCreationEnabled boolean
java.lang.String>
uuid string
windowsAdDomainName string
AOS | Vfilers | 347

Get principal type from principal name
POST /vfilers/{uuid}/shares/{shareUuid}/get_principal_type/
Table 887: Details
path /vfilers/{uuid}/shares/{shareUuid}/get_principal_type/
method POST
nickname getPrincipalType
uuid Uuid of the file server that quota paramType path

policy is associated with
required true
type string
shareUuid Uuid of the share that principal type paramType path

is associated with
required true
type string
Get principal type paramType body
required true
type create.dto.minerva.GetPrincipa
value string
Get the list of quota policies

GET /vfilers/{uuid}/shares/{shareUuid}/quota_policies/
Table 890: Details
path /vfilers/{uuid}/shares/{shareUuid}/quota_policies/
method GET
nickname getQuotaPolicies
AOS | Vfilers | 348

type get.base.EntityCollection<get.dto.minerva.QuotaPolicyDTO>

required true
type string
shareUuid uuid of the share paramType path
required true
type string
Table 892: get.base.EntityCollection<get.dto.minerva.QuotaPolicyDTO>
entities array
Add new Quota Policy

POST /vfilers/{uuid}/shares/{shareUuid}/quota_policies/
Table 893: Details
method POST
nickname addQuotaPolicy

required true
type string
AOS | Vfilers | 349

shareUuid Uuid of the share that quota policy is paramType path

associated with
required true
type string
Add Quota Policy paramType body
required true
type create.dto.minerva.QuotaPolic
unknown>
errorList array
message string
successList array
taskUuid string
Update Quota Policy

PUT /vfilers/{uuid}/shares/{shareUuid}/quota_policies/
Table 896: Details
method PUT
nickname updateQuotaPolicy

required true
type string

associated with
required true
AOS | Vfilers | 350

type string
Update Quota Policy paramType body
required true
type update.dto.minerva.QuotaPolic
unknown>
errorList array
message string
successList array
taskUuid string
Delete Quota Policy

DELETE /vfilers/{uuid}/shares/{shareUuid}/quota_policies/{quotaPolicyUuid}
Table 899: Details
{quotaPolicyUuid}
method DELETE
nickname deleteQuotaPolicy

required true
type string

associated with
required true
type string
AOS | Vfilers | 351

quotaPolicyUuid uuid of the quota policy paramType path
required true
type string
unknown>
errorList array
message string
successList array
taskUuid string
Get a single quota policy

GET /vfilers/{uuid}/shares/{shareUuid}/quota_policies/{quotaPolicyUuid}
Table 902: Details
{quotaPolicyUuid}
method GET
nickname getQuotaPolicy
type get.dto.minerva.QuotaPolicyDTO

required true
type string
shareUuid uuid of the share paramType path
required true
type string
quotaPolicyUuid uuid of the quota policy paramType path
AOS | Vfilers | 352

required true
type string
Table 904: get.dto.minerva.QuotaPolicyDTO
notificationRecipients array
principalType string
principalValue string
quotaEnforcementType string
quotaSizeGiB number float
sendQuotaNotificationsToUser boolean
shareUuid string
uuid string
Get the stats for a specified share

GET /vfilers/{uuid}/shares/{shareUuid}/stats/
Table 905: Details
path /vfilers/{uuid}/shares/{shareUuid}/stats/
method GET
nickname getFileServerShareStats
required true
type string
shareUuid uuid of the file server share paramType path
required true
type string
AOS | Vfilers | 353

required true
type string
required false
type integer
required false
type integer
required false
type integer
Delete Virus Scan Policy

DELETE /vfilers/{uuid}/shares/{shareUuid}/virus_scan_policy/
Table 908: Details
path /vfilers/{uuid}/shares/{shareUuid}/virus_scan_policy/
method DELETE
nickname deleteVirusScanPolicy
type delete.dto.PrimitiveDTO
uuid Uuid of the file server that virus scan paramType path
required true
type string
AOS | Vfilers | 354

shareUuid Uuid of the share that virus scan paramType path

required true
type string
Table 910: delete.dto.PrimitiveDTO
value
Get the list of snapshot policies

GET /vfilers/{uuid}/snapshot_policies/
Table 911: Details
path /vfilers/{uuid}/snapshot_policies/
method GET
nickname getSnapshotPolicies
type get.base.EntityCollection<get.dto.minerva.SnapshotPolicyDTO>
required true
type string
Table 913: get.base.EntityCollection<get.dto.minerva.SnapshotPolicyDTO>
entities array
Add new Snapshot Policy

POST /vfilers/{uuid}/snapshot_policies/
AOS | Vfilers | 355

Table 914: Details
method POST
nickname addSnapshotPolicy
uuid Uuid of the file server that snapshot paramType path

required true
type string
Add Snapshot Policy paramType body
required true
type create.dto.minerva.SnapshotPo
value string
Update Snapshot Policy

PUT /vfilers/{uuid}/snapshot_policies/
Table 917: Details
method PUT
nickname updateSnapshotPolicy
type update.dto.PrimitiveDTO<java.lang.String>

required true
AOS | Vfilers | 356

type string
Update Snapshot Policy paramType body
required true
type update.dto.minerva.SnapshotP
Table 919: update.dto.PrimitiveDTO<java.lang.String>
value string
Delete Snapshot Policy

DELETE /vfilers/{uuid}/snapshot_policies/{snapshotPolicyUuid}
Table 920: Details
path /vfilers/{uuid}/snapshot_policies/{snapshotPolicyUuid}
method DELETE
nickname deleteSnapshotPolicy
type delete.dto.PrimitiveDTO<java.lang.String>

required true
type string
snapshotPolicyUuiduuid of the snapshot policy paramType path
required true
type string
Table 922: delete.dto.PrimitiveDTO<java.lang.String>
value string
AOS | Vfilers | 357

Get the list of snapshots
GET /vfilers/{uuid}/snapshots/{shareUuid}
Table 923: Details
path /vfilers/{uuid}/snapshots/{shareUuid}
method GET
nickname getSnapshots
type get.base.EntityCollection<get.dto.minerva.FileServerSnapshotDTO>
required true
type string
required true
type string
Table 925: get.base.EntityCollection<get.dto.minerva.FileServerSnapshotDTO>
entities array
Get a file server share snapshot

GET /vfilers/{uuid}/snapshots/{shareUuid}/{snapshotUuid}
Table 926: Details
path /vfilers/{uuid}/snapshots/{shareUuid}/{snapshotUuid}
method GET
nickname getSnapshot
type get.dto.minerva.FileServerSnapshotDTO
AOS | Vfilers | 358

required true
type string
required true
type string
snapshotUuid uuid of the file server share snapshot paramType path
required true
type string
Table 928: get.dto.minerva.FileServerSnapshotDTO
createTime integer int64
creator string
fsUuid string
reclaimableSpaceBytes integer int64
shareUuid string
snapshotId string
totalSpaceBytes integer int64
uuid string
Get the ssl certificate details of FileServer

GET /vfilers/{uuid}/ssl_certificate
Table 929: Details
path /vfilers/{uuid}/ssl_certificate
method GET
nickname getSslCertificate
type get.auth.dto.keys.SslPemCertificateInformationDto
AOS | Vfilers | 359

required true
type string
Table 931: get.auth.dto.keys.SslPemCertificateInformationDto
city string
commonName string
countryCode string
expiryDate string
keyType string
signAlgoName string
state string
ReGenerate Self Signed Certificate

POST /vfilers/{uuid}/ssl_certificate
Table 932: Details
path /vfilers/{uuid}/ssl_certificate
method POST
nickname generateSslCertificate
type create.auth.dto.keys.KeyDTO
required true
type string
AOS | Vfilers | 360

ssl_certificate paramType body
required true
type create.auth.dto.keys.KeyDTO
Table 934: create.auth.dto.keys.KeyDTO
caChain array
cert array
key array
keyType string
name string
password string
Get the stats for a specified FS

GET /vfilers/{uuid}/stats/
Table 935: Details
path /vfilers/{uuid}/stats/
method GET
nickname getStats
uuid uuid of the FS paramType path
required true
type string
required true
type string
AOS | Vfilers | 361

required false
type integer
required false
type integer
required false
type integer
Unjoin Domain
POST /vfilers/{uuid}/unjoinDomain
Table 938: Details
path /vfilers/{uuid}/unjoinDomain
method POST
nickname unjoinDomain
required true
type string
Unjoin Domain paramType body
required true
type create.dto.minerva.UnjoinDom
AOS | Vfilers | 362

unknown>
errorList array
message string
successList array
taskUuid string
Get the user mapping

GET /vfilers/{uuid}/userMappings/
Table 941: Details
path /vfilers/{uuid}/userMappings/
method GET
nickname getUserMapping
type get.dto.minerva.UserMappingDTO
required true
type string
Table 943: get.dto.minerva.UserMappingDTO
explicitMapping get.dto.minerva.ExplicitIdentityMappingDTO
ruleBasedMapping get.dto.minerva.RuleBasedMappingDTO
Add new User Mapping

POST /vfilers/{uuid}/userMappings/
AOS | Vfilers | 363

Table 944: Details
method POST
nickname addUserMapping
required true
type string
Add User Mapping paramType body
required true
type create.dto.minerva.UserMappin
unknown>
errorList array
message string
successList array
taskUuid string
Update User Mapping

PUT /vfilers/{uuid}/userMappings/
Table 947: Details
method PUT
nickname updateUserMapping
AOS | Vfilers | 364

required true
type string
Update User Mapping paramType body
required true
type update.dto.minerva.UserMappi
unknown>
errorList array
message string
successList array
taskUuid string
Delete FileServer User

DELETE /vfilers/{uuid}/users/
Table 950: Details
path /vfilers/{uuid}/users/
method DELETE
nickname deleteUser
uuid Uuid of the file server that user is paramType path

associated with
required true
type string
user Name of the user paramType query
AOS | Vfilers | 365

required true
type string
value boolean
Get the list of users

GET /vfilers/{uuid}/users/
Table 953: Details
method GET
nickname getUsers
type Array of get.dto.minerva.FileServerUserDTO
required true
type string
Add new user

POST /vfilers/{uuid}/users/
Table 955: Details
method POST
nickname addUser
type create.dto.minerva.FileServerUserDTO
AOS | Vfilers | 366


associated with
required true
type string
Add user paramType body
required true
type create.dto.minerva.FileServerU
Table 957: create.dto.minerva.FileServerUserDTO
password string
role string
roles array
username string
Update User
PUT /vfilers/{uuid}/users/
Table 958: Details
method PUT
nickname updateUser
type update.dto.minerva.FileServerUserDTO

associated with
required true
type string
Update User paramType body
AOS | Vfilers | 367

required true
type update.dto.minerva.FileServerU
Table 960: update.dto.minerva.FileServerUserDTO
password string
role string
roles array
username string
Verify Dns Entries

POST /vfilers/{uuid}/verifyDns
Table 961: Details
path /vfilers/{uuid}/verifyDns
method POST
nickname verifyDNS
required true
type string
dnsServer Dns server IP address paramType query
required false
type string
AOS | Vfilers | 368

unknown>
errorList array
message string
successList array
taskUuid string
Get a virus scan policy

GET /vfilers/{uuid}/virus_scan_policy
Table 964: Details
path /vfilers/{uuid}/virus_scan_policy
method GET
nickname getVirusScanPolicy
type get.dto.minerva.VirusScanPolicyDTO
required true
type string
shareUuid uuid of the file server share paramType query
required false
type string
Table 966: get.dto.minerva.VirusScanPolicyDTO
blockAccessFile boolean
enableAntiVirus boolean
fileSizeExclusion integer int64
AOS | Vfilers | 369

fileTypeExclusions array
scanOnRead boolean
scanOnWrite boolean
scanTimeoutIntervalInSecs integer int32
shareUuid string
uuid string
Add Virus Scan Policy

POST /vfilers/{uuid}/virus_scan_policy/
Table 967: Details
path /vfilers/{uuid}/virus_scan_policy/
method POST
nickname addVirusScanPolicy
type create.dto.minerva.VirusScanPolicyDTO
uuid Uuid of the file server paramType path
required true
type string
Add virus scan policy paramType body
required true
type create.dto.minerva.VirusScanP
Table 969: create.dto.minerva.VirusScanPolicyDTO
AOS | Vfilers | 370

scanOnRead boolean
scanOnWrite boolean
shareUuid string
uuid string
Update Antivirus Server Scan Policy

PUT /vfilers/{uuid}/virus_scan_policy/
Table 970: Details
path /vfilers/{uuid}/virus_scan_policy/
method PUT
nickname updateVirusScanPolicy
type update.dto.minerva.VirusScanPolicyDTO
uuid Uuid of the file server that antivirus paramType path

scan policy is associated with
required true
type string
Update Antivirus Server scan policy paramType body
required true
type update.dto.minerva.VirusScanP
Table 972: update.dto.minerva.VirusScanPolicyDTO
AOS | Vfilers | 371

scanOnRead boolean
scanOnWrite boolean
shareUuid string
uuid string
27
AOS | Virtual disks | 373

VIRTUAL DISKS
Get the list of VirtualDisks
GET /virtual_disks/
Table 973: Details
path /virtual_disks/
method GET
nickname getVirtualDisks
type get.base.EntityCollection<get.dto.appliance.configuration.VirtualDiskDTO>
count Number of VirtualDisks to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
required false
type array
required false
type integer

required false
type string
Table 975: get.base.EntityCollection<get.dto.appliance.configuration.VirtualDiskDTO>
entities array
Get VirtualDisk
GET /virtual_disks/{id}
Table 976: Details
path /virtual_disks/{id}
method GET
nickname getVirtualDisk
type get.dto.appliance.configuration.VirtualDiskDTO
id Uuid of the VirtualDisk paramType path
required true
type string
required false
type string
Table 978: get.dto.appliance.configuration.VirtualDiskDTO
attachedVMName string

attachedVmId string
attachedVmUuid string
attachedVolumeGroupId string
clusterUuid string
containerId string
datasourceUuid string
deviceUuid string
diskAddress string
diskCapacityInBytes integer int64
nutanixNFSFilePath string
java.lang.String>
java.lang.String>
uuid string
virtualDiskId string
Get the stats for a specified VirtualDisk

GET /virtual_disks/{id}/stats/
Table 979: Details
path /virtual_disks/{id}/stats/
method GET
nickname getVirtualDiskStats
id Uuid of the VirtualDisk paramType path
required true
type string

required true
type array
required false
type integer
required false
type integer
required false
type integer

28
AOS | Vms | 378

VMS
Get the list of VMs
GET /vms/
Table 982: Details
path /vms/
method GET
nickname getVMs
type get.base.EntityCollection<get.dto.stats.VMDTO>
count Number of VMs to retrieve paramType query
required false
type integer
required false
type string
required false
type string
required false
type string
searchAttributeListSearch attribute list, only searches paramType query

on few attributes. For accurate
search, provide field names required false
type array
required false
type integer
AOS | Vms | 379

required false
type string
Table 984: get.base.EntityCollection<get.dto.stats.VMDTO>
entities array
Create a Virtual Machine

POST /vms/
Table 985: Details
path /vms/
method POST
nickname createVM
type create.dto.acropolis.ReturnValueDTO$TaskIdDTO
Create a Virtual Machine paramType body
required true
type create.dto.acropolis.VMCreate
Table 987: create.dto.acropolis.ReturnValueDTO$TaskIdDTO
taskUuid string
Get the list of alerts generated on any VM

GET /vms/alerts
AOS | Vms | 380

Table 988: Details
path /vms/alerts
method GET
nickname getVMAlerts
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
AOS | Vms | 381

entities array
Get the list of events generated on any VM

GET /vms/events
Table 991: Details
path /vms/events
method GET
nickname getVMEvents
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
AOS | Vms | 382

entities array
List Nutanix Guest Tools

GET /vms/guest_tools/
Table 994: Details
path /vms/guest_tools/
method GET
nickname listNutanixGuestTools
type Array of get.dto.ngt.NutanixGuestToolsDTO
applicationNames Comma separated list of application paramType query

names. If no application name given
all entities will be returned. required false
type array
vmNames Comma separated list of vm names. paramType query
required false
type array
Get the health check summary for VMs

GET /vms/health_check_summary
Table 996: Details
path /vms/health_check_summary
method GET
nickname getHealthCheckSummaryForVMs
AOS | Vms | 383

required false
type string
required false
type boolean
java.lang.Integer>>
entityType string
java.lang.Integer>
Get VM
GET /vms/{vmId}
Table 999: Details
path /vms/{vmId}
method GET
nickname getVM
type get.dto.stats.VMDTO
vmId Id of the VM paramType path
required true
AOS | Vms | 384

type string
required false
type string
Table 1001: get.dto.stats.VMDTO
acropolisVm boolean
clusterUuid string
containerIds array
containerUuids array
controlDomain boolean
controllerVm boolean
cpuReservedInHz integer int64
description string
displayable boolean
gpusInUse boolean
guestOperatingSystem string
hostId string
hostName string
hostUuid string
ipAddresses array
memoryReservedCapacityInBytes integer int64
nonNdfsDetails string
numNetworkAdapters integer int64
AOS | Vms | 385

numVCpus integer int32
nutanixGuestTools get.dto.ngt.NutanixGuestToolsDTO
nutanixVirtualDiskIds array
nutanixVirtualDiskUuids array
nutanixVirtualDisks array
onDiskDedup string
powerState string
protectionType string
runningOnNdfs boolean
java.lang.String>
java.lang.String>
uuid string
vdiskFilePaths array
vdiskNames array
virtualGpuUuids array
virtualNicIds array
virtualNicUuids array
vmFeatures java.util.Map<get.dto.uhura.VmConfigDTO
$VmFeature, java.lang.Boolean>
vmId string
vmName string
vmType string
Get the list of alerts generated on a specified VM

GET /vms/{vmId}/alerts
Table 1002: Details
path /vms/{vmId}/alerts
method GET
nickname getAlertsForVM
AOS | Vms | 386

vmId Id of a VM paramType path
required true
type string
required false
type integer
required false
type integer
required false
type integer
required false
type boolean

acknowledged
required false
type boolean
required false
type string
required false
type string
required false
type integer
entities array
AOS | Vms | 387

Get the list of events generated on a specified VM

GET /vms/{vmId}/events
Table 1005: Details
path /vms/{vmId}/events
method GET
nickname getEventsForVM
vmId Id of a VM paramType path
required true
type string
required false
type integer
required false
type integer
required false
type integer

acknowledged
required false
type boolean
required false
type integer
AOS | Vms | 388

entities array
Update fingerPrintOnWrite on all VDisks of a VM

POST /vms/{vmId}/fingerprint_on_write
Table 1008: Details
path /vms/{vmId}/fingerprint_on_write
method POST
nickname updatefingerPrintOnWriteInVM
type create.dto.stats.VMDTO
vmId Uuid of Virtual machine paramType path
required true
type string
Finger Print on Write paramType body
required true
Table 1010: create.dto.stats.VMDTO
acropolisVm boolean
clusterUuid string
containerIds array
AOS | Vms | 389

description string
displayable boolean
gpusInUse boolean
hostId string
hostName string
hostUuid string
ipAddresses array
nutanixGuestTools create.dto.ngt.NutanixGuestToolsDTO
onDiskDedup string
powerState string
java.lang.String>
java.lang.String>
uuid string
AOS | Vms | 390

virtualNicIds array
vmFeatures java.util.Map<create.dto.uhura.VmConfigDTO
vmId string
vmName string
vmType string
Get Nutanix Guest Tools

GET /vms/{vmId}/guest_tools/
Table 1011: Details
path /vms/{vmId}/guest_tools/
method GET
nickname getNutanixGuestTools
type get.dto.ngt.NutanixGuestToolsDTO
vmId Id of Virtual machine paramType path
required true
type string
Table 1013: get.dto.ngt.NutanixGuestToolsDTO
applications java.util.Map<java.lang.String,
java.lang.Boolean>
clusterVersion string
communicationLinkActive boolean
enabled boolean
AOS | Vms | 391

installedVersion string
toRemove boolean
toolsMounted boolean
vmId string
vmName string
vmUuid string
Update Nutanix Guest Tools

PATCH /vms/{vmId}/guest_tools/
Table 1014: Details
method PATCH
nickname patchNutanixGuestTools
type patch.dto.ngt.NutanixGuestToolsDTO
required true
type string
Details of Nutanix Guest Tools to paramType body

update
required true
Table 1016: patch.dto.ngt.NutanixGuestToolsDTO
java.lang.Boolean>
enabled boolean
vmUuid string
AOS | Vms | 392

Create Nutanix Guest Tools
POST /vms/{vmId}/guest_tools/
Table 1017: Details
method POST
nickname createNutanixGuestTools
type create.dto.ngt.NutanixGuestToolsDTO
required true
type string

create
required true
type create.dto.ngt.NutanixGuestTo
Table 1019: create.dto.ngt.NutanixGuestToolsDTO
java.lang.Boolean>
enabled boolean
vmUuid string

PUT /vms/{vmId}/guest_tools/
Table 1020: Details
method PUT
nickname updateNutanixGuestTools
AOS | Vms | 393

type update.dto.ngt.NutanixGuestToolsDTO
required true
type string

update
required true
type update.dto.ngt.NutanixGuestT
Table 1022: update.dto.ngt.NutanixGuestToolsDTO
java.lang.Boolean>
enabled boolean
vmUuid string
Mount Nutanix Guest Tools

POST /vms/{vmId}/guest_tools/mount
Table 1023: Details
path /vms/{vmId}/guest_tools/mount
method POST
nickname mountNutanixGuestTools
required true
type string
AOS | Vms | 394

value boolean
Unmount Nutanix Guest Tools

POST /vms/{vmId}/guest_tools/unmount
Table 1026: Details
path /vms/{vmId}/guest_tools/unmount
method POST
nickname unmountNutanixGuestTools
required true
type string
value boolean
Update OnDiskDedup on all VDisks of a VM

POST /vms/{vmId}/on_disk_dedup
Table 1029: Details
path /vms/{vmId}/on_disk_dedup
method POST
nickname updateonDiskDedup
type create.dto.stats.VMDTO
AOS | Vms | 395

vmId Uuid of Virtual machine paramType path
required true
type string
On Disk Dedup paramType body
required true
Table 1031: create.dto.stats.VMDTO
acropolisVm boolean
clusterUuid string
containerIds array
description string
displayable boolean
gpusInUse boolean
hostId string
hostName string
hostUuid string
ipAddresses array
AOS | Vms | 396

nutanixGuestTools create.dto.ngt.NutanixGuestToolsDTO
onDiskDedup string
powerState string
java.lang.String>
java.lang.String>
uuid string
virtualNicIds array
vmFeatures java.util.Map<create.dto.uhura.VmConfigDTO
vmId string
vmName string
vmType string
Get all snapshots of a VM

GET /vms/{vmId}/snapshots
Table 1032: Details
path /vms/{vmId}/snapshots
method GET
nickname getSnapshotsOfVM
AOS | Vms | 397

type Array of get.dto.dr.QueryVMSnapshotInfoDTO
required true
type string
Get snapshot info for given snapshot of a VM

GET /vms/{vmId}/snapshots/{snapId}
Table 1034: Details
path /vms/{vmId}/snapshots/{snapId}
method GET
nickname getSnapshotOfVM
type get.dto.dr.QueryVMSnapshotInfoDTO
required true
type string
snapId Id of the snapshot paramType path
required true
type integer
Table 1036: get.dto.dr.QueryVMSnapshotInfoDTO
diskLabels array
diskUuids array
flrCapabale boolean
locallyAvaiable boolean
AOS | Vms | 398

remoteSites array
snapshotCreateTime integer int64
snapshotExpiryTime integer int64
snapshotId integer int64
Get the stats for a specified VM

GET /vms/{vmId}/stats/
Table 1037: Details
path /vms/{vmId}/stats/
method GET
nickname getVMStats
required true
type string
required true
type array
required false
type integer
required false
type integer
required false
type integer
AOS | Vms | 399


GET /vms/{vmId}/vdisks
Table 1040: Details
path /vms/{vmId}/vdisks
method GET
nickname getVDisksInVm
required true
type string
Get the list of VirtualDisks

GET /vms/{vmId}/virtual_disks
Table 1042: Details
path /vms/{vmId}/virtual_disks
method GET
nickname getVirtualDisksInVm
type get.base.EntityCollection<get.dto.appliance.configuration.VirtualDiskDTO>
vmId Uuid of the VM paramType path
required true
AOS | Vms | 400

type string
required false
type string
required false
type string
Table 1044: get.base.EntityCollection<get.dto.appliance.configuration.VirtualDiskDTO>
entities array
Clone a Virtual Machine

POST /vms/{vmid}/clone
Table 1045: Details
path /vms/{vmid}/clone
method POST
nickname cloneVM
type create.dto.acropolis.ReturnValueDTO$TaskIdDTO
vmid Id of the Virtual Machine paramType path
required true
type string
Clone a Virtual Machine paramType body
required false
type create.dto.acropolis.VMCloneD
AOS | Vms | 401

Table 1047: create.dto.acropolis.ReturnValueDTO$TaskIdDTO
taskUuid string
29
AOS | Vstores | 403

VSTORES
Get the list of VStores
GET /vstores/
Table 1048: Details
path /vstores/
method GET
nickname getVStores
type Array of get.dto.vstore.VStoreDTO
ids VStore uuids paramType query
required false
type array
names VStore names paramType query
required false
type array
required false
type boolean
Get a VStore
GET /vstores/{id}
Table 1050: Details
path /vstores/{id}
method GET
nickname getVStoreByUuid
type get.dto.vstore.VStoreDTO
AOS | Vstores | 404

id Uuid of the VStore paramType path
required true
type string
Table 1052: get.dto.vstore.VStoreDTO
Uuid string
backedup boolean
containerId integer int64
id integer int64
isBackup boolean
name string
protectionDomain string
vmLevelConsistent boolean
Protect a VStore
POST /vstores/{id}/protect
Table 1053: Details
path /vstores/{id}/protect
method POST
nickname protectVStore
type create.dto.vstore.VStoreDTO
required true
AOS | Vstores | 405

type string
vmLevelConsistency
Create vm level consistent snapshots paramType query
for the vStore
required false
type boolean
Table 1055: create.dto.vstore.VStoreDTO
Uuid string
backedup boolean
id integer int64
isBackup boolean
name string
Unprotect a VStore
POST /vstores/{id}/unprotect
Table 1056: Details
path /vstores/{id}/unprotect
method POST
nickname unProtectVStore
type create.dto.vstore.VStoreDTO
required true
type string
AOS | Vstores | 406

Table 1058: create.dto.vstore.VStoreDTO
Uuid string
backedup boolean
id integer int64
isBackup boolean
name string
Protect a VStore
PUT /vstores/{id}/update_protection_mode
Table 1059: Details
path /vstores/{id}/update_protection_mode
method PUT
nickname updateProtection
type update.dto.vstore.VStoreDTO
required true
type string
vmLevelConsistency
Create vm level consistent snapshots paramType query
for the vStore
required true
type boolean
AOS | Vstores | 407

Table 1061: update.dto.vstore.VStoreDTO
Uuid string
backedup boolean
id integer int64
isBackup boolean
name string
Part
II
POWERSHELL CMDLETS REFERENCE
AOS | PowerShell Cmdlets Reference | 409

30
AOS | PowerShell Cmdlets Entities | 410

POWERSHELL CMDLETS ENTITIES
AcropolisVDisk
AdminUser
AdminUsers
Alert
AlertConfiguration
Alerts
AllCloudCredentials
AllFileServerShares
AuthConfig
AuthConfigDirectory
AuthType
BuiltInGroupsFileServerByUuid
CACertificate
CassandraBlockAwareFixer
Certificate
CertificatesViaMultiFile
CertificationInformation
ClientAuth
ClientAuthState
CloudCredential
CloudCvm
CloudCvmImage
CloudRemoteSite
Cluster
ClusterDataState
ClusterExternalDetail
ClusterExternalState
ClusterFromMulticluster
ClusterInfo
ClusterLicenseInfo
ClusterStat
ClusterToMulticluster
ConsistencyGroup
Container
ContainerAlert
ContainerEvent
ContainerStat
ContainerVDisk
CronSchedule
CurrentlyLoggedInUserInfo
CurrentlyLoggedInUsersInfo
DefaultCloudCredential
Disk
DiskAlert
DiskEvent
DiskForRemoval

DiskHealthCheckSummary
DiskStat
Dns
DnsEntries
Domain
EncryptedBackup
EncryptionConfiguration
Entity
EntityFromTag
EntityToTag
Event
Events
FSAdminUser
FSPrincipalType
FSQuotaPolicies
FSQuotaPolicy
FSStat
File
FileGroup
FileServerByUuid
FileServerPulse
FileServerShare
FileServerShares
FileServerUser
FileServerUsers
FileServers
FileServersUsage
FileShare
Fileserver
FileserverSnapshot
FileserverSnapshots
FsShareStat
GuestTool
HA
HardwareAlert
HardwareEvent
HealthCheck
Host
HostAlert
HostEvent
HostHealthCheckSummary
HostStat
HttpProxy
HttpProxyWhitelist
IcapServer
IcapServerStats
IcapServers
Image
InfectedFile
InfectedFiles

KeyManagementServer
KeyManagementServerType
LDAPConnection
License
LicenseAlert
LicenseAllowance
LicenseEvent
MaintenanceMode
MultiClusterAlert
MultiClusterEvent
MultiClusterStat
NameServer
NameServices
Network
NetworkAddressTable
NetworkIP
NfsDatastore
NfsSubnetWhiteList
NtpServer
OutOfBandSchedule
PasswordProtection
PrincipalType
ProtectionDomain
ProtectionDomainActive
ProtectionDomainAlert
ProtectionDomainConsistencyGroup
ProtectionDomainCronSchedule
ProtectionDomainEvent
ProtectionDomainForRemoval
ProtectionDomainHealthCheckSummary
ProtectionDomainInactive
ProtectionDomainPendingAction
ProtectionDomainPendingReplication
ProtectionDomainReplication
ProtectionDomainRetentionPolicy
ProtectionDomainSnapshot
ProtectionDomainStat
ProtectionDomainStatus
ProtectionDomainStretchCluster
ProtectionDomainStretchTimeout
ProtectionDomainVM
ProtectionStatus
PublicKey
QuotaPolicies
QuotaPolicy
RSyslogConfig
RSyslogServer
RSyslogServerModule
RSyslogState
RSyslogStatus

RackableUnit
RecentCertificateTestResults
RemoteSite
RemoteSiteAlert
RemoteSiteEvent
RemoteSiteForRemoval
RemoteSiteHealthCheckSummary
RemoteSitePendingReplication
RemoteSiteSnapshot
RemoteSiteStat
RemoteSupportSetting
ServiceCenter
Share
ShareInfectedFile
ShareInfectedFiles
ShareStat
ShareVirusScanPolicies
ShareVirusScanPolicy
Shares
SmtpServer
SmtpServerSecurityModeType
Snapshot
SnapshotForVDisk
SnapshotInfo
SnapshotPolicies
SnapshotPolicy
SnmpInfo
SnmpProfile
SnmpStatus
SnmpTransport
SnmpTrap
SnmpUser
SpotlightSearchResult
StorageAlert
StorageEvent
StoragePool
StoragePoolAlert
StoragePoolEvent
StoragePoolStat
StretchFailureHandling
Subnets
Switch
SwitchCollectorConfig
SwitchConfig
SwitchInterface
SwitchInterfaceStat
Tag
TaggedEntity
Task
UnprotectedVM

UserMapping
VDisk
VDiskAlert
VDiskEvent
VDiskSnapshot
VDiskStat
VM
VMAlert
VMDisk
VMEvent
VMHealthCheckSummary
VMMove
VMNIC
VMPowerOff
VMPowerOn
VMPowerState
VMSnapshot
VMStat
VMVDisk
VMVirtualDisk
VStore
VStoreProtection
VirtualDisk
VirtualDiskStat
VirtualMachine
VirusScanPolicy
VolumeDisk
VolumeGroup
VolumeGroups

31
AOS | AcropolisVDisk | 416

ACROPOLISVDISK
Operations
• Get a list of vdisks in the cluster: Get-NTNXAcropolisVDisk
Get a list of vdisks in the cluster

> Get-NTNXAcropolisVDisk [[-Servers] <string[]>] -Path <Object>
[-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXAcropolisVDisk [-Path <Object>] [-ExpandedOutput] [-GridView]

[<CommonParameters>]
> Get-NTNXAcropolisVDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Path
Path of ndfs file
AOS | AcropolisVDisk | 417

32
AOS | AdminUser | 418

ADMINUSER
Operations
• Delete Admin User: Remove-NTNXAdminUser
Delete Adminn User

> Remove-NTNXAdminUser [[-Servers] <string[]>] -Uuid <Object> -AdminUserUuid
<Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXAdminUser [-Uuid <Object>] [-AdminUserUuid <Object>] [-Template]

> Remove-NTNXAdminUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that admin user is associated with
AdminUserUuid
uuid of the admin user
Optional arguments
Template
This flag will enable you to create a template object of the input type which can
then be pipelinedto the cmdlet. You can provide the usual parameters alongwith
this flag so that an object with those parameters set will be created.
AOS | AdminUser | 419

33
AOS | AdminUsers | 420

ADMINUSERS
Operations
• Add new admin user: Add-NTNXAdminUsers

• Get the list of admin users: Get-NTNXAdminUsers
• Update Admin User: Update-NTNXAdminUsers
Update Admin User

> Update-NTNXAdminUsers [[-Servers] <string[]>] -Uuid <Object> -AdminUser_Uuid
<string> [-User <string>] [-Role <UpdateAdminUsers+FileServerAdminRole_Enum>]
[-FileServerUuid <string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXAdminUsers [-Uuid <Object>] [-User <string>] [-AdminUser_Uuid

<string>] [-Role <UpdateAdminUsers+FileServerAdminRole_Enum>] [-FileServerUuid
<string>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXAdminUsers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid
Admin user uuid.
Optional arguments
User
AD user or group name as 'name' or 'NETBIOS\name' format.
Role
Role of the given user or group (one of AdMIN or BACKUP_OPERATOR).
FileServerUuid
Template
Add new admin user

> Add-NTNXAdminUsers [[-Servers] <string[]>] -Uuid <Object> -User <string>
-Role <AddAdminUsers+FileServerAdminRole_Enum> [-FileServerUuid <string>]
> Add-NTNXAdminUsers [-Uuid <Object>] [-User <string>] [-Role

<AddAdminUsers+FileServerAdminRole_Enum>] [-FileServerUuid <string>]
[-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXAdminUsers [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]
AOS | AdminUsers | 421

[-GridView] [<CommonParameters>]
Required arguments
Uuid
User
Role
Role of the given user or group (one of AdMIN or BACKUP_OPERATOR).
Optional arguments
FileServerUuid
Template
Get the list of admin users associated with a file server

> Get-NTNXAdminUsers [[-Servers] <string[]>] -Uuid <Object> [-ExpandedOutput]
> Get-NTNXAdminUsers [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXAdminUsers [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
uuid of the file server
34
AOS | Alert | 423

ALERT
Operations
• Acknowledge Alert: Acknowledge-NTNXAlert

• Get the list of Alerts: Get-NTNXAlert
• Resolve Alert: Resolve-NTNXAlert
Get the list of Alerts generated in the cluster

> Get-NTNXAlert [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
[-EndTimeInUsecs <long>] [-Count <int>] [-Resolved] [-AutoResolved]
[-Acknowledged] [-Severity <Object>] [-AlertTypeUuid <Object>] [-Page <int>]
[-EntityType <Object>] [-EntityIds <Object>] [-Categories <Object>] [-AlertIds
<Object>] [-Impacts <Object>] [-GetCauses] [-ExpandedOutput] [-GridView]
> Get-NTNXAlert [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-Count

<int>] [-Resolved] [-AutoResolved] [-Acknowledged] [-Severity <Object>]
[-AlertTypeUuid <Object>] [-Page <int>] [-EntityType <Object>] [-EntityIds
<Object>] [-Categories <Object>] [-AlertIds <Object>] [-Impacts <Object>]
[-GetCauses] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
StartTimeInUsecs
Start time in microseconds
EndTimeInUsecs
End time in microseconds
Count
Maximum number of alerts
Resolved
Alerts which have been resolved
AutoResolved
Alerts which have been auto resolved
Acknowledged
Alerts which have been acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
AOS | Alert | 424

Page
Page number
EntityType
Entity type
EntityIds
Entity ids
Categories
Categories
AlertIds
Alert ids
Impacts
Impacts
GetCauses
Get causes
Acknowledge Alert with the specified Id

> Acknowledge-NTNXAlert [[-Servers] <string[]>] -Id <Object> [-ExpandedOutput]
> Acknowledge-NTNXAlert [-Id <Object>] [-Template] [-ExpandedOutput]

> Acknowledge-NTNXAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Alert Id
Optional arguments
Template
Resolve Alert with the specified Id

> Resolve-NTNXAlert [[-Servers] <string[]>] -Id <Object> [-ExpandedOutput]
> Resolve-NTNXAlert [-Id <Object>] [-Template] [-ExpandedOutput] [-GridView]

> Resolve-NTNXAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Alert Id
AOS | Alert | 425

Optional arguments
Template
35
AOS | AlertConfiguration | 427

ALERTCONFIGURATION
Operations
• Get the Alert configuration: Get-NTNXAlertConfiguration

• Modify the Alert configuration: Set-NTNXAlertConfiguration
Modify the configuration that is used to send Alert emails

> Set-NTNXAlertConfiguration [[-Servers] <string[]>] [-Enable <bool>]
[-EnableEmailDigest <bool>] [-EnableDefaultNutanixEmail <bool>]
[-DefaultNutanixEmail <string>] [-EmailContactList <string[]>] [-SmtpServer
<SmtpServerDTO>] [-TunnelDetails <RemoteTunnelDetailsDTO>] [-EmailConfigRules
<EmailConfigurationRule[]>] [-EmailTemplate <EmailTemplate>]
[-SkipEmptyAlertEmailDigest <bool>] [-Operation <string>] [-GenericDTO
<string>] [-ClusterUuid <string>] [-ExpandedOutput] [-GridView]
> Set-NTNXAlertConfiguration [-Enable <bool>] [-EnableEmailDigest <bool>]

[-EnableDefaultNutanixEmail <bool>] [-DefaultNutanixEmail <string>]
[-EmailContactList <string[]>] [-SmtpServer <SmtpServerDTO>] [-TunnelDetails
<RemoteTunnelDetailsDTO>] [-EmailConfigRules <EmailConfigurationRule[]>]
[-EmailTemplate <EmailTemplate>] [-SkipEmptyAlertEmailDigest <bool>]
[-Operation <string>] [-GenericDTO <string>] [-ClusterUuid <string>]
> Set-NTNXAlertConfiguration [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Enable
Whether Alert emails should be enabled.
EnableEmailDigest
Whether Alert email digest should be enabled.
EnableDefaultNutanixEmail
Whether Alert emails should be enabled.
DefaultNutanixEmail
Default Nutanix email to which Alert emails would be sent
EmailContactList
List of email contacts.
SmtpServer
SMTP Server used to send Alert Emails.
TunnelDetails
Status of Remote Tunnel that is used to send Alert Emails.

EmailConfigRules
Rules for Email Configuration.
EmailTemplate
Email Template.
SkipEmptyAlertEmailDigest
Send alert email digest only if there are one or more alerts.
Operation
GenericDTO
ClusterUuid
Template
Get the configuration that is used to send Alert emails

> Get-NTNXAlertConfiguration [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXAlertConfiguration [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None

36
AOS | Alerts | 430

ALERTS
Operations
• Acknowledge Alerts: Acknowledge-NTNXAlerts

• Resolve Alerts: Resolve-NTNXAlerts
Acknowledge alerts using a filter criteria

> Acknowledge-NTNXAlerts [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
[-EndTimeInUsecs <long>] [-Severity <Object>] [-Categories <Object>]
[-EntityType <Object>] [-EntityTypeIds <Object>] [-Count <int>]
> Acknowledge-NTNXAlerts [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Severity <Object>] [-Categories <Object>] [-EntityType <Object>]
[-EntityTypeIds <Object>] [-Count <int>] [-Template] [-ExpandedOutput]
> Acknowledge-NTNXAlerts [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Severity
Severity
Categories
Categories of alerts
EntityType
Entity Type
EntityTypeIds
Entity Type Ids
Count
Template
Resolve alerts using a filter criteria

> Resolve-NTNXAlerts [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
AOS | Alerts | 431

[-EndTimeInUsecs <long>] [-Severity <Object>] [-Categories <Object>]
[-EntityType <Object>] [-EntityTypeIds <Object>] [-Count <int>]
> Resolve-NTNXAlerts [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Severity <Object>] [-Categories <Object>] [-EntityType <Object>]
[-EntityTypeIds <Object>] [-Count <int>] [-Template] [-ExpandedOutput]
> Resolve-NTNXAlerts [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Severity
Severity
Categories
Categories of alerts
EntityType
Entity Type
EntityTypeIds
Entity Type Ids
Count
Template
37
AOS | AllCloudCredentials | 433

ALLCLOUDCREDENTIALS
Operations
• Remove all cloud credentials: Remove-NTNXAllCloudCredentials
Remove all cloud credentials for accessing cloud sites

> Remove-NTNXAllCloudCredentials [[-Servers] <string[]>] -CloudType <Object>
> Remove-NTNXAllCloudCredentials [-CloudType <Object>] [-Template]

> Remove-NTNXAllCloudCredentials [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
Optional arguments
Template
38
AOS | AllFileServerShares | 435

ALLFILESERVERSHARES
Operations
• Get the list of Shares associated with all file servers: Get-NTNXAllFileServerShares
Get the list of Shares configured in the cluster

> Get-NTNXAllFileServerShares [[-Servers] <string[]>] [-Count <int>]
[-FilterCriteria <Object>] [-SearchString <Object>] [-SearchAttributeList
<Object>] [-Projection <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXAllFileServerShares [-Count <int>] [-FilterCriteria <Object>]

[-SearchString <Object>] [-SearchAttributeList <Object>] [-Projection
<Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXAllFileServerShares [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Count
Number of shares to retrieve
FilterCriteria
Filter criteria
SearchString
Search string
SearchAttributeList
Search attribute list
Projection
Projections on the attributes
39
AOS | AuthConfig | 437

AUTHCONFIG
Operations
• Get Auth configuration: Get-NTNXAuthConfig

• Delete Auth config: Remove-NTNXAuthConfig
• Modify Auth configuration: Update-NTNXAuthConfig
Get the complete Auth configuration including directories configured in the cluster
> Get-NTNXAuthConfig [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXAuthConfig [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Modify the Auth configuration excluding directories configured in the cluster

> Update-NTNXAuthConfig [[-Servers] <string[]>] -AuthTypeList
<UpdateAuthConfig+AuthenticationType_Enum[]> [-DirectoryList
<DirectoryConfigDTO[]>] [-Operation <string>] [-GenericDTO <string>]
[-ClusterUuid <string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXAuthConfig [-AuthTypeList

<UpdateAuthConfig+AuthenticationType_Enum[]>] [-DirectoryList
<DirectoryConfigDTO[]>] [-Operation <string>] [-GenericDTO <string>]
[-ClusterUuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Update-NTNXAuthConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
AuthTypeList
Authentication Types
Optional arguments
DirectoryList
Id of an alert type.
Operation
GenericDTO
ClusterUuid
Template

Delete Auth configuration from the cluster
This will also delete all the directories configured in the cluster.
> Remove-NTNXAuthConfig [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Remove-NTNXAuthConfig [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXAuthConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Template

40
AOS | AuthConfigDirectory | 440

AUTHCONFIGDIRECTORY
Operations
• Add Directory: Add-NTNXAuthConfigDirectory

• Get the list of Directories: Get-NTNXAuthConfigDirectory
• Delete Directory: Remove-NTNXAuthConfigDirectory
• Modify Directory: Set-NTNXAuthConfigDirectory
Modify the specified Directory config

> Set-NTNXAuthConfigDirectory [[-Servers] <string[]>] -Name <string>
[-DirectoryType <SetAuthConfigDirectory+DirType_Enum>] [-ConnectionType
<SetAuthConfigDirectory+ConnType_Enum>] [-DirectoryUrl <string>] [-Domain
<string>] [-GroupSearchType <SetAuthConfigDirectory+GroupSearchType_Enum>]
[-OpenLdapConfig <OpenLdapConfigDTO>] [-ServiceAccountUsername <string>]
[-ServiceAccountPassword <string>] [-Operation <string>] [-GenericDTO
> Set-NTNXAuthConfigDirectory [-DirectoryType

<SetAuthConfigDirectory+DirType_Enum>] [-ConnectionType
<SetAuthConfigDirectory+ConnType_Enum>] [-DirectoryUrl <string>] [-Domain
<string>] [-Name <string>] [-GroupSearchType
<SetAuthConfigDirectory+GroupSearchType_Enum>] [-OpenLdapConfig
<OpenLdapConfigDTO>] [-ServiceAccountUsername <string>]
[-ServiceAccountPassword <string>] [-Operation <string>] [-GenericDTO
<string>] [-ClusterUuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXAuthConfigDirectory [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of directory.
Optional arguments
DirectoryType
Directory type.
ConnectionType
Connection type.
DirectoryUrl
Directory's ldap url.
Domain
Domain name.
GroupSearchType
Group search type.

OpenLdapConfig
Open ldap config.
ServiceAccountUsername
The username to use with the service account.
ServiceAccountPassword
The password to use for the service account.
Operation
GenericDTO
ClusterUuid
Template
Get the list of Directories configured in the cluster

> Get-NTNXAuthConfigDirectory [[-Servers] <string[]>] [-Name <Object>]
> Get-NTNXAuthConfigDirectory [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXAuthConfigDirectory [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the Directory
Delete Directory config with the specified name

> Remove-NTNXAuthConfigDirectory [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXAuthConfigDirectory [-Name <Object>] [-Template]

> Remove-NTNXAuthConfigDirectory [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the Directory
Optional arguments
Template

Add Directory config to the cluster
> Add-NTNXAuthConfigDirectory [[-Servers] <string[]>] -DirectoryType
<AddAuthConfigDirectory+DirType_Enum> -ConnectionType
<AddAuthConfigDirectory+ConnType_Enum> -DirectoryUrl <string> -Domain <string>
-Name <string> [-GroupSearchType
<AddAuthConfigDirectory+GroupSearchType_Enum>] [-OpenLdapConfig
[-ServiceAccountPassword <string>] [-ExpandedOutput] [-GridView]
> Add-NTNXAuthConfigDirectory [-DirectoryType

<AddAuthConfigDirectory+DirType_Enum>] [-ConnectionType
<AddAuthConfigDirectory+ConnType_Enum>] [-DirectoryUrl <string>] [-Domain
<string>] [-Name <string>] [-GroupSearchType
<AddAuthConfigDirectory+GroupSearchType_Enum>] [-OpenLdapConfig
[-ServiceAccountPassword <string>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXAuthConfigDirectory [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
DirectoryType
Directory type.
ConnectionType
Connection type.
DirectoryUrl
Directory's ldap url.
Domain
Domain name.
Name
Name of directory.
Optional arguments
GroupSearchType
Group search type.
OpenLdapConfig
Open ldap config.
ServiceAccountUsername
The username to use with the service account.
ServiceAccountPassword
The password to use for the service account.
Template

41
AOS | AuthType | 444

AUTHTYPE
Operations
• Add Auth types: Add-NTNXAuthType

• Get Auth types: Get-NTNXAuthType
• Remove Auth types: Remove-NTNXAuthType
• Update Auth types: Set-NTNXAuthType
Add Auth types to the existing Auth types

> Add-NTNXAuthType [[-Servers] <string[]>] -InputList
<AddAuthType+AuthenticationType_Enum[]> [-ExpandedOutput] [-GridView]
> Add-NTNXAuthType [-InputList <AddAuthType+AuthenticationType_Enum[]>]

> Add-NTNXAuthType [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
InputList
Enter comma seperated values.
Optional arguments
Template
Remove Auth types from the existing Auth types

> Remove-NTNXAuthType [[-Servers] <string[]>] -InputList
<RemoveAuthType+AuthenticationType_Enum[]> [-ExpandedOutput] [-GridView]
> Remove-NTNXAuthType [-InputList <RemoveAuthType+AuthenticationType_Enum[]>]

> Remove-NTNXAuthType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
InputList
AOS | AuthType | 445

Optional arguments
Template
Update Auth types configured in the Auth configuration

> Set-NTNXAuthType [[-Servers] <string[]>] -InputList
<SetAuthType+AuthenticationType_Enum[]> [-ExpandedOutput] [-GridView]
> Set-NTNXAuthType [-InputList <SetAuthType+AuthenticationType_Enum[]>]

> Set-NTNXAuthType [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
InputList
Optional arguments
Template
Get Auth types configured in Auth configuration

> Get-NTNXAuthType [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXAuthType [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
42
AOS | BuiltInGroupsFileServerByUuid | 447

BUILTINGROUPSFILESERVERBYUUID
Operations
• Get built in groups per file server: Get-NTNXBuiltInGroupsFileServerByUuid
Get built in groups per file server

> Get-NTNXBuiltInGroupsFileServerByUuid [[-Servers] <string[]>] -Uuid <Object>
[-Projection <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXBuiltInGroupsFileServerByUuid [-Uuid <Object>] [-Projection

> Get-NTNXBuiltInGroupsFileServerByUuid [[-NutanixClusters]

<NutanixCluster[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
Required arguments
Uuid
uuid of the FileServer
Optional arguments
Projection
43
AOS | CACertificate | 449

CACERTIFICATE
Operations
• Get all CA certificates: Get-NTNXCACertificate

• Delete Certificate Authority: Remove-NTNXCACertificate
Get all CA Certificates from cluster

> Get-NTNXCACertificate [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXCACertificate [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Delete a CA certificate from cluster

> Remove-NTNXCACertificate [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXCACertificate [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXCACertificate [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Certificate Authority name
Optional arguments
Template
44
AOS | CassandraBlockAwareFixer | 451

CASSANDRABLOCKAWAREFIXER
Operations
• Start block aware fixer: Start-NTNXCassandraBlockAwareFixer

• Stop block aware fixer: Stop-NTNXCassandraBlockAwareFixer
> Stop-NTNXCassandraBlockAwareFixer [[-Servers] <string[]>] [-ExpandedOutput]

> Stop-NTNXCassandraBlockAwareFixer [-Template] [-ExpandedOutput] [-GridView]

> Stop-NTNXCassandraBlockAwareFixer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Template
> Start-NTNXCassandraBlockAwareFixer [[-Servers] <string[]>] [-ExpandedOutput]

> Start-NTNXCassandraBlockAwareFixer [-Template] [-ExpandedOutput] [-GridView]

> Start-NTNXCassandraBlockAwareFixer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Template
45
AOS | Certificate | 453

CERTIFICATE
Operations
• Delete certificate: Remove-NTNXCertificate
Delete a svm certificate from cluster

> Remove-NTNXCertificate [[-Servers] <string[]>] -NodeId <Object> -ServerName
> Remove-NTNXCertificate [-NodeId <Object>] [-ServerName <Object>] [-Template]

> Remove-NTNXCertificate [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
NodeId
Id of the node on which certificate is installed
ServerName
Key management Server name for which certificate is installed
Optional arguments
Template
46
AOS | CertificatesViaMultiFile | 455

CERTIFICATESVIAMULTIFILE
Operations
• Add certificates: Add-NTNXCertificatesViaMultiFile
Add certificates to the cluster via multi-file upload

> Add-NTNXCertificatesViaMultiFile [[-Servers] <string[]>] [-CertificateMap
<Object>] [-KeyManagementServerName <string>] [-ExpandedOutput] [-GridView]
> Add-NTNXCertificatesViaMultiFile [-CertificateMap <Object>]

[-KeyManagementServerName <string>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXCertificatesViaMultiFile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
CertificateMap
KeyManagementServerName
Template
47
AOS | CertificationInformation | 457

CERTIFICATIONINFORMATION
Operations
• Get Certification information: Get-NTNXCertificationInformation

• Update the Certification information: Set-NTNXCertificationInformation
Get Certification Signing information

> Get-NTNXCertificationInformation [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXCertificationInformation [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Update the Certification information

> Set-NTNXCertificationInformation [[-Servers] <string[]>] [-CountryCode
<string>] [-State <string>] [-City <string>] [-OrganizationName <string>]
[-EmailAddress <string>] [-OrganizationalUnitList <string[]>] [-DomainName
<string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXCertificationInformation [-CountryCode <string>] [-State <string>]

[-City <string>] [-OrganizationName <string>] [-EmailAddress <string>]
[-OrganizationalUnitList <string[]>] [-DomainName <string>] [-Template]
> Set-NTNXCertificationInformation [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
CountryCode
State
City
OrganizationName
EmailAddress
OrganizationalUnitList
DomainName

Template

48
AOS | ClientAuth | 460

CLIENTAUTH
Operations
• Update client authentication: Set-NTNXClientAuth
Update client authentication on the cluster

> Set-NTNXClientAuth [[-Servers] <string[]>] [-CaChainInfo <CaChainDTO>]
[-AutoLoginInfo <AutoLoginInfoDTO>] [-CertRevocationInfo
<CertRevocationInfoDTO>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXClientAuth [-CaChainInfo <CaChainDTO>] [-AutoLoginInfo

<AutoLoginInfoDTO>] [-CertRevocationInfo <CertRevocationInfoDTO>] [-Template]
> Set-NTNXClientAuth [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
CaChainInfo
The CA chain information.
AutoLoginInfo
Auto Login Information.
CertRevocationInfo
Certificate Revocation information.
Template
AOS | ClientAuth | 461

49
AOS | ClientAuthState | 462

CLIENTAUTHSTATE
Operations
• Get client authentication status: Get-NTNXClientAuthState

• Enable/disable client authentication: Set-NTNXClientAuthState
Get the client authentication status configured on the cluster

> Get-NTNXClientAuthState [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXClientAuthState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Enable/disable client authentication on the cluster

> Set-NTNXClientAuthState [[-Servers] <string[]>] -Arg0 <bool>
> Set-NTNXClientAuthState [-Arg0 <bool>] [-Template] [-ExpandedOutput]

> Set-NTNXClientAuthState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Arg0
Optional arguments
Template
AOS | ClientAuthState | 463

50
AOS | CloudCredential | 464

CLOUDCREDENTIAL
Operations
• Add a cloud credential: Add-NTNXCloudCredential

• Get cloud credentials: Get-NTNXCloudCredential
• Remove a cloud credential: Remove-NTNXCloudCredential
• Update a cloud credential: Update-NTNXCloudCredential
Get cloud credentials for accessing cloud sites

> Get-NTNXCloudCredential [[-Servers] <string[]>] -CloudType <Object> [-Count
<int>] [-FilterCriteria <Object>] [-SortCriteria <Object>] [-ExpandedOutput]
> Get-NTNXCloudCredential [-CloudType <Object>] [-Count <int>]

[-FilterCriteria <Object>] [-SortCriteria <Object>] [-ExpandedOutput]
> Get-NTNXCloudCredential [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
Optional arguments
Count
Maximum number of cloud credentials to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
Remove a cloud credential for accessing cloud sites

> Remove-NTNXCloudCredential [[-Servers] <string[]>] -CloudType <Object> -Name
> Remove-NTNXCloudCredential [-CloudType <Object>] [-Name <Object>]

> Remove-NTNXCloudCredential [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type

Name
Name of the credential
Optional arguments
Template
Add a cloud credential for accessing cloud sites

> Add-NTNXCloudCredential [[-Servers] <string[]>] -CloudType <Object> [-Name
<string>] [-AwsCredential <AwsCredentialDTO>] [-AzureCredential
<AzureCredentialDTO>] [-UseAsDefault <bool>] [-CredentialID <long>]
> Add-NTNXCloudCredential [-CloudType <Object>] [-Name <string>]

[-AwsCredential <AwsCredentialDTO>] [-AzureCredential <AzureCredentialDTO>]
[-UseAsDefault <bool>] [-CredentialID <long>] [-Template] [-ExpandedOutput]
> Add-NTNXCloudCredential [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
Optional arguments
Name
Name of the Cloud credentials.
AwsCredential
AWS Credentials.
AzureCredential
Azure Credentials.
UseAsDefault
CredentialID
Template
Update a cloud credential for accessing cloud sites

> Update-NTNXCloudCredential [[-Servers] <string[]>] -CloudType <Object> -Name
<Object> [-CloudCredentials_Name <string>] [-AwsCredential <AwsCredentialDTO>]
[-AzureCredential <AzureCredentialDTO>] [-UseAsDefault <bool>] [-CredentialID
<long>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXCloudCredential [-CloudType <Object>] [-Name <Object>]

[-CloudCredentials_Name <string>] [-AwsCredential <AwsCredentialDTO>]
[-AzureCredential <AzureCredentialDTO>] [-UseAsDefault <bool>] [-CredentialID
<long>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]

> Update-NTNXCloudCredential [[-NutanixClusters] <NutanixCluster[]>]
Required arguments
CloudType
Cloud type
Name
Optional arguments
Name
Name of the Cloud credentials.
AwsCredential
AWS Credentials.
AzureCredential
Azure Credentials.
UseAsDefault
CredentialID
Template

51
AOS | CloudCvm | 468

CLOUDCVM
Operations
• Get a list of CVMs: Get-NTNXCloudCvm
Get a list of CVMs that installed

> Get-NTNXCloudCvm [[-Servers] <string[]>] -CloudType <Object> -Region
<Object> [-CredentialName <Object>] [-Count <int>] [-FilterCriteria <Object>]
[-SortCriteria <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXCloudCvm [-CloudType <Object>] [-Region <Object>] [-CredentialName

<Object>] [-Count <int>] [-FilterCriteria <Object>] [-SortCriteria <Object>]
> Get-NTNXCloudCvm [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
CloudType
Cloud type
Region
Region
Optional arguments
CredentialName
Count
Maximum number of cloud cvms to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
AOS | CloudCvm | 469

52
AOS | CloudCvmImage | 470

CLOUDCVMIMAGE
Operations
• Get a list of CVM images: Get-NTNXCloudCvmImage
Get a list of CVM images that can be installed

> Get-NTNXCloudCvmImage [[-Servers] <string[]>] -CloudType <Object>
[-CredentialName <Object>] [-Region <Object>] [-Count <int>] [-FilterCriteria
<Object>] [-SortCriteria <Object>] [-ListLocalOnly] [-ExpandedOutput]
> Get-NTNXCloudCvmImage [-CloudType <Object>] [-CredentialName <Object>]

[-Region <Object>] [-Count <int>] [-FilterCriteria <Object>] [-SortCriteria
<Object>] [-ListLocalOnly] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXCloudCvmImage [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
Optional arguments
CredentialName
Region
Region of the cvm image
Count
Maximum number of cloud images to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
ListLocalOnly
Is list local, to be specified only for Azure cloud type
AOS | CloudCvmImage | 471

53
AOS | CloudRemoteSite | 472

CLOUDREMOTESITE
Operations
• Deploy a cloud CVM and create a remote site: Deploy-NTNXCloudRemoteSite
Deploy a cloud CVM and create a remote site

> Deploy-NTNXCloudRemoteSite [[-Servers] <string[]>] -CloudType <Object>
-LocalRemoteSiteName <string> -Region <string> -LocalContainerNames <string[]>
-ConnectivityType <DeployCloudRemoteSite+ConnectivityType_Enum>
[-SkipInstanceTypeValidation <bool>] [-ExpandedOutput] [-GridView]
> Deploy-NTNXCloudRemoteSite [-CloudType <Object>] [-LocalRemoteSiteName

<string>] [-Region <string>] [-LocalContainerNames <string[]>]
[-ConnectivityType <DeployCloudRemoteSite+ConnectivityType_Enum>]
[-SkipInstanceTypeValidation <bool>] [-Template] [-ExpandedOutput] [-GridView]
> Deploy-NTNXCloudRemoteSite [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
LocalRemoteSiteName
Region
LocalContainerNames
LocalStorageContainerNames
ConnectivityType
Optional arguments
SkipInstanceTypeValidation
Flag to skip instance type validation
Template
AOS | CloudRemoteSite | 473

54
AOS | Cluster | 474

CLUSTER
Operations
• Get the list of clusters: Get-NTNXCluster

• Modify Cluster params: Set-NTNXCluster
Get the list of clusters

> Get-NTNXCluster [[-Servers] <string[]>] [-Id <Object>] [-Projection
[-SearchString <Object>] [-SearchAttributeList <Object>] [-Page <int>]
> Get-NTNXCluster [-Id <Object>] [-Projection <Object>] [-Count <int>]

[-FilterCriteria <Object>] [-SortCriteria <Object>] [-SearchString <Object>]
[-SearchAttributeList <Object>] [-Page <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXCluster [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of the cluster
Optional arguments
Projection
Count
Number of Clusters to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
Modify the params of the cluster

> Set-NTNXCluster [[-Servers] <string[]>] [-Id <string>] [-Uuid <string>]
[-ClusterIncarnationId <long>] [-Name <string>] [-ClusterExternalIPAddress
<string>] [-ClusterExternalDataServicesIPAddress <string>] [-IsNSEnabled
<bool>] [-SegmentedIscsiDataServicesIPAddress <string>]
[-ClusterMasqueradingIPAddress <string>] [-ClusterMasqueradingPort <int>]
AOS | Cluster | 475

[-Timezone <string>] [-SupportVerbosityType
<SetCluster+SupportInformationVerbosityType_Enum>] [-OperationMode
<SetCluster+OperationMode_Enum>] [-Encrypted <bool>] [-IsLTS <bool>]
[-IsRegisteredToPC <bool>] [-NumNodes <long>] [-BlockSerials <string[]>]
[-Version <string>] [-FullVersion <string>] [-TargetVersion <string>]
[-ExternalSubnet <string>] [-InternalSubnet <string>] [-NccVersion <string>]
[-EnableLockDown <bool>] [-EnablePasswordRemoteLoginToCluster <bool>]
[-FingerprintContentCachePercentage <int>] [-EnableShadowClones <bool>]
[-GlobalNfsWhiteList <string[]>] [-NameServers <string[]>] [-NtpServers
<string[]>] [-ServiceCenters <ServiceCenterDTO[]>] [-HttpProxies
<HttpProxyDTO[]>] [-RackableUnits <RackableUnitDTO[]>] [-PublicKeys
<PublicKeyDTO[]>] [-SmtpServer <SmtpServerDTO>] [-HypervisorTypes
<SetCluster+HypervisorType_Enum[]>] [-ClusterRedundancyState
<ClusterRedundancyStateDTO>] [-Multicluster <bool>] [-Cloudcluster <bool>]
[-HasSelfEncryptingDrive <bool>] [-IsUpgradeInProgress <bool>]
[-SecurityComplianceConfig <SecurityComplianceConfigDTO>]
[-HypervisorSecurityComplianceConfig <HypervisorSecurityComplianceConfigDTO>]
[-HypervisorLldpConfig <HypervisorLldpConfigDTO>] [-ClusterArch <string>]
[-IsSspEnabled <bool>] [-IscsiConfig <IscsiConfig>] [-ClusterDataState
<ClusterDataStateDTO>] [-Stats <Object>] [-UsageStats <Object>]
[-HealthSummary <HealthSummaryDTO>] [-AlertSummary <AlertSummaryDTO>]
[-DisableDegradedNodeMonitoring <bool>] [-CommonCriteriaMode <bool>]
[-EnableOnDiskDedup <bool>] [-FaultToleranceDomainType
<SetCluster+FaultToleranceDomainType_Enum>] [-Operation <string>] [-GenericDTO
> Set-NTNXCluster [-Id <string>] [-Uuid <string>] [-ClusterIncarnationId

<long>] [-Name <string>] [-ClusterExternalIPAddress <string>]
[-ClusterExternalDataServicesIPAddress <string>] [-IsNSEnabled <bool>]
[-SegmentedIscsiDataServicesIPAddress <string>] [-ClusterMasqueradingIPAddress
<string>] [-ClusterMasqueradingPort <int>] [-Timezone <string>]
[-SupportVerbosityType <SetCluster+SupportInformationVerbosityType_Enum>]
[-OperationMode <SetCluster+OperationMode_Enum>] [-Encrypted <bool>] [-IsLTS
<bool>] [-IsRegisteredToPC <bool>] [-NumNodes <long>] [-BlockSerials
<string[]>] [-Version <string>] [-FullVersion <string>] [-TargetVersion
<string>] [-ExternalSubnet <string>] [-InternalSubnet <string>] [-NccVersion
<string>] [-EnableLockDown <bool>] [-EnablePasswordRemoteLoginToCluster
<bool>] [-FingerprintContentCachePercentage <int>] [-EnableShadowClones
<bool>] [-GlobalNfsWhiteList <string[]>] [-NameServers <string[]>]
[-NtpServers <string[]>] [-ServiceCenters <ServiceCenterDTO[]>] [-HttpProxies
<HttpProxyDTO[]>] [-RackableUnits <RackableUnitDTO[]>] [-PublicKeys
<PublicKeyDTO[]>] [-SmtpServer <SmtpServerDTO>] [-HypervisorTypes
<SetCluster+HypervisorType_Enum[]>] [-ClusterRedundancyState
<ClusterRedundancyStateDTO>] [-Multicluster <bool>] [-Cloudcluster <bool>]
[-HasSelfEncryptingDrive <bool>] [-IsUpgradeInProgress <bool>]
[-SecurityComplianceConfig <SecurityComplianceConfigDTO>]
[-HypervisorSecurityComplianceConfig <HypervisorSecurityComplianceConfigDTO>]
[-HypervisorLldpConfig <HypervisorLldpConfigDTO>] [-ClusterArch <string>]
[-IsSspEnabled <bool>] [-IscsiConfig <IscsiConfig>] [-ClusterDataState
<ClusterDataStateDTO>] [-Stats <Object>] [-UsageStats <Object>]
[-DisableDegradedNodeMonitoring <bool>] [-CommonCriteriaMode <bool>]
[-EnableOnDiskDedup <bool>] [-FaultToleranceDomainType
<SetCluster+FaultToleranceDomainType_Enum>] [-Operation <string>] [-GenericDTO
<string>] [-ClusterUuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXCluster [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

AOS | Cluster | 476

Required arguments
None
Optional arguments
Id
Uuid
ClusterIncarnationId
Name
ClusterExternalIPAddress
ClusterExternalDataServicesIPAddress
IsNSEnabled
SegmentedIscsiDataServicesIPAddress
ClusterMasqueradingIPAddress
ClusterMasqueradingPort
Timezone
SupportVerbosityType
OperationMode
Encrypted
IsLTS
IsRegisteredToPC
NumNodes
BlockSerials
Version
FullVersion
TargetVersion
ExternalSubnet
InternalSubnet
NccVersion
EnableLockDown
EnablePasswordRemoteLoginToCluster
FingerprintContentCachePercentage
EnableShadowClones
GlobalNfsWhiteList
NameServers
NtpServers
AOS | Cluster | 477

ServiceCenters
HttpProxies
RackableUnits
PublicKeys
SmtpServer
HypervisorTypes
ClusterRedundancyState
Multicluster
Cloudcluster
HasSelfEncryptingDrive
IsUpgradeInProgress
SecurityComplianceConfig
HypervisorSecurityComplianceConfig
HypervisorLldpConfig
ClusterArch
IsSspEnabled
IscsiConfig
Cluster wide iscsi configuration
ClusterDataState
Stats
UsageStats
HealthSummary
AlertSummary
DisableDegradedNodeMonitoring
CommonCriteriaMode
EnableOnDiskDedup
ManagementServers
FaultToleranceDomainType
Operation
GenericDTO
ClusterUuid
Template
55
AOS | ClusterDataState | 479

CLUSTERDATASTATE
Operations
• Get Cluster Data State: Get-NTNXClusterDataState
Get Cluster Data State

> Get-NTNXClusterDataState [[-Servers] <string[]>] -Id <Object>
> Get-NTNXClusterDataState [-Id <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXClusterDataState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Cluster ID
56
AOS | ClusterExternalDetail | 481

CLUSTEREXTERNALDETAIL
Operations
• Get Cluster External Details: Get-NTNXClusterExternalDetail
Get Cluster External Details

> Get-NTNXClusterExternalDetail [[-Servers] <string[]>] -Id <Object>
> Get-NTNXClusterExternalDetail [-Id <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXClusterExternalDetail [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Cluster ID
57
AOS | ClusterExternalState | 483

CLUSTEREXTERNALSTATE
Operations
• Get the Cluster External State for all clusters: Get-NTNXClusterExternalState
Get the Cluster External State for all clusters

> Get-NTNXClusterExternalState [[-Servers] <string[]>] [-Id <Object>]
> Get-NTNXClusterExternalState [-Id <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXClusterExternalState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Cluster ID
58
AOS | ClusterFromMulticluster | 485

CLUSTERFROMMULTICLUSTER
Operations
• Remove from multicluster: Remove-NTNXClusterFromMulticluster
Remove from multicluster

> Remove-NTNXClusterFromMulticluster [[-Servers] <string[]>] [-ClusterName
<string>] [-IpAddresses <string[]>] [-Multicluster <bool>] [-Username
<string>] [-Password <string>] [-PrcCluster <bool>] [-Reachable <bool>] [-Port
<int>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXClusterFromMulticluster [-ClusterName <string>] [-IpAddresses

<string[]>] [-Multicluster <bool>] [-Username <string>] [-Password <string>]
[-PrcCluster <bool>] [-Reachable <bool>] [-Port <int>] [-Template]
> Remove-NTNXClusterFromMulticluster [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
ClusterName
IpAddresses
Multicluster
Username
Password
PrcCluster
Reachable
Port
Template
59
AOS | ClusterInfo | 487

CLUSTERINFO
Operations
• Get Cluster details: Get-NTNXClusterInfo
Get the details of the cluster

> Get-NTNXClusterInfo [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXClusterInfo [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
60
AOS | ClusterLicenseInfo | 489

CLUSTERLICENSEINFO
Operations
• Get Cluster Info: Get-NTNXClusterLicenseInfo
Get Cluster Info

> Get-NTNXClusterLicenseInfo [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXClusterLicenseInfo [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
61
AOS | ClusterStat | 491

CLUSTERSTAT
Operations
• Get the list of Cluster stats: Get-NTNXClusterStat
Get the stats for the specified metrics

If start time and end time are included in the query string, then historical stats are retrieved.
Otherwise, the latest statsare retrieved.
> Get-NTNXClusterStat [[-Servers] <string[]>] -Metrics <Object>
-StartTimeInUsecs <long> -EndTimeInUsecs <long> -IntervalInSecs <int>
> Get-NTNXClusterStat [-Metrics <Object>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-IntervalInSecs <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXClusterStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Metrics
List of metrics
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
Sampling interval of stats
62
AOS | ClusterToMulticluster | 493

CLUSTERTOMULTICLUSTER
Operations
• Add to multicluster: Add-NTNXClusterToMulticluster
Add to multicluster
> Add-NTNXClusterToMulticluster [[-Servers] <string[]>] [-ClusterName
<string>] [-IpAddresses <string[]>] [-Multicluster <bool>] [-Username
<string>] [-Password <string>] [-PrcCluster <bool>] [-Reachable <bool>] [-Port
> Add-NTNXClusterToMulticluster [-ClusterName <string>] [-IpAddresses

<string[]>] [-Multicluster <bool>] [-Username <string>] [-Password <string>]
[-PrcCluster <bool>] [-Reachable <bool>] [-Port <int>] [-Template]
> Add-NTNXClusterToMulticluster [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
ClusterName
IpAddresses
Multicluster
Username
Password
PrcCluster
Reachable
Port
Template
63
AOS | ConsistencyGroup | 495

CONSISTENCYGROUP
Operations
• Updates Consistency Group for a specific protection domain: Update-NTNXConsistencyGroup
Updates Consistency Group for a specific protection domain

> Update-NTNXConsistencyGroup [[-Servers] <string[]>] -PdName <Object> -CgName
<Object> [-ProtectionDomainName <string>] [-ConsistencyGroupName <string>]
[-WithinSnapshot <bool>] [-AppConsistentSnapshots <bool>] [-MarkedForRemoval
<bool>] [-VmCount <int>] [-NfsFileCount <int>] [-TotalFileCount <int>]
[-TotalFileSizeBytes <long>] [-ExpandedOutput] [-GridView]
> Update-NTNXConsistencyGroup [-PdName <Object>] [-CgName <Object>]

[-ProtectionDomainName <string>] [-ConsistencyGroupName <string>]
[-WithinSnapshot <bool>] [-AppConsistentSnapshots <bool>] [-MarkedForRemoval
<bool>] [-VmCount <int>] [-NfsFileCount <int>] [-TotalFileCount <int>]
[-TotalFileSizeBytes <long>] [-Template] [-ExpandedOutput] [-GridView]
> Update-NTNXConsistencyGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Name of the Protection Domain
CgName
Name of the Consistency Group
Optional arguments
ProtectionDomainName
ConsistencyGroupName
WithinSnapshot
AppConsistentSnapshots
MarkedForRemoval
VmCount
NfsFileCount
TotalFileCount
TotalFileSizeBytes
Template
64
AOS | Container | 497

CONTAINER
Operations
• Get the list of Containers: Get-NTNXContainer

• Add a Container: New-NTNXContainer
• Delete a Container: Remove-NTNXContainer
• Modify a Container: Set-NTNXContainer
Get the list of Containers configured in the cluster

> Get-NTNXContainer [[-Servers] <string[]>] [-Id <Object>] [-Projection
> Get-NTNXContainer [-Id <Object>] [-Projection <Object>] [-Count <int>]

> Get-NTNXContainer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of the Container
Optional arguments
Projection
Count
Number of Containers to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
Modify the specified Container

> Set-NTNXContainer [[-Servers] <string[]>] [-Id <string>] [-ContainerUuid
<string>] [-Name <string>] [-StoragePoolId <string>] [-StoragePoolUuid

<string>] [-MarkedForRemoval <bool>] [-MaxCapacity <long>]
[-TotalExplicitReservedCapacity <long>] [-TotalImplicitReservedCapacity
<long>] [-AdvertisedCapacity <long>] [-ReplicationFactor <int>]
[-OplogReplicationFactor <int>] [-NfsWhitelist <string[]>]
[-NfsWhitelistInherited <bool>] [-RandomIoPreference <string[]>]
[-SeqIoPreference <string[]>] [-IlmPolicy <string>] [-DownMigrateTimesInSecs
<Object>] [-ErasureCode <string>] [-PreferHigherECFaultDomain <bool>]
[-ErasureCodeDelaySecs <int>] [-FingerPrintOnWrite
<SetContainer+FingerPrintOnWrite_Enum>] [-OnDiskDedup
<SetContainer+OnDiskDedup_Enum>] [-CompressionEnabled <bool>]
[-CompressionDelayInSecs <int>] [-IsNutanixManaged <bool>]
[-EnableSoftwareEncryption <bool>] [-VstoreNameList <string[]>]
[-MappedRemoteContainers <Object>] [-Stats <Object>] [-UsageStats <Object>]
[-Encrypted <bool>] [-Operation <string>] [-GenericDTO <string>] [-ClusterUuid
> Set-NTNXContainer [-Id <string>] [-ContainerUuid <string>] [-Name <string>]

[-StoragePoolId <string>] [-StoragePoolUuid <string>] [-MarkedForRemoval
<bool>] [-MaxCapacity <long>] [-TotalExplicitReservedCapacity <long>]
[-TotalImplicitReservedCapacity <long>] [-AdvertisedCapacity <long>]
[-ReplicationFactor <int>] [-OplogReplicationFactor <int>] [-NfsWhitelist
<string[]>] [-NfsWhitelistInherited <bool>] [-RandomIoPreference <string[]>]
<SetContainer+FingerPrintOnWrite_Enum>] [-OnDiskDedup
<SetContainer+OnDiskDedup_Enum>] [-CompressionEnabled <bool>]
[-Encrypted <bool>] [-Operation <string>] [-GenericDTO <string>] [-ClusterUuid
> Set-NTNXContainer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Id
ContainerUuid
StorageContainerUuid
Name
StoragePoolId
StoragePoolUuid
MarkedForRemoval
MaxCapacity
TotalExplicitReservedCapacity
TotalImplicitReservedCapacity

AdvertisedCapacity
ReplicationFactor
OplogReplicationFactor
NfsWhitelist
NfsWhitelistInherited
RandomIoPreference
SeqIoPreference
IlmPolicy
DownMigrateTimesInSecs
ErasureCode
PreferHigherECFaultDomain
ErasureCodeDelaySecs
FingerPrintOnWrite
OnDiskDedup
CompressionEnabled
CompressionDelayInSecs
IsNutanixManaged
EnableSoftwareEncryption
VstoreNameList
MappedRemoteContainers
Stats
UsageStats
HealthSummary
AlertSummary
Encrypted
Operation
GenericDTO
ClusterUuid
Template
Add a Container to the cluster

> New-NTNXContainer [[-Servers] <string[]>] [-Id <string>] [-ContainerUuid
<string>] [-Name <string>] [-StoragePoolId <string>] [-StoragePoolUuid

<string>] [-MarkedForRemoval <bool>] [-MaxCapacity <long>]
[-TotalExplicitReservedCapacity <long>] [-TotalImplicitReservedCapacity
<long>] [-AdvertisedCapacity <long>] [-ReplicationFactor <int>]
[-OplogReplicationFactor <int>] [-NfsWhitelist <string[]>]
[-NfsWhitelistInherited <bool>] [-RandomIoPreference <string[]>]
<NewContainer+FingerPrintOnWrite_Enum>] [-OnDiskDedup
<NewContainer+OnDiskDedup_Enum>] [-CompressionEnabled <bool>]
[-Encrypted <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> New-NTNXContainer [-Id <string>] [-ContainerUuid <string>] [-Name <string>]

[-StoragePoolId <string>] [-StoragePoolUuid <string>] [-MarkedForRemoval
<bool>] [-MaxCapacity <long>] [-TotalExplicitReservedCapacity <long>]
[-TotalImplicitReservedCapacity <long>] [-AdvertisedCapacity <long>]
[-ReplicationFactor <int>] [-OplogReplicationFactor <int>] [-NfsWhitelist
<string[]>] [-NfsWhitelistInherited <bool>] [-RandomIoPreference <string[]>]
<NewContainer+FingerPrintOnWrite_Enum>] [-OnDiskDedup
<NewContainer+OnDiskDedup_Enum>] [-CompressionEnabled <bool>]
[-Encrypted <bool>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXContainer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Id
ContainerUuid
Name
StoragePoolId
StoragePoolUuid
MarkedForRemoval
MaxCapacity
TotalExplicitReservedCapacity
TotalImplicitReservedCapacity

AdvertisedCapacity
ReplicationFactor
OplogReplicationFactor
NfsWhitelist
NfsWhitelistInherited
RandomIoPreference
SeqIoPreference
IlmPolicy
DownMigrateTimesInSecs
ErasureCode
PreferHigherECFaultDomain
FingerPrintOnWrite
OnDiskDedup
CompressionEnabled
CompressionDelayInSecs
IsNutanixManaged
EnableSoftwareEncryption
VstoreNameList
MappedRemoteContainers
Stats
UsageStats
HealthSummary
AlertSummary
Encrypted
Template
Delete a Container with the specified id from the cluster

> Remove-NTNXContainer [[-Servers] <string[]>] -Id <Object> [-IgnoreSmallFiles
<bool>] [-Force <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXContainer [-Id <Object>] [-IgnoreSmallFiles <bool>] [-Force

<bool>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXContainer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of the Container
Optional arguments
IgnoreSmallFiles
Ignore small file
Force
Force the operation
Template

65
AOS | ContainerAlert | 504

CONTAINERALERT
Operations
• Get the list of alerts generated on any Container: Get-NTNXContainerAlert
> Get-NTNXContainerAlert [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-Count <int>] [-Resolved] [-Acknowledged] [-Severity
<Object>] [-AlertTypeUuid <Object>] [-Page <int>] [-Id <Object>]
> Get-NTNXContainerAlert [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Count <int>] [-Resolved] [-Acknowledged] [-Severity <Object>]
[-AlertTypeUuid <Object>] [-Page <int>] [-Id <Object>] [-ExpandedOutput]
> Get-NTNXContainerAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Container
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
AOS | ContainerAlert | 505

66
AOS | ContainerEvent | 506

CONTAINEREVENT
Operations
• Get the list of events generated on any Container: Get-NTNXContainerEvent
> Get-NTNXContainerEvent [[-Servers] <string[]>] [-Id <Object>]

[-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-Count <int>]
[-Acknowledged] [-Page <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXContainerEvent [-Id <Object>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>]
> Get-NTNXContainerEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Container
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Maximum number of events
Acknowledged
Events which have been acknowledged
Page
Page number
AOS | ContainerEvent | 507

67
AOS | ContainerStat | 508

CONTAINERSTAT
Operations
• Get the stats for a specified Container: Get-NTNXContainerStat
If start time and end time are included in the query string, then historical stats are retrieved
Otherwise, the latest stats are retrieved.
> Get-NTNXContainerStat [[-Servers] <string[]>] -Id <Object> -Metrics <Object>
[-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-IntervalInSecs <int>]
> Get-NTNXContainerStat [-Id <Object>] [-Metrics <Object>] [-StartTimeInUsecs

<long>] [-EndTimeInUsecs <long>] [-IntervalInSecs <int>] [-ExpandedOutput]
> Get-NTNXContainerStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Container
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | ContainerStat | 509

68
AOS | ContainerVDisk | 510

CONTAINERVDISK
Operations
• Get the list of VDisks: Get-NTNXContainerVDisk
Get the list of VDisks of the specified Container

> Get-NTNXContainerVDisk [[-Servers] <string[]>] -Id <Object>
> Get-NTNXContainerVDisk [-Id <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXContainerVDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Container
AOS | ContainerVDisk | 511

69
AOS | CronSchedule | 512

CRONSCHEDULE
Operations
• Remove all snapshot schedules from a Protection Domain: Clear-NTNXCronSchedule
Remove all snapshot schedules from the specified ProtectionDomain

> Clear-NTNXCronSchedule [[-Servers] <string[]>] -PdName <Object>
> Clear-NTNXCronSchedule [-PdName <Object>] [-Template] [-ExpandedOutput]

> Clear-NTNXCronSchedule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Template
AOS | CronSchedule | 513

70
AOS | CurrentlyLoggedInUserInfo | 514

CURRENTLYLOGGEDINUSERINFO
Operations
• Get Logged In Details of a user: Get-NTNXCurrentlyLoggedInUserInfo
Get Username, Ip Address and Browser details of user for a given user
> Get-NTNXCurrentlyLoggedInUserInfo [[-Servers] <string[]>] -UserName <Object>
> Get-NTNXCurrentlyLoggedInUserInfo [-UserName <Object>] [-ExpandedOutput]

> Get-NTNXCurrentlyLoggedInUserInfo [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
UserName
UserName of the Logged in User
AOS | CurrentlyLoggedInUserInfo | 515

71
AOS | CurrentlyLoggedInUsersInfo | 516

CURRENTLYLOGGEDINUSERSINFO
Operations
• Get Logged In Users Details: Get-NTNXCurrentlyLoggedInUsersInfo
Get Username, Ip Address and Browser details of all users who have logged in
> Get-NTNXCurrentlyLoggedInUsersInfo [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXCurrentlyLoggedInUsersInfo [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
AOS | CurrentlyLoggedInUsersInfo | 517

72
AOS | Dns | 518

DNS
Operations
• Remove Dns Entries: Remove-NTNXDns

• Verify Dns Entries: Verify-NTNXDns
Remove Dns Entries

Required arguments
Uuid
UUID of the FileServer
DnsOpType
DNS Nameserver operation type: AFS specific DNS entries are needed on
the nameservers so that clients can connect to the fileserver using its FQDN
(fileserver_name.domain_name). AFS can add these entries automatically for
MS-DNS servers or they can be added manually. Select one of "MS_DNS" or
"MANUAL".
DnsUserName
Username to use for adding fileserver DNS entries on the nameservers.
DnsPassword
Password to use for adding fileserver DNS entries on the nameservers.
Optional arguments
DnsServer
Preferred Nameserver FQDN (if not given, AFS finds one using an NS query)
NvmOnly
Template
Verify Dns Entries

Required arguments
Uuid
Optional arguments
DnsServer
Dns server IP address
Template
AOS | Dns | 519

73
AOS | DefaultCloudCredential | 520

DEFAULTCLOUDCREDENTIAL
Operations
• Set a default cloud credential to use: Set-NTNXDefaultCloudCredential
Set a default cloud credential for accessing cloud sites

> Set-NTNXDefaultCloudCredential [[-Servers] <string[]>] -CloudType <Object>
-Arg1 <string> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXDefaultCloudCredential [-CloudType <Object>] [-Arg1 <string>]

> Set-NTNXDefaultCloudCredential [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
CloudType
Cloud type
Arg1
Optional arguments
Template
AOS | DefaultCloudCredential | 521

74
AOS | Disk | 522

DISK
Operations
• Get the list of Disks: Get-NTNXDisk

• Sets new passwords for encryption capable disks: Rekey-NTNXDisk
Sets new passwords for encryption capable disks

> Rekey-NTNXDisk [[-Servers] <string[]>] -InputList <string[]>
> Rekey-NTNXDisk [-InputList <string[]>] [-Template] [-ExpandedOutput]

> Rekey-NTNXDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
InputList
Optional arguments
Template
Get the list of Disks configured in the cluster

> Get-NTNXDisk [[-Servers] <string[]>] [-Id <Object>] [-Projection <Object>]
[-Count <int>] [-FilterCriteria <Object>] [-SortCriteria <Object>]
> Get-NTNXDisk [-Id <Object>] [-Projection <Object>] [-Count <int>]

> Get-NTNXDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of the Disk
Optional arguments
Projection
AOS | Disk | 523

Count
Number of Disks to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
75
AOS | DiskAlert | 525

DISKALERT
Operations
• Get the list of alerts generated on any Disk: Get-NTNXDiskAlert
> Get-NTNXDiskAlert [[-Servers] <string[]>] [-Id <Object>] [-StartTimeInUsecs

<long>] [-EndTimeInUsecs <long>] [-Count <int>] [-Resolved] [-Acknowledged]
[-Severity <Object>] [-AlertTypeUuid <Object>] [-Page <int>] [-ExpandedOutput]
> Get-NTNXDiskAlert [-Id <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs

<long>] [-Count <int>] [-Resolved] [-Acknowledged] [-Severity <Object>]
[-AlertTypeUuid <Object>] [-Page <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXDiskAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Disk
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
76
AOS | DiskEvent | 527

DISKEVENT
Operations
• Get the list of events generated on any Disk: Get-NTNXDiskEvent
> Get-NTNXDiskEvent [[-Servers] <string[]>] [-Id <Object>] [-StartTimeInUsecs

<long>] [-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>]
> Get-NTNXDiskEvent [-Id <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs

<long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-ExpandedOutput]
> Get-NTNXDiskEvent [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Disk
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
77
AOS | DiskForRemoval | 529

DISKFORREMOVAL
Operations
• Mark specified Disk for Removal: Mark-NTNXDiskForRemoval
Mark specified Disk for removal

Use 'force' option to ignore all the system validations.
> Mark-NTNXDiskForRemoval [[-Servers] <string[]>] -Id <Object> [-Force <bool>]
[-BypassUpgradeCheck <bool>] [-ExpandedOutput] [-GridView]
> Mark-NTNXDiskForRemoval [-Id <Object>] [-Force <bool>] [-BypassUpgradeCheck

> Mark-NTNXDiskForRemoval [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Disk
Optional arguments
Force
Force the operation
BypassUpgradeCheck
Skip upgrade check
Template
78
AOS | DiskHealthCheckSummary | 531

DISKHEALTHCHECKSUMMARY
Operations
• Get the health check summary for the Disks: Get-NTNXDiskHealthCheckSummary
> Get-NTNXDiskHealthCheckSummary [[-Servers] <string[]>] [-FilterCriteria

<Object>] [-DetailedSummary] [-ExpandedOutput] [-GridView]
> Get-NTNXDiskHealthCheckSummary [-FilterCriteria <Object>] [-DetailedSummary]

> Get-NTNXDiskHealthCheckSummary [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
FilterCriteria
Filter criteria
DetailedSummary
Detailed summary
79
AOS | DiskStat | 533

DISKSTAT
Operations
• Get the stats for a specified Disk: Get-NTNXDiskStat
> Get-NTNXDiskStat [[-Servers] <string[]>] -Id <Object> -Metrics <Object>
> Get-NTNXDiskStat [-Id <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXDiskStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Disk
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
80
AOS | Dns | 535

DNS
Operations
• Remove Dns Entries: Remove-NTNXDns

• Verify Dns Entries: Verify-NTNXDns
Remove Dns Entries

Required arguments
Uuid
DnsOpType
DNS Nameserver operation type: AFS specific DNS entries are needed on
the nameservers so that clients can connect to the fileserver using its FQDN
(fileserver_name.domain_name). AFS can add these entries automatically for
MS-DNS servers or they can be added manually. Select one of "MS_DNS" or
"MANUAL".
DnsUserName
Username to use for adding fileserver DNS entries on the nameservers.
DnsPassword
Password to use for adding fileserver DNS entries on the nameservers.
Optional arguments
DnsServer
Preferred Nameserver FQDN (if not given, AFS finds one using an NS query)
NvmOnly
Template
Verify Dns Entries

Required arguments
Uuid
Optional arguments
DnsServer
Dns server IP address
Template
81
AOS | DnsEntries | 537

DNSENTRIES
Operations
• Get the list of dns entries: Get-NTNXDnsEntries
Get the list of dns entries associated with a file server

Required arguments
Uuid
82
AOS | Domain | 539

DOMAIN
Operations
• Join Domain: Join-NTNXDomain

• Unjoin Domain: Unjoin-NTNXDomain
Join FileServer To Domain

Required arguments
Uuid
Optional arguments
WindowsAdDomainName
The windows AD domain the file server is associated with.
WindowsAdUsername
The name of a user account with administrative privileges in the AD domain the
file server is associated with.
OrganizationalUnit
An Organizational unit container is where the AFS machine account will
be created as part of domain join operation. Use a / to specify hierarchical
Organization Units. Default container OU is "Computers". Examples: Engineering,
Department/Engineering.
WindowsAdPassword
The password for the above Windows AD account
OverwriteUserAccount
If a machine account with the same name as file-server name is present on the
AD, then overwrite it during join-domain operation.
SpnDnsOnly
NvmOnly
ValidateAdCredential
PreferredDomainController
Use a specific domain controller for join-domain operation in a multi DC Active
Directory setups. By default, AFS discovers a site local domain controller for join-
domain operation.
AddUserAsFsAdmin
ProtocolType
Protocol Type(NONE,SMB,NFS,"NFS,SMB")
Rfc2307Enabled
RFC 2307 ENABLED (true, false)
UseSameCredentialsForDns
Use the same AD credential for dns
AOS | Domain | 540

ForceLeaveDomain
If the joined Active Directory is down or not reachable, then use this option to
leave the domain by bypassing all AD interaction. Please ensure to remove the
fileserver machine account manually afterwards.
Template
Unjoin FileServer From Domain

Required arguments
Uuid
WindowsAdPassword
Optional arguments
WindowsAdUsername
ResetSpnDnsOnly
NvmOnly
ForceLeaveDomain
Template
AOS | Domain | 541

83
AOS | EncryptedBackup | 542

ENCRYPTEDBACKUP
Operations
• Download encryption key: Get-NTNXEncryptedBackup
Download encryption key encrypted with the password

> Get-NTNXEncryptedBackup [[-Servers] <string[]>] [-Password <string>]
> Get-NTNXEncryptedBackup [-Password <string>] [-Template] [-ExpandedOutput]

> Get-NTNXEncryptedBackup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Password
Template
AOS | EncryptedBackup | 543

84
AOS | EncryptionConfiguration | 544

ENCRYPTIONCONFIGURATION
Operations
• Test encryption configuration: Test-NTNXEncryptionConfiguration
Test encryption configuration of the cluster

> Test-NTNXEncryptionConfiguration [[-Servers] <string[]>] [-NodeIdList
<string[]>] [-NodeUuidList <string[]>] [-ServerList <string[]>]
> Test-NTNXEncryptionConfiguration [-NodeIdList <string[]>] [-NodeUuidList

<string[]>] [-ServerList <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> Test-NTNXEncryptionConfiguration [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
NodeIdList
NodeUuidList
ServerList
Template
AOS | EncryptionConfiguration | 545

85
AOS | Entity | 546

ENTITY
Operations
• Rollback Virtual Machines and/or NFS files: Restore-NTNXEntity
Rollback Virtual Machines and/or NFS files in a Protection Domain to a given Snapshot
> Restore-NTNXEntity [[-Servers] <string[]>] -PdName <Object> [-VmNames
<string[]>] [-NfsFiles <string[]>] [-VolumeGroupUuids <string[]>] [-Replace
<bool>] [-PathPrefix <string>] [-VmNamePrefix <string>] [-VgNamePrefix
<string>] [-SnapshotId <string>] [-ExpandedOutput] [-GridView]
> Restore-NTNXEntity [-PdName <Object>] [-VmNames <string[]>] [-NfsFiles

<string[]>] [-VolumeGroupUuids <string[]>] [-Replace <bool>] [-PathPrefix
<string>] [-VmNamePrefix <string>] [-VgNamePrefix <string>] [-SnapshotId
> Restore-NTNXEntity [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
PdName
Optional arguments
VmNames
Names of VM to be restored.
VmUuids
Uuids of VM to be restored.
NfsFiles
Names of NFS files to be restored
VolumeGroupUuids
UUIDs of Volume Groups to be restored
Replace
Whether to replace entities.
PathPrefix
Path prefix to be applied for cloning VMs. It is recommended to not use
path_prefix while restoring a virtual machine or volume group.
VmNamePrefix
Name prefix to be applied for cloning VMs.
VgNamePrefix
Name prefix to be applied for cloning VGs.
SnapshotId
Id of the snapshot to restore entities from.
AOS | Entity | 547

Template
86
AOS | EntityFromTag | 549

ENTITYFROMTAG
Operations
• Removes entities from a tag: Remove-NTNXEntityFromTag
Untags the entities with the requested tag

> Remove-NTNXEntityFromTag [[-Servers] <string[]>] -TagUuid <string> -Entity
<EntityDTO> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXEntityFromTag [-TagUuid <string>] [-Entity <EntityDTO>]

> Remove-NTNXEntityFromTag [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
TagUuid
The tag uuid
Entity
Entity to be added/removed to/from the tag
Optional arguments
Template
87
AOS | EntityToTag | 551

ENTITYTOTAG
Operations
• Adds entities to a tag: Add-NTNXEntityToTag
Tags the entities with the requested tag

> Add-NTNXEntityToTag [[-Servers] <string[]>] -TagUuid <string> -Entity
<EntityDTO> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXEntityToTag [-TagUuid <string>] [-Entity <EntityDTO>] [-Template]

> Add-NTNXEntityToTag [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
TagUuid
The tag uuid
Entity
Entity to be added/removed to/from the tag
Optional arguments
Template
88
AOS | Event | 553

EVENT
Operations
• Acknowledge Event: Acknowledge-NTNXEvent

• Get the list of Events: Get-NTNXEvent
Get the list of Events generated in the cluster

> Get-NTNXEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
[-EntityType <Object>] [-EntityIds <Object>] [-TypeIds <Object>]
> Get-NTNXEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-Count

<int>] [-Acknowledged] [-Page <int>] [-EntityType <Object>] [-EntityIds
<Object>] [-TypeIds <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXEvent [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
EntityType
Entity type
EntityIds
Entity ids
TypeIds
Type ids for events
Acknowledge Event with the specified Id

> Acknowledge-NTNXEvent [[-Servers] <string[]>] -Id <Object> [-ExpandedOutput]
AOS | Event | 554

> Acknowledge-NTNXEvent [-Id <Object>] [-Template] [-ExpandedOutput]
> Acknowledge-NTNXEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Event Id
Optional arguments
Template
AOS | Event | 555

89
AOS | Events | 556

EVENTS
Operations
• Acknowledge events: Acknowledge-NTNXEvents
Acknowledge events using a filter criteria

> Acknowledge-NTNXEvents [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
[-EndTimeInUsecs <long>] [-Severity <Object>] [-EntityType <Object>]
[-EntityTypeIds <Object>] [-Count <int>] [-ExpandedOutput] [-GridView]
> Acknowledge-NTNXEvents [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Severity <Object>] [-EntityType <Object>] [-EntityTypeIds <Object>] [-Count
<int>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Acknowledge-NTNXEvents [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Severity
Severity
EntityType
Entity Type
EntityTypeIds
Entity Type Ids
Count
Template
AOS | Events | 557

90
AOS | FSAdminUser | 558

FSADMINUSER
Operations
• Get a single admin user: Get-NTNXFSAdminUser
Get a admi user associated with a File server

> Get-NTNXFSAdminUser [[-Servers] <string[]>] -Uuid <Object> -AdminUserUuid
> Get-NTNXFSAdminUser [-Uuid <Object>] [-AdminUserUuid <Object>]

> Get-NTNXFSAdminUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
AdminUserUuid
uuid of the admin user
AOS | FSAdminUser | 559

91
AOS | FSPrincipalType | 560

FSPRINCIPALTYPE
Operations
• Get principal type from principal name: Get-NTNXFSPrincipalType

> Get-NTNXFSPrincipalType [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -PrincipalName <string> [-PrincipalType
<GetFSPrincipalType+QuotaPolicyPrincipalType_Enum>] [-ProtocolType
<GetFSPrincipalType+ShareProtocolType_Enum>] [-ExpandedOutput] [-GridView]
> Get-NTNXFSPrincipalType [-Uuid <Object>] [-ShareUuid <Object>]

[-PrincipalName <string>] [-PrincipalType
<GetFSPrincipalType+QuotaPolicyPrincipalType_Enum>] [-ProtocolType
<GetFSPrincipalType+ShareProtocolType_Enum>] [-Template] [-ExpandedOutput]
> Get-NTNXFSPrincipalType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that quota policy is associated with
ShareUuid
Uuid of the share that principal type is associated with
PrincipalName
Quota policy principal value (user or group name)
Optional arguments
PrincipalType
Quota policy principal type (enter 'user' or 'group')
ProtocolType
Primary protocol type (SMB or NFS)
Template
AOS | FSPrincipalType | 561

92
AOS | FSQuotaPolicies | 562

FSQUOTAPOLICIES
Operations
• Get the list of quota policies: Get-NTNXFSQuotaPolicies
Get the list of quota policies associated with a share

> Get-NTNXFSQuotaPolicies [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> [-QuotaPolicyUuid <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXFSQuotaPolicies [-Uuid <Object>] [-ShareUuid <Object>]

[-QuotaPolicyUuid <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXFSQuotaPolicies [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
uuid of the share
QuotaPolicyUuid
uuid of the quota policy
AOS | FSQuotaPolicies | 563

93
AOS | FSQuotaPolicy | 564

FSQUOTAPOLICY
Operations
• Add new Quota Policy: Add-NTNXFSQuotaPolicy

• Delete Quota Policy: Remove-NTNXFSQuotaPolicy
• Update Quota Policy: Update-NTNXFSQuotaPolicy

> Add-NTNXFSQuotaPolicy [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -PrincipalValue <string> -QuotaSizeGiB <float> -QuotaEnforcementType
<AddFSQuotaPolicy+QuotaEnforcementType_Enum> [-PrincipalType
<AddFSQuotaPolicy+QuotaPolicyPrincipalType_Enum>]
[-SendQuotaNotificationsToUser <bool>] [-NotificationRecipients <string[]>]
> Add-NTNXFSQuotaPolicy [-Uuid <Object>] [-ShareUuid <Object>] [-PrincipalType

<AddFSQuotaPolicy+QuotaPolicyPrincipalType_Enum>] [-PrincipalValue <string>]
[-QuotaSizeGiB <float>] [-QuotaEnforcementType
<AddFSQuotaPolicy+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser
<bool>] [-NotificationRecipients <string[]>] [-Template] [-ExpandedOutput]
> Add-NTNXFSQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
Uuid of the share that quota policy is associated with
PrincipalValue
QuotaSizeGiB
Quota size in Gibs
QuotaEnforcementType
Quota enforcement type (Hard or Soft)
Optional arguments
PrincipalType
SendQuotaNotificationsToUser
Send quota notifications to user
NotificationRecipients
Additional notification recipients (comma-separated)

Template
Update Quota Policy

> Update-NTNXFSQuotaPolicy [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -QuotaPolicy_Uuid <string> [-QuotaSizeGiB <float>]
[-QuotaEnforcementType <UpdateFSQuotaPolicy+QuotaEnforcementType_Enum>]
> Update-NTNXFSQuotaPolicy [-Uuid <Object>] [-ShareUuid <Object>]

[-QuotaPolicy_Uuid <string>] [-QuotaSizeGiB <float>] [-QuotaEnforcementType
<UpdateFSQuotaPolicy+QuotaEnforcementType_Enum>]
> Update-NTNXFSQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
Uuid
Uuid of the Quota Policy
Optional arguments
QuotaSizeGiB
Quota size in Gibs
Template
Delete Quota Policy

> Remove-NTNXFSQuotaPolicy [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -QuotaPolicyUuid <Object> [-ExpandedOutput] [-GridView]
> Remove-NTNXFSQuotaPolicy [-Uuid <Object>] [-ShareUuid <Object>]

[-QuotaPolicyUuid <Object>] [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXFSQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
QuotaPolicyUuid
Optional arguments
Template

94
AOS | FSStat | 568

FSSTAT
Operations
• Get the stats for a specified FS: Get-NTNXFSStat
> Get-NTNXFSStat [[-Servers] <string[]>] -Uuid <Object> -Metrics <Object>
> Get-NTNXFSStat [-Uuid <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXFSStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
uuid of the FS
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | FSStat | 569

95
AOS | File | 570

FILE
Operations
• Remove files for a specific file group: Delete-NTNXFile
Remove files for a specific file group

> Delete-NTNXFile [[-Servers] <string[]>] -FileGroupUuid <Object>
> Delete-NTNXFile [-FileGroupUuid <Object>] [-Template] [-ExpandedOutput]

> Delete-NTNXFile [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
FileGroupUuid
UUID of file group
Optional arguments
Template
AOS | File | 571

96
AOS | FileGroup | 572

FILEGROUP
Operations
• List file groups: Get-NTNXFileGroup
List file groups

> Get-NTNXFileGroup [[-Servers] <string[]>] [-FileGroupUuid <Object>]
> Get-NTNXFileGroup [-FileGroupUuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXFileGroup [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
FileGroupUuid
UUID of file group
AOS | FileGroup | 573

97
AOS | Fileserver | 574

FILESERVER
Operations
• Activate File Server: Activate-NTNXFileserver

• Clone File Server: Clone-NTNXFileserver
• LoadBalance File Server: Loadbalance-NTNXFileserver
• Protect File Server: Protect-NTNXFileserver
Activate File server

Required arguments
Uuid
DnsServerIpAddresses
List of comma-separated dns server ip addresses for file server configuration.
NtpServers
List of comma-separated ntp servers for file server configuration.
Optional arguments
Uuid
ContainerId
ContainerUuid
Name
Name of the file server
NumCalculatedNvms
Total number of file server VMs associated with the file server.
MemoryGiB
Memory associated with each file server VM.
NumVcpus
Number of vCPUs per file server VM.
DnsDomainName
Fully qualified domain name (fileserver namespace). This, along with the
fileserver name, constitutes the namespace of the fileserver. Example:
fileserver_name.corp.companyname.com. This is also used to create fileserver
DNS entries on the nameservers so that clients can access the fileserver using its
name.
InternalVirtualNetworkUuid
The identifier of the internal virtual network. Please use network UUID on AHV
and ESX.
InternalNetwork
Internal network used by file server VMs.

ExternalVirtualNetworkUuids
The identifier of the external virtual network. Please use network UUID on AHV
and ESX.
ExternalNetworks
External networks used by file server VMs.
WindowsAdDomainName
WindowsAdUsername
WindowsAdPassword
SizeGib
File server size in gibs
OrganizationalUnit
domain operation.
PdName
Name of the pd going to be associated with the file server.
AddUserAsFsAdmin
SnapshotUuid
NameServicesDTO
FsDnsOperationsDTO
GetPrincipalTypeDTO
Template
Clone File server

Required arguments
Uuid

NtpServers
Optional arguments
Uuid
ContainerId
ContainerUuid
Name
NumCalculatedNvms
MemoryGiB
NumVcpus
DnsDomainName
name.
and ESX.
InternalNetwork
and ESX.
ExternalNetworks
WindowsAdDomainName
WindowsAdUsername
WindowsAdPassword
SizeGib
OrganizationalUnit

domain operation.
PdName
AddUserAsFsAdmin
SnapshotUuid
NameServicesDTO
FsDnsOperationsDTO
GetPrincipalTypeDTO
Template
Protect File server

Required arguments
Uuid
Optional arguments
PdName
pd name
Template
LoadBalance File server

Required arguments
Uuid
Optional arguments
Uuid
Name
DnsDomainName
MemoryGiB
NumVcpus

NtpServers
InternalNetwork
ExternalNetworks
NumCalculatedNvms
RecommendedAction
SizeGib
ForceNetworkChange
FileBlockingExtensions
Template

98
AOS | FileServerByUuid | 580

FILESERVERBYUUID
Operations
• Get a single FileServer's details: Get-NTNXFileServerByUuid
Get a single FileServer's details

> Get-NTNXFileServerByUuid [[-Servers] <string[]>] -Uuid <Object> [-Projection
> Get-NTNXFileServerByUuid [-Uuid <Object>] [-Projection <Object>]

> Get-NTNXFileServerByUuid [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Projection
AOS | FileServerByUuid | 581

99
AOS | FileServerPulse | 582

FILESERVERPULSE
Operations
• Get the pulse configs: Get-NTNXFileServerPulse
Get the pulse config associated with all the file servers
Required arguments
None
AOS | FileServerPulse | 583

100
AOS | FileServershare | 584

FILESERVERSHARE
Operations
• Delete File Server Share: Remove-NTNXFileServershare

> Remove-NTNXFileServershare [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> [-Force <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXFileServershare [-Uuid <Object>] [-ShareUuid <Object>] [-Force

> Remove-NTNXFileServershare [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
uuid of the File Server
ShareUuid
uuid of the FileServer share
Optional arguments
Force
force delete Share
Template

101
AOS | FileServerShares | 586

FILESERVERSHARES
Operations
• Get the list of Shares: Get-NTNXFileServerShares

> Get-NTNXFileServerShares [[-Servers] <string[]>] -Uuid <Object> [-Count
<int>] [-FilterCriteria <Object>] [-SearchString <Object>]
[-SearchAttributeList <Object>] [-Projection <Object>] [-ExpandedOutput]
> Get-NTNXFileServerShares [-Uuid <Object>] [-Count <int>] [-FilterCriteria

<Object>] [-SearchString <Object>] [-SearchAttributeList <Object>]
> Get-NTNXFileServerShares [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Count
FilterCriteria
Filter criteria
SearchString
Search string
SearchAttributeList
Projection
AOS | FileServerShares | 587

102
AOS | FileServerUser | 588

FILESERVERUSER
Operations
• Add new user: Add-NTNXFileServerUser

• Delete FileServer User: Remove-NTNXFileServerUser
• Update User: Update-NTNXFileServerUser
Delete FileServer User

> Remove-NTNXFileServerUser [[-Servers] <string[]>] -Uuid <Object> -User
> Remove-NTNXFileServerUser [-Uuid <Object>] [-User <Object>] [-Template]

> Remove-NTNXFileServerUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that user is associated with
User
Name of the user
Optional arguments
Template
Update User
> Update-NTNXFileServerUser [[-Servers] <string[]>] -Uuid <Object> [-Username
<string>] [-Password <string>] [-Role
<UpdateFileServerUser+FileServerUserRole_Enum>] [-FileServerUuid <string>]
[-Roles <string[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXFileServerUser [-Uuid <Object>] [-Username <string>] [-Password

<string>] [-Role <UpdateFileServerUser+FileServerUserRole_Enum>]
[-FileServerUuid <string>] [-Roles <string[]>] [-Template] [-ExpandedOutput]
> Update-NTNXFileServerUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
AOS | FileServerUser | 589

Optional arguments
Username
File server user name.
Password
The password for the above file server user.
Role
FileServerUuid
Roles
Template
Add new user

> Add-NTNXFileServerUser [[-Servers] <string[]>] -Uuid <Object> -Username
<string> -Password <string> [-Role
<AddFileServerUser+FileServerUserRole_Enum>] [-FileServerUuid <string>]
[-Roles <string[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXFileServerUser [-Uuid <Object>] [-Username <string>] [-Password

<string>] [-Role <AddFileServerUser+FileServerUserRole_Enum>] [-FileServerUuid
<string>] [-Roles <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXFileServerUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Username
File server user name.
Password
The password for the above file server user.
Optional arguments
Role
FileServerUuid
Roles
Template
103
AOS | FileServerUsers | 591

FILESERVERUSERS
Operations
• Get the list of users: Get-NTNXFileServerUsers
Get the list of users associated with a file server

> Get-NTNXFileServerUsers [[-Servers] <string[]>] -Uuid <Object>
> Get-NTNXFileServerUsers [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXFileServerUsers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
104
AOS | FileServers | 593

FILESERVERS
Operations
• Get FileServers based on passed criteria: Get-NTNXFileServers

• Upgrade given list of file servers: Upgrade-NTNXFileServers
Upgrade given list of file servers

> Upgrade-NTNXFileServers [[-Servers] <string[]>] -InputList
<Dictionary[string,string][]> [-SkipCompatibilityCheck <bool>]
> Upgrade-NTNXFileServers [-SkipCompatibilityCheck <bool>] [-InputList

<Dictionary[string,string][]>] [-Template] [-ExpandedOutput] [-GridView]
> Upgrade-NTNXFileServers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
InputList
Optional arguments
SkipCompatibilityCheck
Skip NOS compatibility check
Template
Get a collection of FileServers which are optionally filtered by the passed criteria
> Get-NTNXFileServers [[-Servers] <string[]>] [-Count <int>] [-FilterCriteria
<Object>] [-SearchString <Object>] [-Projection <Object>] [-ExpandedOutput]
> Get-NTNXFileServers [-Count <int>] [-FilterCriteria <Object>] [-SearchString

> Get-NTNXFileServers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Count

FilterCriteria
Filter criteria
SearchString
Search string
Projection

105
AOS | FileServersUsage | 596

FILESERVERSUSAGE
Operations
• Get the file servers usage: Get-NTNXFileServersUsage
Get the usage associated with all the file servers

Required arguments
None
AOS | FileServersUsage | 597

106

FILESERVERSHARE
Operations
• Delete File Server Share: Remove-NTNXFileServershare

> Remove-NTNXFileServershare [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> [-Force <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXFileServershare [-Uuid <Object>] [-ShareUuid <Object>] [-Force

> Remove-NTNXFileServershare [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
Optional arguments
Force
force delete Share
Template

107
AOS | FileShare | 600

FILESHARE
Operations
• Get the Share: Get-NTNXFileShare
Get the Share with the specified uuid

> Get-NTNXFileShare [[-Servers] <string[]>] -Uuid <Object> -ShareUuid <Object>
> Get-NTNXFileShare [-Uuid <Object>] [-ShareUuid <Object>] [-Projection

> Get-NTNXFileShare [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
ShareUuid
Optional arguments
Projection
AOS | FileShare | 601

108

FILESERVER
Operations
• Activate File Server: Activate-NTNXFileserver

• Clone File Server: Clone-NTNXFileserver
• LoadBalance File Server: Loadbalance-NTNXFileserver
• Protect File Server: Protect-NTNXFileserver
Activate File server

Required arguments
Uuid
NtpServers
Optional arguments
Uuid
ContainerId
ContainerUuid
Name
NumCalculatedNvms
MemoryGiB
NumVcpus
DnsDomainName
name.
and ESX.
InternalNetwork

and ESX.
ExternalNetworks
WindowsAdDomainName
WindowsAdUsername
WindowsAdPassword
SizeGib
OrganizationalUnit
domain operation.
PdName
AddUserAsFsAdmin
SnapshotUuid
NameServicesDTO
FsDnsOperationsDTO
GetPrincipalTypeDTO
Template
Clone File server

Required arguments
Uuid

NtpServers
Optional arguments
Uuid
ContainerId
ContainerUuid
Name
NumCalculatedNvms
MemoryGiB
NumVcpus
DnsDomainName
name.
and ESX.
InternalNetwork
and ESX.
ExternalNetworks
WindowsAdDomainName
WindowsAdUsername
WindowsAdPassword
SizeGib
OrganizationalUnit

domain operation.
PdName
AddUserAsFsAdmin
SnapshotUuid
NameServicesDTO
FsDnsOperationsDTO
GetPrincipalTypeDTO
Template
Protect File server

Required arguments
Uuid
Optional arguments
PdName
pd name
Template
LoadBalance File server

Required arguments
Uuid
Optional arguments
Uuid
Name
DnsDomainName
MemoryGiB
NumVcpus

NtpServers
InternalNetwork
ExternalNetworks
NumCalculatedNvms
RecommendedAction
SizeGib
ForceNetworkChange
Template

109
AOS | FileserverSnapshot | 608

FILESERVERSNAPSHOT
Operations
• Get a file server share snapshot: Get-NTNXFileserverSnapshot
Get a snapshot associated with a file server share

> Get-NTNXFileserverSnapshot [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -SnapshotUuid <Object> [-ExpandedOutput] [-GridView]
> Get-NTNXFileserverSnapshot [-Uuid <Object>] [-ShareUuid <Object>]

[-SnapshotUuid <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXFileserverSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
uuid of the file server share
SnapshotUuid
uuid of the file server share snapshot
AOS | FileserverSnapshot | 609

110
AOS | FileserverSnapshots | 610

FILESERVERSNAPSHOTS
Operations
• Get the list of snapshots: List-NTNXFileserverSnapshots
Get the list of snapshots associated with a file server share

> List-NTNXFileserverSnapshots [[-Servers] <string[]>] -Uuid <Object>
-ShareUuid <Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> List-NTNXFileserverSnapshots [-Uuid <Object>] [-ShareUuid <Object>]

> List-NTNXFileserverSnapshots [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
AOS | FileserverSnapshots | 611

111
AOS | FsShareStat | 612

FSSHARESTAT
Operations
• Get the stats for a specified share: Get-NTNXFsShareStat
> Get-NTNXFsShareStat [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
<Object> -Metrics <Object> [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]
[-IntervalInSecs <int>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXFsShareStat [-Uuid <Object>] [-ShareUuid <Object>] [-Metrics

<Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-IntervalInSecs
> Get-NTNXFsShareStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
ShareUuid
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | FsShareStat | 613

112
AOS | GuestTool | 614

GUESTTOOL
Operations
• Unmount Nutanix Guest Tools: Dismount-NTNXGuestTool

• Get Nutanix Guest Tools: Get-NTNXGuestTool
• Mount Nutanix Guest Tools: Mount-NTNXGuestTool
• Create Nutanix Guest Tools: Set-NTNXGuestTool
• Update Nutanix Guest Tools: Update-NTNXGuestTool
Get Nutanix Guest Tools for given VM

> Get-NTNXGuestTool [[-Servers] <string[]>] -VmId <Object> [-ExpandedOutput]
> Get-NTNXGuestTool [-VmId <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXGuestTool [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of Virtual machine
Unmount Nutanix Guest Tools

> Dismount-NTNXGuestTool [[-Servers] <string[]>] -VmId <Object>
> Dismount-NTNXGuestTool [-VmId <Object>] [-Template] [-ExpandedOutput]

> Dismount-NTNXGuestTool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
VmId
Optional arguments
Template

> Update-NTNXGuestTool [[-Servers] <string[]>] -VmId <Object> [-Enabled
<bool>] [-Applications <Object>] [-Operation <string>] [-GenericDTO <string>]

> Update-NTNXGuestTool [-VmId <Object>] [-Enabled <bool>] [-Applications

<Object>] [-Operation <string>] [-GenericDTO <string>] [-ClusterUuid <string>]
> Update-NTNXGuestTool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
VmId
Optional arguments
VmUuid
UUID of the Virtual Machine.
Enabled
Nutanix Guest Tools are enabled or not.
Applications
Map of application names and is it enabled.
Operation
GenericDTO
ClusterUuid
Template
Mount Nutanix Guest Tools

> Mount-NTNXGuestTool [[-Servers] <string[]>] -VmId <Object> [-ExpandedOutput]
> Mount-NTNXGuestTool [-VmId <Object>] [-Template] [-ExpandedOutput]

> Mount-NTNXGuestTool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
VmId
Optional arguments
Template

Create Nutanix Guest Tools
> Set-NTNXGuestTool [[-Servers] <string[]>] -VmId <Object> [-Enabled <bool>]
[-Applications <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXGuestTool [-VmId <Object>] [-Enabled <bool>] [-Applications

<Object>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXGuestTool [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Optional arguments
VmUuid
UUID of the Virtual Machine.
Enabled
Nutanix Guest Tools are enabled or not.
Applications
Map of application names and is it enabled.
Template

113
AOS | HA | 618

HA
Operations
• Get current HA configuration: Get-NTNXHA

• Enable, disable or modify HA configuration: Update-NTNXHA
> Get-NTNXHA [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]

> Get-NTNXHA [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
> Update-NTNXHA [[-Servers] <string[]>] [-NumHostFailuresToTolerate <long>]

[-EvacuationOption <UpdateHA+VmEvacuationOption_Enum>] [-EnableFailover
<bool>] [-ReservationType <UpdateHA+HaReservationType_Enum>]
[-LogicalTimestamp <long>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXHA [-NumHostFailuresToTolerate <long>] [-EvacuationOption

<UpdateHA+VmEvacuationOption_Enum>] [-EnableFailover <bool>] [-ReservationType
<UpdateHA+HaReservationType_Enum>] [-LogicalTimestamp <long>] [-Template]
> Update-NTNXHA [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
NumHostFailuresToTolerate
Number of host failures tolerated.
EvacuationOption
Indicates the action we take to evacuate VMs powered on the host.
EnableFailover
Whether HA should be invoked upon host failure.
ReservationType
Type of HA reservation (segments or hosts).
LogicalTimestamp
Logical timestamp for HA configuration.
AOS | HA | 619

Template
114
AOS | HardwareAlert | 621

HARDWAREALERT
Operations
• Get the list of hardware Alerts: Get-NTNXHardwareAlert
Get the list of hardware Alerts generated in the cluster

> Get-NTNXHardwareAlert [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
<Object>] [-AlertTypeUuid <Object>] [-Page <int>] [-ExpandedOutput]
> Get-NTNXHardwareAlert [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

> Get-NTNXHardwareAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
115
AOS | HardwareEvent | 623

HARDWAREEVENT
Operations
• Get the list of hardware Events: Get-NTNXHardwareEvent
Get the list of hardware Events generated in the cluster

> Get-NTNXHardwareEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
> Get-NTNXHardwareEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Count <int>] [-Acknowledged] [-Page <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXHardwareEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
116
AOS | HealthCheck | 625

HEALTHCHECK
Operations
• Get the list of Health Checks: Get-NTNXHealthCheck

• Modify Health Check details: Set-NTNXHealthCheck
Modify the specified health check details

> Set-NTNXHealthCheck [[-Servers] <string[]>] [-Id <string>] [-PolicyUuid
<string>] [-Name <string>] [-Description <string>] [-ApplicableForMultiCluster
<bool>] [-ApplicableForSingleCluster <bool>] [-Enabled <bool>] [-AutoResolve
<SetHealthCheck+AutoResolve_Enum>] [-IsUserDefined <bool>] [-CheckType
<SetHealthCheck+CheckType_Enum>] [-ScheduleIntervalInSecs <int>]
[-AffectedEntityTypes <string[]>] [-CategoryTypes <string[]>]
[-SubCategoryTypes <string[]>] [-Impacts <string[]>] [-Scope <string>]
[-Parameters <Object>] [-Metrics <HealthCheckMetricDTO[]>] [-KbList
<string[]>] [-Causes <string[]>] [-Resolutions <string[]>]
[-ModifiedTimeStampInUsecs <long>] [-ModifiedByUsername <string>]
[-AlertTypeId <string>] [-IsGlobalConfig <bool>] [-Message <string>]
[-SeverityThresholdInfos <SeverityThresholdInfoDTO[]>]
[-AlertConfigurableParameters <AlertConfigParamDTO[]>] [-Operation <string>]
[-GenericDTO <string>] [-ClusterUuid <string>] [-ExpandedOutput] [-GridView]
> Set-NTNXHealthCheck [-Id <string>] [-PolicyUuid <string>] [-Name <string>]

[-Description <string>] [-ApplicableForMultiCluster <bool>]
[-ApplicableForSingleCluster <bool>] [-Enabled <bool>] [-AutoResolve
<SetHealthCheck+AutoResolve_Enum>] [-IsUserDefined <bool>] [-CheckType
<SetHealthCheck+CheckType_Enum>] [-ScheduleIntervalInSecs <int>]
[-AffectedEntityTypes <string[]>] [-CategoryTypes <string[]>]
[-SubCategoryTypes <string[]>] [-Impacts <string[]>] [-Scope <string>]
[-Parameters <Object>] [-Metrics <HealthCheckMetricDTO[]>] [-KbList
<string[]>] [-Causes <string[]>] [-Resolutions <string[]>]
[-ModifiedTimeStampInUsecs <long>] [-ModifiedByUsername <string>]
[-AlertTypeId <string>] [-IsGlobalConfig <bool>] [-Message <string>]
[-SeverityThresholdInfos <SeverityThresholdInfoDTO[]>]
[-AlertConfigurableParameters <AlertConfigParamDTO[]>] [-Operation <string>]
[-GenericDTO <string>] [-ClusterUuid <string>] [-Template] [-ExpandedOutput]
> Set-NTNXHealthCheck [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Id
Id of a health check.
PolicyUuid
Policy Uuid of the health check. Will be set only for user defined policies.

Name
Name of a health check.
Description
Description of a health check.
ApplicableForMultiCluster
Whether the check is applicable for Prism Central or not.
ApplicableForSingleCluster
Whether the check is applicable for Prism Element or not.
Enabled
Whether health check is enabled.
AutoResolve
Auto Resolve status for this check.
IsUserDefined
Whether the health check is user defined or not.
CheckType
Whether the health check is scheduled or event driven.
ScheduleIntervalInSecs
Interval between checks in seconds.
AffectedEntityTypes
Affected entity types.
CategoryTypes
Category types of affected entities.
SubCategoryTypes
Sub category of affected entities.
Impacts
Impacts.
ImpactTypes
Impact type on affected entities.
Classifications
Classification of the Health Check. Ex: DR, Hardware, etc
Scope
Scope of health check.
Parameters
Parameters.
Metrics
Metrics.
KbList
List of kb article numbers.
Causes
Causes.
Resolutions
Resolutions.

ModifiedTimeStampInUsecs
ModifiedByUsername
AlertTypeId
Id of an alert type.
IsGlobalConfig
Whether the check is a default one or not
Message
Message for an alert type.
SeverityThresholdInfos
Enable/Disable info for each Severity.
AlertConfigurableParameters
Configurable Parameters for the Alert Type.
Operation
GenericDTO
ClusterUuid
Template
Get the list of Health Checks configured in the cluster

> Get-NTNXHealthCheck [[-Servers] <string[]>] [-CheckIds <Object>]
[-GlobalConfig] [-IncludeInternalChecks] [-CategoryTypes <Object>] [-Id
> Get-NTNXHealthCheck [-CheckIds <Object>] [-GlobalConfig]

[-IncludeInternalChecks] [-CategoryTypes <Object>] [-Id <Object>]
> Get-NTNXHealthCheck [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of the health check
Optional arguments
CheckIds
Check Ids
GlobalConfig
Whether to get the global config list or not.
IncludeInternalChecks
Whether to include internal checks or not.
CategoryTypes
Categories of the Health Check.
117
AOS | Host | 629

HOST
Operations
• Get the list of Physical Hosts: Get-NTNXHost
Get the list of Physical Hosts configured in the cluster

> Get-NTNXHost [[-Servers] <string[]>] [-Count <int>] [-FilterCriteria
<Object>] [-SortCriteria <Object>] [-SearchString <Object>]
[-SearchAttributeList <Object>] [-Page <int>] [-Projection <Object>] [-Id
> Get-NTNXHost [-Count <int>] [-FilterCriteria <Object>] [-SortCriteria

<Object>] [-SearchString <Object>] [-SearchAttributeList <Object>] [-Page
<int>] [-Projection <Object>] [-Id <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXHost [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Physical Host
Optional arguments
Count
Number of Physical Hosts to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
Projection
118
AOS | HostAlert | 631

HOSTALERT
Operations
• Get the list of alerts generated on any Host: Get-NTNXHostAlert
> Get-NTNXHostAlert [[-Servers] <string[]>] [-Id <Object>] [-StartTimeInUsecs

> Get-NTNXHostAlert [-Id <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs

> Get-NTNXHostAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Host
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
119
AOS | HostEvent | 633

HOSTEVENT
Operations
• Get the list of events generated on any Host: Get-NTNXHostEvent
> Get-NTNXHostEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-Id
> Get-NTNXHostEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Count <int>] [-Acknowledged] [-Page <int>] [-Id <Object>] [-ExpandedOutput]
> Get-NTNXHostEvent [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Host
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
120
AOS | HostHealthCheckSummary | 635

HOSTHEALTHCHECKSUMMARY
Operations
• Get the health check summary for Hosts: Get-NTNXHostHealthCheckSummary
> Get-NTNXHostHealthCheckSummary [[-Servers] <string[]>] [-FilterCriteria

> Get-NTNXHostHealthCheckSummary [-FilterCriteria <Object>] [-DetailedSummary]

> Get-NTNXHostHealthCheckSummary [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
FilterCriteria
Filter criteria
DetailedSummary
Detailed summary
121
AOS | HostStat | 637

HOSTSTAT
Operations
• Get the stats for a specified Physical Host: Get-NTNXHostStat
> Get-NTNXHostStat [[-Servers] <string[]>] -Id <Object> -Metrics <Object>
> Get-NTNXHostStat [-Id <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXHostStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Id of a Physical Host
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
122
AOS | HttpProxy | 639

HTTPPROXY
Operations
• Add an HTTP Proxy: Add-NTNXHttpProxy

• Get the list of HTTP Proxies: Get-NTNXHttpProxy
• Delete an HTTP Proxy: Remove-NTNXHttpProxy
• Modify an HTTP Proxy: Set-NTNXHttpProxy
Get the list of HTTP Proxies configured in the cluster

> Get-NTNXHttpProxy [[-Servers] <string[]>] [-Name <Object>] [-ExpandedOutput]
> Get-NTNXHttpProxy [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXHttpProxy [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of an HTTP Proxy
Add an HTTP Proxy to the cluster

> Add-NTNXHttpProxy [[-Servers] <string[]>] -Name <string> -Address <string>
-Port <int> [-Username <string>] [-Password <string>] [-ProxyTypes
<AddHttpProxy+ProxyType_Enum[]>] [-ExpandedOutput] [-GridView]
> Add-NTNXHttpProxy [-Name <string>] [-Address <string>] [-Port <int>]

[-Username <string>] [-Password <string>] [-ProxyTypes
<AddHttpProxy+ProxyType_Enum[]>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXHttpProxy [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Proxy name.
Address
Address of the proxy
Port
Port on which proxy is binding

Optional arguments
Username
Username for proxy authentication
Password
Password for proxy authentication
ProxyTypes
Proxy types to send applicable traffic
Template
Delete an HTTP Proxy with the specified name

> Remove-NTNXHttpProxy [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXHttpProxy [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXHttpProxy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of an HTTP Proxy
Optional arguments
Template
Modify the specified HTTP Proxy

> Set-NTNXHttpProxy [[-Servers] <string[]>] -Name <string> [-Address <string>]
[-Port <int>] [-Username <string>] [-Password <string>] [-ProxyTypes
<SetHttpProxy+ProxyType_Enum[]>] [-Operation <string>] [-GenericDTO <string>]
> Set-NTNXHttpProxy [-Name <string>] [-Address <string>] [-Port <int>]

[-Username <string>] [-Password <string>] [-ProxyTypes
<SetHttpProxy+ProxyType_Enum[]>] [-Operation <string>] [-GenericDTO <string>]
> Set-NTNXHttpProxy [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Proxy name.

Optional arguments
Address
Address of the proxy
Port
Port on which proxy is binding
Username
Username for proxy authentication
Password
Password for proxy authentication
ProxyTypes
Proxy types to send applicable traffic
Operation
GenericDTO
ClusterUuid
Template
123
AOS | HttpProxyWhitelist | 643

HTTPPROXYWHITELIST
Operations
• Get HTTP Proxy whitelist: Get-NTNXHttpProxyWhitelist
Get HTTP Proxy whitelist

> Get-NTNXHttpProxyWhitelist [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXHttpProxyWhitelist [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
124
AOS | IcapServer | 645

ICAPSERVER
Operations
• Get a icap server: Get-NTNXIcapServer

• Delete icap server: Remove-NTNXIcapServer
• Test Icap Server Connection: Test-NTNXIcapServer
• Update Icap Server: Update-NTNXIcapServer
Update Icap Server

> Update-NTNXIcapServer [[-Servers] <string[]>] -Uuid <Object>
-IcapServerUpdate_Uuid <string> [-Description <string>] [-Enable <bool>]
> Update-NTNXIcapServer [-Uuid <Object>] [-IcapServerUpdate_Uuid <string>]

[-Description <string>] [-Enable <bool>] [-Template] [-ExpandedOutput]
> Update-NTNXIcapServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that Icap is associated with
Uuid
Uuid of the antivirus server
Optional arguments
Description
Antivirus server description.
Enable
Enable or diable antivirus server.
Template
Get a single icap server associated with a file server

> Get-NTNXIcapServer [[-Servers] <string[]>] -Uuid <Object> -IcapServerUuid
> Get-NTNXIcapServer [-Uuid <Object>] [-IcapServerUuid <Object>]

> Get-NTNXIcapServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]


Required arguments
Uuid
IcapServerUuid
uuid of the icap server
Delete Icap Server

> Remove-NTNXIcapServer [[-Servers] <string[]>] -Uuid <Object> -IcapServerUuid
> Remove-NTNXIcapServer [-Uuid <Object>] [-IcapServerUuid <Object>]

> Remove-NTNXIcapServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that icap is associated with
IcapServerUuid
Optional arguments
Template
Test Icap Server Connection

> Test-NTNXIcapServer [[-Servers] <string[]>] -Uuid <Object> -IcapServerUuid
> Test-NTNXIcapServer [-Uuid <Object>] [-IcapServerUuid <Object>] [-Template]

> Test-NTNXIcapServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that icap server is associated with
IcapServerUuid
Optional arguments
Template

125
AOS | IcapServerStats | 648

ICAPSERVERSTATS
Operations
• Get the stats for a specified Icap server: Get-NTNXIcapServerStats
> Get-NTNXIcapServerStats [[-Servers] <string[]>] -Uuid <Object>
-IcapServerUuid <Object> -Metrics <Object> [-StartTimeInUsecs <long>]
[-EndTimeInUsecs <long>] [-IntervalInSecs <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXIcapServerStats [-Uuid <Object>] [-IcapServerUuid <Object>]

[-Metrics <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]
> Get-NTNXIcapServerStats [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
IcapServerUuid
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | IcapServerStats | 649

126
AOS | IcapServers | 650

ICAPSERVERS
Operations
• Add new icap server: Add-NTNXIcapServers

• Get the list of icap servers: Get-NTNXIcapServers
Get the list of icap servers associated with a file server

> Get-NTNXIcapServers [[-Servers] <string[]>] -Uuid <Object> [-ExpandedOutput]
> Get-NTNXIcapServers [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXIcapServers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Add new icap server

> Add-NTNXIcapServers [[-Servers] <string[]>] -Uuid <Object> -IpAddress
<string> -PortNumber <string> [-IcapServerAdd_Uuid <string>] [-Description
> Add-NTNXIcapServers [-Uuid <Object>] [-IcapServerAdd_Uuid <string>]

[-IpAddress <string>] [-PortNumber <string>] [-Description <string>]
> Add-NTNXIcapServers [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that icap server is associated with
IpAddress
Antivirus server ip address.
PortNumber
Antivirus server port number.
Optional arguments
Uuid
Description
Antivirus server description.
AOS | IcapServers | 651

Template
127
AOS | Image | 653

IMAGE
Operations
• Get the list of Disk Images: Get-NTNXImage

• Create a Disk Image: New-NTNXImage
• Delete a Disk Image: Remove-NTNXImage
• Update a Disk Image: Set-NTNXImage
Get the list of Images

> Get-NTNXImage [[-Servers] <string[]>] [-ImageId <Object>]
[-IncludeVmDiskSizes] [-IncludeVmDiskPaths] [-ExpandedOutput] [-GridView]
> Get-NTNXImage [-ImageId <Object>] [-IncludeVmDiskSizes]

[-IncludeVmDiskPaths] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXImage [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
ImageId
Id of the Image
Optional arguments
IncludeVmDiskSizes
Include VmDisk size
IncludeVmDiskPaths
Include VmDisk path
IncludeVmDiskSizes
Include VmDisk sizes
IncludeVMDiskPaths
Include VmDisk paths
Delete a Disk Image

This is an idempotent operation.The logical timestamp can optionally be provided for
consistency. If a logical timestamp is specified, then this operation will be rejected if the logical
timestamp specified is not the value of the Image logical timestamp. The logical timestamp can
be obtained from the Image Info object. This is also an asynchronous operation that results in
the creation of a task object. The UUID of this task object is returned as the response of this
operation. This task can be monitored by using the /tasks/poll API.
> Remove-NTNXImage [[-Servers] <string[]>] -ImageId <Object>
[-Logicaltimestamp <long>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXImage [-ImageId <Object>] [-Logicaltimestamp <long>] [-Template]

AOS | Image | 654

> Remove-NTNXImage [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]
Required arguments
ImageId
Id of the Image
Optional arguments
Logicaltimestamp
Logical timestamp for synchronized delete
Template
Create a Image with specified configuration

There are two modes of creation, one mode you either provide some source (URL, vmdisk,
or uploaded file) or you just create the metadata for the image. If a UUID is specified for the
Image, this operation will be idempotent. This is an asynchronous operation that results in
the creation of a task object. The UUID of this task object is returned as the response of this
> New-NTNXImage [[-Servers] <string[]>] [-Name <string>] [-Uuid <string>]
[-Annotation <string>] [-ImageType <NewImage+ImageType_Enum>]
[-ImageImportSpec <ImageImportSpecDTO>] [-VmDiskClone <VMDiskSpecCloneDTO>]
> New-NTNXImage [-Name <string>] [-Uuid <string>] [-Annotation <string>]

[-ImageType <NewImage+ImageType_Enum>] [-ImageImportSpec <ImageImportSpecDTO>]
[-VmDiskClone <VMDiskSpecCloneDTO>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXImage [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
The Image's human readable name.
Uuid
A version 4 UUID that the client may specify for idempotence.
Annotation
A string describing the Image.
ImageType
The Image type specifies whether its a Disk image or ISO image. Possible values
are "disk_image" and "iso_image".
AOS | Image | 655

ImageImportSpec
The spec for the imported image. Either this or the VMDiskSpecCloneDTO needs
to be specified
VmDiskClone
The spec for the VMDisk to be cloned. Either this or the ImageImportSpecDTO
needs to be specified
VmDiskCloneSpec
Template
Update a Disk Image

Fields that are not set or are not specified are ignored.If an Image is already in ACTIVE state
then its source can't be updated. But you can still update the image name, image type and
image annotation.If a logical timestamp is specified, then this operation will be rejected if
the logical timestamp specified is not the value of the Image logical timestamp. The logical
timestamp can be obtained from the Image object.
> Set-NTNXImage [[-Servers] <string[]>] -ImageId <Object> [-LogicalTimestamp
<long>] [-Name <string>] [-Annotation <string>] [-ImageType
<SetImage+ImageType_Enum>] [-ImageImportSpec <ImageImportSpecDTO>]
[-VmDiskClone <VMDiskSpecCloneDTO>] [-ExpandedOutput] [-GridView]
> Set-NTNXImage [-ImageId <Object>] [-LogicalTimestamp <long>] [-Name

<string>] [-Annotation <string>] [-ImageType <SetImage+ImageType_Enum>]
[-ImageImportSpec <ImageImportSpecDTO>] [-VmDiskClone <VMDiskSpecCloneDTO>]
> Set-NTNXImage [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
ImageId
Id of the Disk Image
Optional arguments
LogicalTimestamp
Logical timestamp specified for consistency. This can be obtained from the
Image Info object.
Name
The Image's human readable name.
Annotation
A string describing the Image.
ImageType
The Image type specifies whether its a Disk image or ISO image. Possible values
are "disk_image" and "iso_image".
AOS | Image | 656

ImageImportSpec
The spec for the imported image. Either this or the VMDiskSpecCloneDTO needs
to be specified
VmDiskClone
VmDiskCloneSpec
Template
AOS | Image | 657

128
AOS | InfectedFile | 658

INFECTEDFILE
Operations
• Get infected file: Get-NTNXInfectedFile
Get infected file associated with a file server

> Get-NTNXInfectedFile [[-Servers] <string[]>] -Uuid <Object>
-InfectedFileUuid <Object> [-Quarantined] [-ExpandedOutput] [-GridView]
> Get-NTNXInfectedFile [-Uuid <Object>] [-InfectedFileUuid <Object>]

[-Quarantined] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXInfectedFile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuid
uuid of the infected file
Optional arguments
Quarantined
Quarantined
AOS | InfectedFile | 659

129
AOS | InfectedFiles | 660

INFECTEDFILES
Operations
• Delete list of infected files: Delete-NTNXInfectedFiles

• Get the list of infected files: Get-NTNXInfectedFiles
• Quarantine list of infected files: Quarantine-NTNXInfectedFiles
• Rescan list of infected files: Rescan-NTNXInfectedFiles
• Reset list of infected files: Reset-NTNXInfectedFiles
• Unquarantine list of infected files: Unquarantine-NTNXInfectedFiles
Get the list of infected files associated with a file server

> Get-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object> -Quarantined
[-ShareUuid <Object>] [-Count <long>] [-Page <long>] [-FilterCriteria
<Object>] [-SearchString <Object>] [-Projection <Object>] [-ExpandedOutput]
> Get-NTNXInfectedFiles [-Uuid <Object>] [-ShareUuid <Object>] [-Quarantined]

[-Count <long>] [-Page <long>] [-FilterCriteria <Object>] [-SearchString
> Get-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Quarantined
Quarantined
Optional arguments
ShareUuid
Uuid of the share
Count
Number of infected files to retrieve
Page
Page number
FilterCriteria
Filter criteria
SearchString
Search string
Projection

Reset infected files associated with a file server
> Reset-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
-InfectedFileUuids <string[]> [-InfectedFileOps_Uuid <string>]
> Reset-NTNXInfectedFiles [-Uuid <Object>] [-InfectedFileOps_Uuid <string>]

[-InfectedFileUuids <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> Reset-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuids
Comma-separated list of infected file uuids
Optional arguments
Uuid
Template
Rescan infected files associated with a file server

> Rescan-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
> Rescan-NTNXInfectedFiles [-Uuid <Object>] [-InfectedFileOps_Uuid <string>]

> Rescan-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuids
Optional arguments
Uuid
Template

Quarantine infected files associated with a file server
> Quarantine-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
> Quarantine-NTNXInfectedFiles [-Uuid <Object>] [-InfectedFileOps_Uuid

<string>] [-InfectedFileUuids <string[]>] [-Template] [-ExpandedOutput]
> Quarantine-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuids
Optional arguments
Uuid
Template
Unquarantine infected files associated with a file server

> Unquarantine-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
> Unquarantine-NTNXInfectedFiles [-Uuid <Object>] [-InfectedFileOps_Uuid

<string>] [-InfectedFileUuids <string[]>] [-Template] [-ExpandedOutput]
> Unquarantine-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuids
Optional arguments
Uuid
Template

Delete infected files associated with a file server
> Delete-NTNXInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
> Delete-NTNXInfectedFiles [-Uuid <Object>] [-InfectedFileOps_Uuid <string>]

> Delete-NTNXInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuids
Optional arguments
Uuid
Template
130
AOS | KeyManagementServer | 665

KEYMANAGEMENTSERVER
Operations
• Add a Key Management Server: Add-NTNXKeyManagementServer

• Get all Key Management Servers: Get-NTNXKeyManagementServer
• Delete the KeyManagementServer: Remove-NTNXKeyManagementServer
• Modify the KeyManagementServer: Update-NTNXKeyManagementServer
Modify the KeyManagementServer configuration

> Update-NTNXKeyManagementServer [[-Servers] <string[]>] [-Uuid <string>]
[-Name <string>] [-IpAddressPortMap <Object>] [-Active <bool>] [-Operation
<string>] [-GenericDTO <string>] [-ClusterUuid <string>] [-ExpandedOutput]
> Update-NTNXKeyManagementServer [-Uuid <string>] [-Name <string>]

[-IpAddressPortMap <Object>] [-Active <bool>] [-Operation <string>]
> Update-NTNXKeyManagementServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Uuid
Name
IpAddressPortMap
Active
Operation
GenericDTO
ClusterUuid
Template
Add a Key Management Server to the cluster

> Add-NTNXKeyManagementServer [[-Servers] <string[]>] [-Uuid <string>] [-Name
<string>] [-IpAddressPortMap <Object>] [-Active <bool>] [-ExpandedOutput]
> Add-NTNXKeyManagementServer [-Uuid <string>] [-Name <string>]

[-IpAddressPortMap <Object>] [-Active <bool>] [-Template] [-ExpandedOutput]
> Add-NTNXKeyManagementServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Uuid
Name
IpAddressPortMap
Active
Template
Get all Key Management Servers from cluster

> Get-NTNXKeyManagementServer [[-Servers] <string[]>] [-Name <Object>]
> Get-NTNXKeyManagementServer [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXKeyManagementServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the Key Management Server
Delete a KeyManagementServer with the specified name

> Remove-NTNXKeyManagementServer [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXKeyManagementServer [-Name <Object>] [-Template]

> Remove-NTNXKeyManagementServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the Key Management Server

Optional arguments
Template
131
AOS | KeyManagementServerType | 669

KEYMANAGEMENTSERVERTYPE
Operations
• Get Key Management Server Type: Get-NTNXKeyManagementServerType

• Select Key Management Server Type: Select-NTNXKeyManagementServerType
Select Key Management Server Type to be LKM or EKM

> Select-NTNXKeyManagementServerType [[-Servers] <string[]>] [-KmsType
<SelectKeyManagementServerType+KMSType_Enum>] [-ExpandedOutput] [-GridView]
> Select-NTNXKeyManagementServerType [-KmsType

<SelectKeyManagementServerType+KMSType_Enum>] [-Template] [-ExpandedOutput]
> Select-NTNXKeyManagementServerType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
KmsType
Template
Get Key Management Server Type

> Get-NTNXKeyManagementServerType [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXKeyManagementServerType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
132
AOS | LDAPConnection | 671

LDAPCONNECTION
Operations
• Test LDAP directory connection status: Test-NTNXLDAPConnection
> Test-NTNXLDAPConnection [[-Servers] <string[]>] -DirectoryName <string>

-Password <string> -Username <string> [-ExpandedOutput] [-GridView]
> Test-NTNXLDAPConnection [-DirectoryName <string>] [-Password <string>]

[-Username <string>] [-Template] [-ExpandedOutput] [-GridView]
> Test-NTNXLDAPConnection [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
DirectoryName
Directory name to test LDAP configuration.
Password
Password to test LDAP configuration.
Username
Username to test LDAP configuration.
Optional arguments
Template
133
AOS | License | 673

LICENSE
Operations
• Show current license file: Get-NTNXLicense
Show current license file from the cluster

> Get-NTNXLicense [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXLicense [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
134
AOS | LicenseAlert | 675

LICENSEALERT
Operations
• Get the list of alerts generated for any License: Get-NTNXLicenseAlert
> Get-NTNXLicenseAlert [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

> Get-NTNXLicenseAlert [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

> Get-NTNXLicenseAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
135
AOS | LicenseAllowance | 677

LICENSEALLOWANCE
Operations
• Show allowances for all features: Get-NTNXLicenseAllowance
Show allowances for all features

> Get-NTNXLicenseAllowance [[-Servers] <string[]>] [-FeatureName <Object>]
> Get-NTNXLicenseAllowance [-FeatureName <Object>] [-ExpandedOutput]

> Get-NTNXLicenseAllowance [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
FeatureName
Feature name
136
AOS | LicenseEvent | 679

LICENSEEVENT
Operations
• Get the list of events generated for any License: Get-NTNXLicenseEvent
> Get-NTNXLicenseEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

> Get-NTNXLicenseEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

> Get-NTNXLicenseEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
137
AOS | MaintenanceMode | 681

MAINTENANCEMODE
Operations
• Put a host in maintenance mode: Start-NTNXMaintenanceMode

• Pull a host out of maintenance mode or abort a prior attempt: Stop-NTNXMaintenanceMode
Put a host in maintenance mode

It can be specified if Virtual Machines currently running on the host need to be powered off, live
migrated or cold migrated. The host will be marked as unschedulable, so that no new Virtual
Machines can be instantiated on it. Subsequently, an attempt is made to evacuate VMs from
the host. If the evacuation attempt fails (e.g., because there are insufficient resources available
elsewhere in the cluster), the host will remain in the entering maintenance mode state, where
it is marked unschedulable, waiting for user remediation. This operation is idempotent and
can be run again with different options like powering off the Virtual Machines, live or cold
migrating them. This is also an asynchronous operation that results in the creation of a task
object. The UUID of this task object is returned as the response of this operation. This task can
be monitored by using the /tasks/poll API.
> Start-NTNXMaintenanceMode [[-Servers] <string[]>] -Hostid <Object>
[-EvacuationOption <StartMaintenanceMode+VmEvacuationOption_Enum>]
[-LogicalTimestamp <long>] [-NonMigratableVmOption
<StartMaintenanceMode+VmNonMigratableOption_Enum>] [-ExpandedOutput]
> Start-NTNXMaintenanceMode [-Hostid <Object>] [-EvacuationOption

<StartMaintenanceMode+VmEvacuationOption_Enum>] [-LogicalTimestamp <long>]
[-NonMigratableVmOption <StartMaintenanceMode+VmNonMigratableOption_Enum>]
> Start-NTNXMaintenanceMode [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Hostid
UUID of host to put in maintenance mode
Optional arguments
EvacuationOption
Indicates the action we take to evacuate Virtual Machines powered on the host.
Virtual Machines can be either powered off, live migrated or cold migrated.
LogicalTimestamp
Logical timestamp that may be provided for consistency. This is an optional field.
The current value for the logical timestamp can be obtained from the host object.
NonMigratableVmOption
Indicates the action to take for non migratable VMs.Non migratable VMs like ones
with GPUs assigned can choose to be ACPI powered off or fail the maintenance
mode.

Template
Pull a host out of maintenance mode or abort a prior attempt to enter maintenance mode
even if the attempt is ongoing
This is an idempotent operation. If the host is no longer in maintenance mode, this command
has no effect. This is an asynchronous operation that results in the creation of a task object.
The UUID of this task object is returned as the response of this operation. This task can be
monitored by using the /tasks/poll API. If a logical timestamp is specified, then this operation
will be rejected if the logical timestamp specified is not the value of the host logical timestamp.
The logical timestamp can be obtained from the host object.
> Stop-NTNXMaintenanceMode [[-Servers] <string[]>] -Hostid <Object>
> Stop-NTNXMaintenanceMode [-Hostid <Object>] [-LogicalTimestamp <long>]

> Stop-NTNXMaintenanceMode [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Hostid
UUID of host to pull out of maintenance mode
Optional arguments
LogicalTimestamp
Logical timestamp that may be provided for consistency.
Template

138
AOS | MultiClusterAlert | 684

MULTICLUSTERALERT
Operations
• Get the list of alerts generated on any Cluster: Get-NTNXMultiClusterAlert
> Get-NTNXMultiClusterAlert [[-Servers] <string[]>] [-Id <Object>]

[-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-Count <int>] [-Resolved]
> Get-NTNXMultiClusterAlert [-Id <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXMultiClusterAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Cluster
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
AOS | MultiClusterAlert | 685

139
AOS | MultiClusterEvent | 686

MULTICLUSTEREVENT
Operations
• Get the list of events generated on any Cluster: Get-NTNXMultiClusterEvent
> Get-NTNXMultiClusterEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-Id
> Get-NTNXMultiClusterEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs

<long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-Id <Object>]
> Get-NTNXMultiClusterEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Cluster
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
AOS | MultiClusterEvent | 687

140
AOS | MultiClusterStat | 688

MULTICLUSTERSTAT
Operations
• Get the stats for a specified Cluster: Get-NTNXMultiClusterStat
> Get-NTNXMultiClusterStat [[-Servers] <string[]>] -Id <Object> -Metrics
<Object> [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>] [-IntervalInSecs
> Get-NTNXMultiClusterStat [-Id <Object>] [-Metrics <Object>]

> Get-NTNXMultiClusterStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Cluster
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | MultiClusterStat | 689

141
AOS | NameServer | 690

NAMESERVER
Operations
• Add name server: Add-NTNXNameServer

• Get the list of Name Servers: Get-NTNXNameServer
• Delete the specified Name Server: Remove-NTNXNameServer
Get the list of Name Servers configured on the cluster

> Get-NTNXNameServer [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXNameServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Add the server to the name servers configured on the cluster

> Add-NTNXNameServer [[-Servers] <string[]>] -Arg0 <string> [-ExpandedOutput]
> Add-NTNXNameServer [-Arg0 <string>] [-Template] [-ExpandedOutput]

> Add-NTNXNameServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Arg0
Optional arguments
Template
Delete a Name Server with the specified name

> Remove-NTNXNameServer [[-Servers] <string[]>] -NameServer <Object>
> Remove-NTNXNameServer [-NameServer <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXNameServer [[-NutanixClusters] <NutanixCluster[]>]

AOS | NameServer | 691

Required arguments
NameServer
Name of a name server
Optional arguments
Template
142
AOS | NameServices | 693

NAMESERVICES
Operations
• Configure Name services: Configure-NTNXNameServices
Configure Name services

Required arguments
Uuid
Optional arguments
LdapDetails
AdDetails
LocalDetails
NvmOnly
FileServerUuid
Nfsv4Domain
NfsVersion
Template
143
AOS | Network | 695

NETWORK
Operations
• Get list of networks: Get-NTNXNetwork

• Create a network: New-NTNXNetwork
• Delete a network: Remove-NTNXNetwork
• Update a network: Set-NTNXNetwork
Update a network
The logical timestamp can optionally be provided for consistency. If a logical timestamp is
specified, then this operation will be rejected if the logical timestamp specified is not the value
of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual
network object.
> Set-NTNXNetwork [[-Servers] <string[]>] -Networkid <Object>
[-LogicalTimestamp <long>] [-VlanId <int>] [-IpConfig <IpConfigDTO>] [-Uuid
<string>] [-Name <string>] [-VswitchName <string>] [-Annotation <string>]
> Set-NTNXNetwork [-Networkid <Object>] [-LogicalTimestamp <long>] [-VlanId

<int>] [-IpConfig <IpConfigDTO>] [-Uuid <string>] [-Name <string>]
[-VswitchName <string>] [-Annotation <string>] [-Template] [-ExpandedOutput]
> Set-NTNXNetwork [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Networkid
Id of the network
Optional arguments
LogicalTimestamp
Logical timestamp of the network configuration that may may be provided for
consistency.
VlanId
VLAN ID of the bridged network.
IpConfig
For managed L3 networks, this is the IP configuration.
Uuid
The UUID of the network
Name
The name of the network
VswitchName
The name of the vswitch
AOS | Network | 696

Annotation
The annotation of the network
Template
Delete a network
A network cannot be deleted while Virtual Machines are still attached to it. The logical
timestamp can optionally be provided for consistency. If a logical timestamp is specified, then
this operation will be rejected if the logical timestamp specified is not the value of the virtual
network logical timestamp. The logical timestamp can be obtained from the virtual network
object.
> Remove-NTNXNetwork [[-Servers] <string[]>] -Networkid <Object>
[-Logicaltimestamp <long>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXNetwork [-Networkid <Object>] [-Logicaltimestamp <long>]

> Remove-NTNXNetwork [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Networkid
Id of the network
Optional arguments
Logicaltimestamp
Logical timestamp for synchronized delete
Template
Create a network with specified L2 and L3 configuration

Each VM network interface is bound to a virtual network (see POST /vms/nic_create/).
While a virtual network is in use by a VM, it cannot be modified or deleted. Currently, the only
supported L2 type is VLAN. Each virtual network is bound to a single VLAN, and trunking
VLANs to a virtual network is not supported. A virtual network on VLAN 66 would be named
'vlan.66'. Each virtual network maps to a hypervisor-specific default vswitch. On KVM, this
is 'br0'. To use a different vswitch (e.g., with different uplinks), you can append the vswitch
name to the network identifier. For example, 'vlan.66.br1'. This virtual switch should exists
on all hosts, and the physical switch ports for the vswitch uplinks are properly configured to
receive VLAN-tagged traffic. On hypervisors where it is supported, a virtual network may have
an IPv4 configuration. Such a network is a 'managed L3' network. A network without a IPv4
configuration is an 'unmanaged L3' network. A network must be configured as 'managed L3' or
'unmanaged L3' at creation time. It is not possible to convert one to the other. A particular L2
(i.e., a particular VLAN) may have at most one managed network defined at a time. To create
a managed network, the user specifies the 'ipConfig'. This consists of an IPv4 default gateway
address and subnet in CIDR notation. The user may optionally specify a DHCP server address,
to avoid conflict with other services on the network. By default, the last available host address
in the subnet is used. Every virtual NIC on a managed network must be assigned an IPv4
AOS | Network | 697

address at NIC creation time. All DHCP traffic on the network will be rerouted to an internal
DHCP server, who hands out configured IPv4 addresses. DHCP traffic on the physical network
will not reach the virtual network, and vice versa. A managed network may have zero or more
non-overlapping DHCP pools. Each pool must be entirely contained within the network's
managed subnet. In the absence of a DHCP pool, the user must specify an IPv4 address when
creating a virtual network adapter (see POST /vms/nic_create). If the managed network has
a DHCP pool, the user need not provide an address; the NIC will automatically be assigned an
IPv4 address from one of the pools at creation time, provided at least one address is available.
Addresses in the DHCP pool are not reserved. That is, a user may manually specify an address
belonging to the pool when creating a virtual adapter.
> New-NTNXNetwork [[-Servers] <string[]>] -VlanId <int> [-LogicalTimestamp
<long>] [-IpConfig <IpConfigDTO>] [-Uuid <string>] [-Name <string>]
[-VswitchName <string>] [-Annotation <string>] [-ExpandedOutput] [-GridView]
> New-NTNXNetwork [-LogicalTimestamp <long>] [-VlanId <int>] [-IpConfig

<IpConfigDTO>] [-Uuid <string>] [-Name <string>] [-VswitchName <string>]
[-Annotation <string>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXNetwork [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VlanId
VLAN ID of the bridged network.
Optional arguments
LogicalTimestamp
Logical timestamp of the network configuration that may may be provided for
consistency.
IpConfig
For managed L3 networks, this is the IP configuration.
Uuid
The UUID of the network
Name
The name of the network
VswitchName
The name of the vswitch
Annotation
The annotation of the network
Template
Get list of networks configured in the cluster

> Get-NTNXNetwork [[-Servers] <string[]>] [-Networkid <Object>]
AOS | Network | 698

> Get-NTNXNetwork [-Networkid <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXNetwork [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Networkid
Id of the network
AOS | Network | 699

144
AOS | NetworkAddressTable | 700

NETWORKADDRESSTABLE
Operations
• Get IP addresses assigned in the specified network: Get-NTNXNetworkAddressTable
Get IP addresses assigned in the specified network

> Get-NTNXNetworkAddressTable [[-Servers] <string[]>] -Networkid <Object>
> Get-NTNXNetworkAddressTable [-Networkid <Object>] [-ExpandedOutput]

> Get-NTNXNetworkAddressTable [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Networkid
Id of the network
AOS | NetworkAddressTable | 701

145
AOS | NetworkIP | 702

NETWORKIP
Operations
• Blacklist an IP address from managed network: Reserve-NTNXNetworkIP

• Remove an IP address from the managed network blacklist: UnReserve-NTNXNetworkIP
Remove an IP address from the blacklist that prevents it from being used by the managed
network
of the virtual network logical timestamp. The logical timestamp can be obtained from the virtual
network object.
> UnReserve-NTNXNetworkIP [[-Servers] <string[]>] -Networkid <Object>
-Ipaddress <Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> UnReserve-NTNXNetworkIP [-Networkid <Object>] [-Ipaddress <Object>]

> UnReserve-NTNXNetworkIP [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Networkid
Id of the network
Ipaddress
IP address
Optional arguments
Template
Blacklist an IP address from being used by a managed network

A blacklisted IP address cannot be assigned to a VM network adapter. This property may be
useful for avoiding conflicts between VMs and other hosts on the physical network. The logical
this operation will be rejected if the logical timestamp specified is not the value of the virtual
network logical timestamp. The logical timestamp can be obtained from the virtual network
object.
> Reserve-NTNXNetworkIP [[-Servers] <string[]>] -Networkid <Object> -Arg1
<string> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Reserve-NTNXNetworkIP [-Networkid <Object>] [-Arg1 <string>] [-Template]

> Reserve-NTNXNetworkIP [[-NutanixClusters] <NutanixCluster[]>]
AOS | NetworkIP | 703

Required arguments
Networkid
Id of the network
Arg1
Optional arguments
Template
146
AOS | NfsDatastore | 705

NFSDATASTORE
Operations
• Add an NFS Datastore: Add-NTNXNfsDatastore

• Get the list of NFS Datastores: Get-NTNXNfsDatastore
• Remove an NFS Datastore: Remove-NTNXNfsDatastore
Add an NFS Datastore

> Add-NTNXNfsDatastore [[-Servers] <string[]>] [-ContainerName <string>]
[-DatastoreName <string>] [-NodeIds <string[]>] [-NodeUuids <string[]>]
[-ReadOnly <bool>] [-TargetPath <string>] [-ExpandedOutput] [-GridView]
> Add-NTNXNfsDatastore [-ContainerName <string>] [-DatastoreName <string>]

[-NodeIds <string[]>] [-NodeUuids <string[]>] [-ReadOnly <bool>] [-TargetPath
> Add-NTNXNfsDatastore [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
ContainerName
StorageContainerName
DatastoreName
NodeIds
NodeUuids
ReadOnly
TargetPath
Template
Remove an NFS Datastore

> Remove-NTNXNfsDatastore [[-Servers] <string[]>] [-DatastoreName <string>]
[-NodeIds <string[]>] [-NodeUuids <string[]>] [-ExpandedOutput] [-GridView]
> Remove-NTNXNfsDatastore [-DatastoreName <string>] [-NodeIds <string[]>]

[-NodeUuids <string[]>] [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXNfsDatastore [[-NutanixClusters] <NutanixCluster[]>]
Required arguments
None
Optional arguments
DatastoreName
NodeIds
NodeUuids
Template
Get the list of NFS Datastores mounted using Containers in the cluster
> Get-NTNXNfsDatastore [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXNfsDatastore [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None

147
AOS | NfsSubnetWhitelist | 708

NFSSUBNETWHITELIST
Operations
• Add NFS subnet whitelist entry: Add-NTNXNfsSubnetWhitelist

• Delete NFS the specified subnet whitelist entry: Remove-NTNXNfsSubnetWhitelist
Delete an address from the NFS subnet whitelist

> Remove-NTNXNfsSubnetWhitelist [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXNfsSubnetWhitelist [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXNfsSubnetWhitelist [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
NFS Whitelist
Optional arguments
Template
Add the address to the NFS subnet whitelist

> Add-NTNXNfsSubnetWhitelist [[-Servers] <string[]>] -Arg0 <string>
> Add-NTNXNfsSubnetWhitelist [-Arg0 <string>] [-Template] [-ExpandedOutput]

> Add-NTNXNfsSubnetWhitelist [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Arg0
Optional arguments
Template

148

NFSSUBNETWHITELIST
Operations
• Add NFS subnet whitelist entry: Add-NTNXNfsSubnetWhitelist

• Delete NFS the specified subnet whitelist entry: Remove-NTNXNfsSubnetWhitelist
Delete an address from the NFS subnet whitelist

> Remove-NTNXNfsSubnetWhitelist [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXNfsSubnetWhitelist [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXNfsSubnetWhitelist [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
NFS Whitelist
Optional arguments
Template
Add the address to the NFS subnet whitelist

> Add-NTNXNfsSubnetWhitelist [[-Servers] <string[]>] -Arg0 <string>
> Add-NTNXNfsSubnetWhitelist [-Arg0 <string>] [-Template] [-ExpandedOutput]

> Add-NTNXNfsSubnetWhitelist [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Arg0
Optional arguments
Template

149
AOS | NtpServer | 712

NTPSERVER
Operations
• Add NTP server: Add-NTNXNtpServer

• Get the list of NTP servers: Get-NTNXNtpServer
• Delete an NTP server: Remove-NTNXNtpServer
Add the server to the NTP servers configured on the cluster

> Add-NTNXNtpServer [[-Servers] <string[]>] -Arg0 <string> [-ExpandedOutput]
> Add-NTNXNtpServer [-Arg0 <string>] [-Template] [-ExpandedOutput] [-GridView]

> Add-NTNXNtpServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Arg0
Optional arguments
Template
Delete an NTP server with the specified name

> Remove-NTNXNtpServer [[-Servers] <string[]>] -NtpServer <Object>
> Remove-NTNXNtpServer [-NtpServer <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXNtpServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
NtpServer
Name of NTP server
Optional arguments
Template
AOS | NtpServer | 713

Get the list of NTP servers configured on the cluster
> Get-NTNXNtpServer [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXNtpServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
150
AOS | OutOfBandSchedule | 715

OUTOFBANDSCHEDULE
Operations
• Add a out of band snapshot schedule in a Protection Domain: Add-NTNXOutOfBandSchedule

• Get the list of Out-Of-Band schedules in Protection Domains: Get-NTNXOutOfBandSchedule
• Delete a Out-Of-Band schedule: Remove-NTNXOutOfBandSchedule
Add a out of band(i.e one time) snapshot schedule in a Protection Domain having specified
name
> Add-NTNXOutOfBandSchedule [[-Servers] <string[]>] -PdName <Object>

[-ScheduleId <long>] [-ScheduleStartTimeUsecs <long>] [-RemoteSiteNames
<string[]>] [-SnapshotRetentionTimeSecs <int>] [-AppConsistent <bool>]
> Add-NTNXOutOfBandSchedule [-PdName <Object>] [-ScheduleId <long>]

[-ScheduleStartTimeUsecs <long>] [-RemoteSiteNames <string[]>]
[-SnapshotRetentionTimeSecs <int>] [-AppConsistent <bool>] [-Template]
> Add-NTNXOutOfBandSchedule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
ScheduleId
ScheduleStartTimeUsecs
RemoteSiteNames
SnapshotRetentionTimeSecs
AppConsistent
Create app consistent snapshots
Template
Get the list of Out-Of-Band schedules in Protection Domains configured in the cluster
> Get-NTNXOutOfBandSchedule [[-Servers] <string[]>] [-ProtectionDomainNames
<Object>] [-PdName <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXOutOfBandSchedule [-ProtectionDomainNames <Object>] [-PdName


> Get-NTNXOutOfBandSchedule [[-NutanixClusters] <NutanixCluster[]>]
Required arguments
PdName
Optional arguments
ProtectionDomainNames
Names of Protection Domains
Delete a Out-Of-Band schedule having specified id

> Remove-NTNXOutOfBandSchedule [[-Servers] <string[]>] -PdName <Object>
-ScheduleId <long> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXOutOfBandSchedule [-PdName <Object>] [-ScheduleId <long>]

> Remove-NTNXOutOfBandSchedule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
ScheduleId
Id of the Out-Of-Band schedule
Optional arguments
Template

151
AOS | PasswordProtection | 718

PASSWORDPROTECTION
Operations
• Enable encryption: Set-NTNXPasswordProtection
Enable encryption on the cluster

> Set-NTNXPasswordProtection [[-Servers] <string[]>] [-Value <bool>]
[-SoftwareEncryptionScope
<SetPasswordProtection+SoftwareEncryptionScope_Enum>] [-ExpandedOutput]
> Set-NTNXPasswordProtection [-Value <bool>] [-SoftwareEncryptionScope

<SetPasswordProtection+SoftwareEncryptionScope_Enum>] [-Template]
> Set-NTNXPasswordProtection [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Value
SoftwareEncryptionScope
Template
AOS | PasswordProtection | 719

152
AOS | PrincipalType | 720

PRINCIPALTYPE
Operations
• Get principal type from principal name: Get-NTNXPrincipalType

> Get-NTNXPrincipalType [[-Servers] <string[]>] -Uuid <Object> -PrincipalName
<string> [-PrincipalType <GetPrincipalType+QuotaPolicyPrincipalType_Enum>]
[-ProtocolType <GetPrincipalType+ShareProtocolType_Enum>] [-ExpandedOutput]
> Get-NTNXPrincipalType [-Uuid <Object>] [-PrincipalName <string>]

[-PrincipalType <GetPrincipalType+QuotaPolicyPrincipalType_Enum>]
[-ProtocolType <GetPrincipalType+ShareProtocolType_Enum>] [-Template]
> Get-NTNXPrincipalType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the share that principal type is associated with
PrincipalName
Optional arguments
PrincipalType
ProtocolType
Template
AOS | PrincipalType | 721

153
AOS | ProtectionDomain | 722

PROTECTIONDOMAIN
Operations
• Add a Protection Domain: Add-NTNXProtectionDomain

• Get the list of Protection Domains: Get-NTNXProtectionDomain
• Migrate an active Protection Domain to a DR site: Migrate-NTNXProtectionDomain
• Rollback an active Protection domain: Rollback-NTNXProtectionDomain
Mark the specified Protection domain as inactive and failover to the given Remote Site
> Migrate-NTNXProtectionDomain [[-Servers] <string[]>] -PdName <Object> -Arg1
<string> [-SkipVmMobilityCheck <bool>] [-ExpandedOutput] [-GridView]
> Migrate-NTNXProtectionDomain [-PdName <Object>] [-SkipVmMobilityCheck

<bool>] [-Arg1 <string>] [-Template] [-ExpandedOutput] [-GridView]
> Migrate-NTNXProtectionDomain [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Arg1
Optional arguments
SkipVmMobilityCheck
Flag to specify whether mobility check has to be skipped
Template
A protection domain to be used for Disaster Recovery and Backups

> Add-NTNXProtectionDomain [[-Servers] <string[]>] -Value <string>
[-Annotations <string[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXProtectionDomain [-Value <string>] [-Annotations <string[]>]

> Add-NTNXProtectionDomain [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Value
Name of the protection domain

Optional arguments
Annotations
Annotations of the protection domain
Template
Rollback the specified active Protection domain to a given snapshot

> Rollback-NTNXProtectionDomain [[-Servers] <string[]>] -PdName <Object> -Arg1
> Rollback-NTNXProtectionDomain [-PdName <Object>] [-Arg1 <string>]

> Rollback-NTNXProtectionDomain [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Arg1
Optional arguments
Template
Get the list of Protection Domains configured in the cluster

> Get-NTNXProtectionDomain [[-Servers] <string[]>] [-Names <Object>]
[-MetroAvail] [-VStoreName <Object>] [-RemoteSiteName <Object>]
[-RemoteSiteToForward <Object>] [-IncludeDeleted] [-Projection <Object>]
[-ProtectionDomainType <Object>] [-PdName <Object>] [-ExpandedOutput]
> Get-NTNXProtectionDomain [-Names <Object>] [-MetroAvail] [-VStoreName

<Object>] [-RemoteSiteName <Object>] [-RemoteSiteToForward <Object>]
[-IncludeDeleted] [-Projection <Object>] [-ProtectionDomainType <Object>]
[-PdName <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXProtectionDomain [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Names
Protection Domain names

MetroAvail
Metro Availability Protection Domain
VStoreName
vStore name
RemoteSiteName
Remote Site name
RemoteSiteToForward
Remote Site to forward
IncludeDeleted
Include deleted
Projection
ProtectionDomainType
Type of protection domain (legacy/entity-centric)
MetroAvail
Whether to include only Metro Availability related protection domains

154
AOS | ProtectionDomainActive | 726

PROTECTIONDOMAINACTIVE
Operations
• Activate a protection domain: Mark-NTNXProtectionDomainActive
Activate a protection domain with the specified name

> Mark-NTNXProtectionDomainActive [[-Servers] <string[]>] -PdName <Object>
[-Arg1 <string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Mark-NTNXProtectionDomainActive [-PdName <Object>] [-Arg1 <string>]

> Mark-NTNXProtectionDomainActive [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Arg1
Template
AOS | ProtectionDomainActive | 727

155
AOS | ProtectionDomainAlert | 728

PROTECTIONDOMAINALERT
Operations
• Get the list of alerts generated on any Protection Domain: Get-NTNXProtectionDomainAlert
> Get-NTNXProtectionDomainAlert [[-Servers] <string[]>] [-PdName <Object>]

> Get-NTNXProtectionDomainAlert [-PdName <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXProtectionDomainAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
AOS | ProtectionDomainAlert | 729

156
AOS | ProtectionDomainConsistencyGroup | 730

PROTECTIONDOMAINCONSISTENCYGROUP
Operations
• Get list of Consistency groups: Get-NTNXProtectionDomainConsistencyGroup
Get list of Consistency groups in the cluster

> Get-NTNXProtectionDomainConsistencyGroup [[-Servers] <string[]>]
[-ProtectionDomains <Object>] [-ConsistencyGroups <Object>] [-IncludeDeleted]
> Get-NTNXProtectionDomainConsistencyGroup [-ProtectionDomains <Object>]

[-ConsistencyGroups <Object>] [-IncludeDeleted] [-PdName <Object>]
> Get-NTNXProtectionDomainConsistencyGroup [[-NutanixClusters]

Required arguments
PdName
Optional arguments
ProtectionDomains
ConsistencyGroups
Consistency Group names
IncludeDeleted
Include deleted
AOS | ProtectionDomainConsistencyGroup | 731

157
AOS | ProtectionDomainCronSchedule | 732

PROTECTIONDOMAINCRONSCHEDULE
Operations
• Add a snapshot schedule to a Protection Domain: Add-NTNXProtectionDomainCronSchedule

• Retrieve all snapshot schedules from a Protection Domain: Get-
NTNXProtectionDomainCronSchedule
• Remove a snapshot schedule from a Protection Domain: Remove-

• Replace a snapshot schedule of a Protection Domain: Replace-

Remove a snapshot schedule from the specified Protection Domain

> Remove-NTNXProtectionDomainCronSchedule [[-Servers] <string[]>] -PdName
<Object> -Id <Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXProtectionDomainCronSchedule [-PdName <Object>] [-Id <Object>]

> Remove-NTNXProtectionDomainCronSchedule [[-NutanixClusters]

Required arguments
PdName
Id
Id of the snapshot schedule
Optional arguments
Template
Replace a snapshot schedule of the specified Protection Domain

> Replace-NTNXProtectionDomainCronSchedule [[-Servers] <string[]>] -PdName
<Object> -Id <Object> [-Suspended <bool>] [-CronSchedule_PdName <string>]
[-CronSchedule_Id <string>] [-Type
<ReplaceProtectionDomainCronSchedule+ScheduleType_Enum>] [-Values <int[]>]
[-EveryNth <int>] [-UserStartTimeInUsecs <long>] [-StartTimesInUsecs <long[]>]
[-EndTimeInUsecs <long>] [-DurationInUsecs <long>] [-RetentionPolicy
<RetentionPolicyDTO>] [-AppConsistent <bool>] [-TimezoneOffset <int>]
[-IsRollupSched <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Replace-NTNXProtectionDomainCronSchedule [-PdName <Object>] [-Id <Object>]

[-Suspended <bool>] [-CronSchedule_PdName <string>] [-CronSchedule_Id
<string>] [-Type <ReplaceProtectionDomainCronSchedule+ScheduleType_Enum>]
[-Values <int[]>] [-EveryNth <int>] [-UserStartTimeInUsecs <long>]
[-StartTimesInUsecs <long[]>] [-EndTimeInUsecs <long>] [-DurationInUsecs

<long>] [-RetentionPolicy <RetentionPolicyDTO>] [-AppConsistent <bool>]
[-TimezoneOffset <int>] [-IsRollupSched <bool>] [-Template] [-ExpandedOutput]
> Replace-NTNXProtectionDomainCronSchedule [[-NutanixClusters]

Required arguments
PdName
Id
Id of the snapshot schedule
Optional arguments
Suspended
PdName
Id
Type
Values
EveryNth
UserStartTimeInUsecs
StartTimesInUsecs
EndTimeInUsecs
DurationInUsecs
RetentionPolicy
AppConsistent
TimezoneOffset
Timezone offset in seconds w.r.t GMT in which the start time is being specified.
Defaults to 0, which is GMT
IsRollupSched
Given schedule is a Rollup Schedule or not
Template
Add a snapshot schedule to the specified Protection Domain

> Add-NTNXProtectionDomainCronSchedule [[-Servers] <string[]>] -PdName
<Object> [-Suspended <bool>] [-CronSchedule_PdName <string>] [-Id <string>]
[-Type <AddProtectionDomainCronSchedule+ScheduleType_Enum>] [-Values <int[]>]
[-RollupScheduleUuid <string>] [-IsRollupSched <bool>] [-ExpandedOutput]

> Add-NTNXProtectionDomainCronSchedule [-PdName <Object>] [-Suspended <bool>]

[-CronSchedule_PdName <string>] [-Id <string>] [-Type
<AddProtectionDomainCronSchedule+ScheduleType_Enum>] [-Values <int[]>]
[-RollupScheduleUuid <string>] [-IsRollupSched <bool>] [-Template]
> Add-NTNXProtectionDomainCronSchedule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Suspended
PdName
Id
Type
Values
EveryNth
UserStartTimeInUsecs
StartTimesInUsecs
EndTimeInUsecs
DurationInUsecs
RetentionPolicy
AppConsistent
TimezoneOffset
Timezone offset in seconds w.r.t GMT in which the start time is being specified.
Defaults to 0, which is GMT
RollupScheduleUuid
UUID that helps identify that cron schedules are part of a rollup schedule.
IsRollupSched
Given schedule is a Rollup Schedule or not
Template

Retrieve all snapshot schedules from the specified Protection Domain
> Get-NTNXProtectionDomainCronSchedule [[-Servers] <string[]>] -PdName
<Object> [-TimezoneOffset <long>] [-ExpandedOutput] [-GridView]
> Get-NTNXProtectionDomainCronSchedule [-PdName <Object>] [-TimezoneOffset

> Get-NTNXProtectionDomainCronSchedule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
TimezoneOffset
Timezone offset in seconds w.r.t GMT
158
AOS | ProtectionDomainEvent | 737

PROTECTIONDOMAINEVENT
Operations
• Get the list of events generated on any Protection Domain: Get-NTNXProtectionDomainEvent
> Get-NTNXProtectionDomainEvent [[-Servers] <string[]>] [-PdName <Object>]

> Get-NTNXProtectionDomainEvent [-PdName <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXProtectionDomainEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
159
AOS | ProtectionDomainForRemoval | 739

PROTECTIONDOMAINFORREMOVAL
Operations
• Delete a Protection Domain: Mark-NTNXProtectionDomainForRemoval
Mark a Protection domain for removal

Protection domain will be removed from the cluster when all outstanding operations on it are
cancelled.
> Mark-NTNXProtectionDomainForRemoval [[-Servers] <string[]>] -PdName <Object>
[-SkipRemoteCheck <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Mark-NTNXProtectionDomainForRemoval [-SkipRemoteCheck <bool>] [-PdName

> Mark-NTNXProtectionDomainForRemoval [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
SkipRemoteCheck
Skip checking remote Protection Domain
Template
160
AOS | ProtectionDomainHealthCheckSummary | 741

PROTECTIONDOMAINHEALTHCHECKSUMMAR
Operations
• Get the health check summary for the Protection Domain: Get-
NTNXProtectionDomainHealthCheckSummary
> Get-NTNXProtectionDomainHealthCheckSummary [[-Servers] <string[]>]

[-FilterCriteria <Object>] [-DetailedSummary] [-ExpandedOutput] [-GridView]
> Get-NTNXProtectionDomainHealthCheckSummary [-FilterCriteria <Object>]

[-DetailedSummary] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXProtectionDomainHealthCheckSummary [[-NutanixClusters]

Required arguments
None
Optional arguments
FilterCriteria
Filter criteria
DetailedSummary
Detailed summary
161
AOS | ProtectionDomainInactive | 743

PROTECTIONDOMAININACTIVE
Operations
• Deactivate a protection domain: Mark-NTNXProtectionDomainInactive
Deactivate a protection domain with the specified name

> Mark-NTNXProtectionDomainInactive [[-Servers] <string[]>] -PdName <Object>
> Mark-NTNXProtectionDomainInactive [-PdName <Object>] [-Template]

> Mark-NTNXProtectionDomainInactive [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Template
162
AOS | ProtectionDomainPendingAction | 745

PROTECTIONDOMAINPENDINGACTION
Operations
• Get list of pending actions: Get-NTNXProtectionDomainPendingAction
Get list of pending actions in the cluster

> Get-NTNXProtectionDomainPendingAction [[-Servers] <string[]>]
[-ProtectionDomainNames <Object>] [-PdName <Object>] [-ExpandedOutput]
> Get-NTNXProtectionDomainPendingAction [-ProtectionDomainNames <Object>]

> Get-NTNXProtectionDomainPendingAction [[-NutanixClusters]

Required arguments
PdName
Optional arguments
163
AOS | ProtectionDomainPendingReplication | 747

PROTECTIONDOMAINPENDINGREPLICATION
Operations
• Get list of pending replications: Get-NTNXProtectionDomainPendingReplication
Get list of pending replications in the cluster

> Get-NTNXProtectionDomainPendingReplication [[-Servers] <string[]>] [-PdName
<Object>] [-RemoteSiteNames <Object>] [-ProtectionDomainNames <Object>]
> Get-NTNXProtectionDomainPendingReplication [-PdName <Object>]

[-RemoteSiteNames <Object>] [-ProtectionDomainNames <Object>]
> Get-NTNXProtectionDomainPendingReplication [[-NutanixClusters]

Required arguments
PdName
Optional arguments
RemoteSiteNames
Names of Remote Sites
RemoteSiteNames
Remote Site names
164
AOS | ProtectionDomainReplication | 749

PROTECTIONDOMAINREPLICATION
Operations
• Abort a replication: Abort-NTNXProtectionDomainReplication

• Get list of replications: Get-NTNXProtectionDomainReplication
• Update the state of the replication: Set-NTNXProtectionDomainReplication
Get list of replications in the cluster

> Get-NTNXProtectionDomainReplication [[-Servers] <string[]>] [-PdName
<Object>] [-ProtectionDomainType <Object>] [-ProtectionDomainNames <Object>]
[-RemoteSiteNames <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXProtectionDomainReplication [-PdName <Object>]

[-ProtectionDomainType <Object>] [-ProtectionDomainNames <Object>]
[-RemoteSiteNames <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXProtectionDomainReplication [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
ProtectionDomainType
Type of protection domain (legacy/entity-centric)
RemoteSiteNames
Remote Site names
Update the state of the replication in a Protection Domain

> Set-NTNXProtectionDomainReplication [[-Servers] <string[]>]
-ProtectionDomainName <Object> -Id <long> -Arg2 <string> [-ExpandedOutput]
> Set-NTNXProtectionDomainReplication [-ProtectionDomainName <Object>] [-Id

<long>] [-Arg2 <string>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXProtectionDomainReplication [[-NutanixClusters] <NutanixCluster[]>]

Required arguments

Id
Id of the replication
Arg2
Optional arguments
Template
Abort a replication in a Protection Domain

> Abort-NTNXProtectionDomainReplication [[-Servers] <string[]>]
-ProtectionDomainName <Object> -Id <long> [-ExpandedOutput] [-GridView]
> Abort-NTNXProtectionDomainReplication [-ProtectionDomainName <Object>] [-Id

> Abort-NTNXProtectionDomainReplication [[-NutanixClusters]

Required arguments
Id
Id of the replication
Optional arguments
Template

165
AOS | ProtectionDomainRetentionPolicy | 752

PROTECTIONDOMAINRETENTIONPOLICY
Operations
• Clear retention policies of a snapshot schedule of a Protection Domain: Clear-

NTNXProtectionDomainRetentionPolicy
• Set retention policies of a snapshot schedule of a Protection Domain: Set-

NTNXProtectionDomainRetentionPolicy
Set retention policies of specified snapshot schedule from the specified Protection Domain
> Set-NTNXProtectionDomainRetentionPolicy [[-Servers] <string[]>] -PdName
<Object> -Id <Object> [-LocalMaxSnapshots <int>] [-RemoteMaxSnapshots
<Object>] [-LocalRetentionPeriod <int>] [-RemoteRetentionPeriod <Object>]
[-LocalRetentionType <SetProtectionDomainRetentionPolicy+RetentionType_Enum>]
[-RemoteRetentionType <Object>] [-ExpandedOutput] [-GridView]
> Set-NTNXProtectionDomainRetentionPolicy [-PdName <Object>] [-Id <Object>]

[-LocalMaxSnapshots <int>] [-RemoteMaxSnapshots <Object>]
[-LocalRetentionPeriod <int>] [-RemoteRetentionPeriod <Object>]
[-LocalRetentionType <SetProtectionDomainRetentionPolicy+RetentionType_Enum>]
[-RemoteRetentionType <Object>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXProtectionDomainRetentionPolicy [[-NutanixClusters]

Required arguments
PdName
Id
ID of the snapshot schedule
Optional arguments
LocalMaxSnapshots
RemoteMaxSnapshots
LocalRetentionPeriod
Maximum number of days/weeks/months a snapshot is to be retained locally.
RemoteRetentionPeriod
Maximum number of days/weeks/months a remote snapshot is to be retained
remotely.
LocalRetentionType
Retention type for local Snapshots i.e. DAYS/ WEEKS/ MONTHS/
NUM_SNAPSHOTS
RemoteRetentionType
Retention type for remote Snapshots i.e. DAYS/ WEEKS/ MONTHS/
NUM_SNAPSHOTS
AOS | ProtectionDomainRetentionPolicy | 753

Template
Clear retention policies of specified snapshot scheudule from the specified Protection
Domain
> Clear-NTNXProtectionDomainRetentionPolicy [[-Servers] <string[]>] -PdName
<Object> -Id <Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Clear-NTNXProtectionDomainRetentionPolicy [-PdName <Object>] [-Id <Object>]

> Clear-NTNXProtectionDomainRetentionPolicy [[-NutanixClusters]

Required arguments
PdName
Id
ID of the snapshot schedule
Optional arguments
Template
166
AOS | ProtectionDomainSnapshot | 755

PROTECTIONDOMAINSNAPSHOT
Operations
• Get the list of Snapshots: Get-NTNXProtectionDomainSnapshot

• Delete a snapshot: Remove-NTNXProtectionDomainSnapshot
• Retain a snapshot: Set-NTNXProtectionDomainSnapshot
Get the list of Snapshots created in Protection Domains

> Get-NTNXProtectionDomainSnapshot [[-Servers] <string[]>] [-Count <int>]
[-FilterCriteria <Object>] [-SortCriteria <Object>] [-FullDetails] [-PdName
<Object>] [-OobScheduleIds <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXProtectionDomainSnapshot [-Count <int>] [-FilterCriteria <Object>]

[-SortCriteria <Object>] [-FullDetails] [-PdName <Object>] [-OobScheduleIds
> Get-NTNXProtectionDomainSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
Count
Number of DR Snapshots to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
FullDetails
Whether to include consistency group / vm details
OobScheduleIds
OOB Schedule Ids for filtering
Retain a snapshot of a Protection Domain

> Set-NTNXProtectionDomainSnapshot [[-Servers] <string[]>]
-ProtectionDomainName <Object> -SnapshotId <Object> -Arg2 <long>
> Set-NTNXProtectionDomainSnapshot [-ProtectionDomainName <Object>]

[-SnapshotId <Object>] [-Arg2 <long>] [-Template] [-ExpandedOutput]
> Set-NTNXProtectionDomainSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SnapshotId
Id of the snapshot
Arg2
Optional arguments
Template
Delete a snapshot of a Protection Domain

> Remove-NTNXProtectionDomainSnapshot [[-Servers] <string[]>]
-ProtectionDomainName <Object> -SnapshotId <Object> [-ExpandedOutput]
> Remove-NTNXProtectionDomainSnapshot [-ProtectionDomainName <Object>]

[-SnapshotId <Object>] [-Template] [-ExpandedOutput] [-GridView]
> Remove-NTNXProtectionDomainSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SnapshotId
Id of the snapshot
Optional arguments
Template

167
AOS | ProtectionDomainStat | 758

PROTECTIONDOMAINSTAT
Operations
• Get the stats for a specified Protection Domain: Get-NTNXProtectionDomainStat
> Get-NTNXProtectionDomainStat [[-Servers] <string[]>] -Name <Object> -Metrics
> Get-NTNXProtectionDomainStat [-Name <Object>] [-Metrics <Object>]

> Get-NTNXProtectionDomainStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | ProtectionDomainStat | 759

168
AOS | ProtectionDomainStatus | 760

PROTECTIONDOMAINSTATUS
Operations
• Get the Data Protection status for all Protection Domains: Get-NTNXProtectionDomainStatus
> Get-NTNXProtectionDomainStatus [[-Servers] <string[]>] [-ExpandedOutput]

> Get-NTNXProtectionDomainStatus [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
AOS | ProtectionDomainStatus | 761

169
AOS | ProtectionDomainStretchCluster | 762

PROTECTIONDOMAINSTRETCHCLUSTER
Operations
• Promotes to active Metro Availability role for a specific protection domain: Promote-
NTNXProtectionDomainStretchCluster
• Enables Metro Availability for a specific protection domain: Start-

• Disables Metro Availability for a specific protection domain: Stop-

Promotes to active Metro Availability role for a specific protection domain

> Promote-NTNXProtectionDomainStretchCluster [[-Servers] <string[]>] -PdName
<Object> [-SkipRemoteCheck <bool>] [-Force <bool>] [-ExpandedOutput]
> Promote-NTNXProtectionDomainStretchCluster [-SkipRemoteCheck <bool>]

[-PdName <Object>] [-Force <bool>] [-Template] [-ExpandedOutput] [-GridView]
> Promote-NTNXProtectionDomainStretchCluster [[-NutanixClusters]

Required arguments
PdName
Optional arguments
SkipRemoteCheck
Force
Force to perform the action
Template
Disables Metro Availability for a specific protection domain

> Stop-NTNXProtectionDomainStretchCluster [[-Servers] <string[]>] -PdName
<Object> [-SkipRemoteCheck <bool>] [-ExpandedOutput] [-GridView]
> Stop-NTNXProtectionDomainStretchCluster [-SkipRemoteCheck <bool>] [-PdName

> Stop-NTNXProtectionDomainStretchCluster [[-NutanixClusters]


Required arguments
PdName
Optional arguments
SkipRemoteCheck
Template
Enables Metro Availability for a specific protection domain based on VStore and remote site
> Start-NTNXProtectionDomainStretchCluster [[-Servers] <string[]>] -PdName
<Object> [-ReEnable <bool>] [-SkipRemoteCheck <bool>] [-Force <bool>] [-Role
<StartProtectionDomainStretchCluster+Role_Enum>] [-RemoteSite <string>]
[-Container <string>] [-Status
<StartProtectionDomainStretchCluster+Status_Enum>] [-Timeout <long>]
[-FailureHandling <StartProtectionDomainStretchCluster+FailureHandling_Enum>]
> Start-NTNXProtectionDomainStretchCluster [-PdName <Object>] [-ReEnable

<bool>] [-SkipRemoteCheck <bool>] [-Force <bool>] [-Role
<StartProtectionDomainStretchCluster+Role_Enum>] [-RemoteSite <string>]
<StartProtectionDomainStretchCluster+Status_Enum>] [-Timeout <long>]
[-FailureHandling <StartProtectionDomainStretchCluster+FailureHandling_Enum>]
> Start-NTNXProtectionDomainStretchCluster [[-NutanixClusters]

Required arguments
PdName
Optional arguments
ReEnable
Re-enable operation
SkipRemoteCheck
Force
Skip checking remote container emptiness
Role
RemoteSite
Container
StorageContainer
Status

Timeout
Timeout to break replication when primary does not hear back from secondary
for the amount of time
FailureHandling
Template

170
AOS | ProtectionDomainStretchTimeout | 766

PROTECTIONDOMAINSTRETCHTIMEOUT
Operations
• Updates Metro Availability timeout for a specific protection domain: Update-

NTNXProtectionDomainStretchTimeout
Updates Metro Availability timeout for a specific protection domain

> Update-NTNXProtectionDomainStretchTimeout [[-Servers] <string[]>] -PdName
<Object> [-Role <UpdateProtectionDomainStretchTimeout+Role_Enum>] [-RemoteSite
<string>] [-Container <string>] [-Status
<UpdateProtectionDomainStretchTimeout+Status_Enum>] [-Timeout <long>]
[-FailureHandling <UpdateProtectionDomainStretchTimeout+FailureHandling_Enum>]
> Update-NTNXProtectionDomainStretchTimeout [-PdName <Object>] [-Role

<UpdateProtectionDomainStretchTimeout+Role_Enum>] [-RemoteSite <string>]
<UpdateProtectionDomainStretchTimeout+Status_Enum>] [-Timeout <long>]
[-FailureHandling <UpdateProtectionDomainStretchTimeout+FailureHandling_Enum>]
> Update-NTNXProtectionDomainStretchTimeout [[-NutanixClusters]

Required arguments
PdName
Optional arguments
Role
RemoteSite
Container
StorageContainer
Status
Timeout
Timeout to break replication when primary does not hear back from secondary
for the amount of time
FailureHandling
Template
AOS | ProtectionDomainStretchTimeout | 767

171
AOS | ProtectionDomainVM | 768

PROTECTIONDOMAINVM
Operations
• Add Virtual Machines to a Protection Domain: Add-NTNXProtectionDomainVM

• Remove Virtual Machines from a Protection Domain: Remove-NTNXProtectionDomainVM
Add Virtual Machines to a Protection Domain to enable Backup and disaster recovery
> Add-NTNXProtectionDomainVM [[-Servers] <string[]>] -PdName <Object>
[-ConsistencyGroupName <string>] [-AppConsistentSnapshots <bool>] [-Names
<string[]>] [-Ids <string[]>] [-Uuids <string[]>] [-IgnoreDupOrMissingVms
<bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXProtectionDomainVM [-PdName <Object>] [-ConsistencyGroupName

<string>] [-AppConsistentSnapshots <bool>] [-Names <string[]>] [-Ids
<string[]>] [-Uuids <string[]>] [-IgnoreDupOrMissingVms <bool>] [-Template]
> Add-NTNXProtectionDomainVM [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
Optional arguments
ConsistencyGroupName
AppConsistentSnapshots
Names
Ids
Uuids
IgnoreDupOrMissingVms
Template
> Remove-NTNXProtectionDomainVM [[-Servers] <string[]>] -PdName <Object>

-InputList <string[]> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXProtectionDomainVM [-PdName <Object>] [-InputList <string[]>]

> Remove-NTNXProtectionDomainVM [[-NutanixClusters] <NutanixCluster[]>]

AOS | ProtectionDomainVM | 769

Required arguments
PdName
InputList
Optional arguments
Template
172
AOS | ProtectionStatus | 771

PROTECTIONSTATUS
Operations
• Get encryption status: Get-NTNXProtectionStatus
Get encryption status of the cluster

> Get-NTNXProtectionStatus [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXProtectionStatus [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
173
AOS | PublicKey | 773

PUBLICKEY
Operations
• Add a Public Key: Add-NTNXPublicKey

• Get the list of Public Keys: Get-NTNXPublicKey
• Delete a Public Key: Remove-NTNXPublicKey
Add a Public Key to the cluster

> Add-NTNXPublicKey [[-Servers] <string[]>] [-Name <string>] [-Key <string>]
> Add-NTNXPublicKey [-Name <string>] [-Key <string>] [-Template]

> Add-NTNXPublicKey [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
Key
Template
Delete a Public Key with the specified name

> Remove-NTNXPublicKey [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXPublicKey [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXPublicKey [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the Public Key

Optional arguments
Template
Get the list of Public Keys configured in the cluster

> Get-NTNXPublicKey [[-Servers] <string[]>] [-Name <Object>] [-ExpandedOutput]
> Get-NTNXPublicKey [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXPublicKey [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the Public Key

174
AOS | QuotaPolicies | 776

QUOTAPOLICIES
Operations
• Get the list of quota policies: Get-NTNXQuotaPolicies
Get the list of quota policies associated with a share

> Get-NTNXQuotaPolicies [[-Servers] <string[]>] -Uuid <Object>
[-QuotaPolicyUuid <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXQuotaPolicies [-Uuid <Object>] [-QuotaPolicyUuid <Object>]

> Get-NTNXQuotaPolicies [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
uuid of the share
QuotaPolicyUuid
AOS | QuotaPolicies | 777

175
AOS | QuotaPolicy | 778

QUOTAPOLICY
Operations
• Add new Quota Policy: Add-NTNXQuotaPolicy

• Delete Quota Policy: Remove-NTNXQuotaPolicy
• Update Quota Policy: Update-NTNXQuotaPolicy

> Add-NTNXQuotaPolicy [[-Servers] <string[]>] -Uuid <Object> -PrincipalValue
<string> -QuotaSizeGiB <float> -QuotaEnforcementType
<AddQuotaPolicy+QuotaEnforcementType_Enum> [-PrincipalType
<AddQuotaPolicy+QuotaPolicyPrincipalType_Enum>] [-SendQuotaNotificationsToUser
<bool>] [-NotificationRecipients <string[]>] [-ExpandedOutput] [-GridView]
> Add-NTNXQuotaPolicy [-Uuid <Object>] [-PrincipalType

<AddQuotaPolicy+QuotaPolicyPrincipalType_Enum>] [-PrincipalValue <string>]
<AddQuotaPolicy+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser
> Add-NTNXQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
PrincipalValue
QuotaSizeGiB
Quota size in Gibs
Optional arguments
PrincipalType
Template

Delete Quota Policy
> Remove-NTNXQuotaPolicy [[-Servers] <string[]>] -Uuid <Object>
-QuotaPolicyUuid <Object> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Remove-NTNXQuotaPolicy [-Uuid <Object>] [-QuotaPolicyUuid <Object>]

> Remove-NTNXQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
QuotaPolicyUuid
Optional arguments
Template
Update Quota Policy

> Update-NTNXQuotaPolicy [[-Servers] <string[]>] -Uuid <Object>
-QuotaPolicy_Uuid <string> [-QuotaSizeGiB <float>] [-QuotaEnforcementType
<UpdateQuotaPolicy+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser
<bool>] [-NotificationRecipients <string[]>] [-ExpandedOutput] [-GridView]
> Update-NTNXQuotaPolicy [-Uuid <Object>] [-QuotaPolicy_Uuid <string>]

<UpdateQuotaPolicy+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser
> Update-NTNXQuotaPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid
Uuid of the Quota Policy
Optional arguments
QuotaSizeGiB
Quota size in Gibs

Template

176
AOS | RSyslogConfig | 782

RSYSLOGCONFIG
Operations
• Get RSyslog configuration: Get-NTNXRSyslogConfig
Get the complete RSyslog configuration

> Get-NTNXRSyslogConfig [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXRSyslogConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
AOS | RSyslogConfig | 783

177
AOS | RSyslogServer | 784

RSYSLOGSERVER
Operations
• Add log server to RSyslog configuration: Add-NTNXRSyslogServer

• Get log servers: Get-NTNXRSyslogServer
• Delete log server: Remove-NTNXRSyslogServer
• Edit log server in RSyslog configuration: Set-NTNXRSyslogServer
Get log servers configured in RSyslog

> Get-NTNXRSyslogServer [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXRSyslogServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Edit the specified log server

> Set-NTNXRSyslogServer [[-Servers] <string[]>] -Name <string> [-IpAddress
<string>] [-Port <int>] [-NetworkProtocol
<SetRSyslogServer+NetworkProtocol_Enum>] [-RsyslogServerModuleList
<RSyslogServerModuleDTO[]>] [-RelpEnabled <bool>] [-ExpandedOutput]
> Set-NTNXRSyslogServer [-Name <string>] [-IpAddress <string>] [-Port <int>]

[-NetworkProtocol <SetRSyslogServer+NetworkProtocol_Enum>]
[-RsyslogServerModuleList <RSyslogServerModuleDTO[]>] [-RelpEnabled <bool>]
> Set-NTNXRSyslogServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the RSyslog Server
Optional arguments
IpAddress
Ip address of the RSyslog Server
Port
port number
NetworkProtocol
Protocol for RSyslog server configuration
RsyslogServerModuleList

RelpEnabled
Reliable Event Logging Protocol option
Template
Delete log server from RSyslog configuration

> Remove-NTNXRSyslogServer [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXRSyslogServer [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXRSyslogServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the log server
Optional arguments
Template
Add log server to RSyslog configuration

> Add-NTNXRSyslogServer [[-Servers] <string[]>] -Name <string> -IpAddress
<string> -Port <int> [-NetworkProtocol
<AddRSyslogServer+NetworkProtocol_Enum>] [-RsyslogServerModuleList
<RSyslogServerModuleDTO[]>] [-RelpEnabled <bool>] [-ExpandedOutput]
> Add-NTNXRSyslogServer [-Name <string>] [-IpAddress <string>] [-Port <int>]

[-NetworkProtocol <AddRSyslogServer+NetworkProtocol_Enum>]
[-RsyslogServerModuleList <RSyslogServerModuleDTO[]>] [-RelpEnabled <bool>]
> Add-NTNXRSyslogServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
IpAddress
Ip address of the RSyslog Server
Port
port number

Optional arguments
NetworkProtocol
Protocol for RSyslog server configuration
RsyslogServerModuleList
RelpEnabled
Reliable Event Logging Protocol option
Template

178
AOS | RSyslogServerModule | 788

RSYSLOGSERVERMODULE
Operations
• Add module in RSyslog configuration: Add-NTNXRSyslogServerModule

• Get modules for a log server: Get-NTNXRSyslogServerModule
• Delete log server module: Remove-NTNXRSyslogServerModule
Add module to RSyslog configuration

> Add-NTNXRSyslogServerModule [[-Servers] <string[]>] -LogServerName <Object>
-ModuleName <AddRSyslogServerModule+ModuleName_Enum> -LogLevel
<AddRSyslogServerModule+LogLevel_Enum> [-IncludeMonitorLogs <bool>]
> Add-NTNXRSyslogServerModule [-LogServerName <Object>] [-ModuleName

<AddRSyslogServerModule+ModuleName_Enum>] [-LogLevel
<AddRSyslogServerModule+LogLevel_Enum>] [-IncludeMonitorLogs <bool>]
> Add-NTNXRSyslogServerModule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
LogServerName
Log Server Name
ModuleName
Name of the RSyslog Server Module
LogLevel
Log level for RSyslog Server Module
Optional arguments
IncludeMonitorLogs
Include monitor logs for the given RSyslog Server Module
Template
Delete module from RSyslog server configuration

> Remove-NTNXRSyslogServerModule [[-Servers] <string[]>] -LogServerName
<Object> -ModuleName <Object> [-ExpandedOutput] [-GridView]
> Remove-NTNXRSyslogServerModule [-LogServerName <Object>] [-ModuleName

> Remove-NTNXRSyslogServerModule [[-NutanixClusters] <NutanixCluster[]>]

AOS | RSyslogServerModule | 789

Required arguments
LogServerName
ModuleName
Name of the RSyslog Server Module
Optional arguments
Template
Get modules for specific log server configured in RSyslog

> Get-NTNXRSyslogServerModule [[-Servers] <string[]>] -LogServerName <Object>
> Get-NTNXRSyslogServerModule [-LogServerName <Object>] [-ExpandedOutput]

> Get-NTNXRSyslogServerModule [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
LogServerName
Name of the log server
179
AOS | RSyslogState | 791

RSYSLOGSTATE
Operations
• Enable/Disable RSyslog configuration: Set-NTNXRSyslogState
Enable/Disable RSyslog configuration

> Set-NTNXRSyslogState [[-Servers] <string[]>] -Arg0 <bool> [-ExpandedOutput]
> Set-NTNXRSyslogState [-Arg0 <bool>] [-Template] [-ExpandedOutput]

> Set-NTNXRSyslogState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Arg0
Optional arguments
Template
180
AOS | RSyslogStatus | 793

RSYSLOGSTATUS
Operations
• Get the RSyslog status: Get-NTNXRSyslogStatus
Get the RSyslog status

> Get-NTNXRSyslogStatus [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXRSyslogStatus [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
181
AOS | RackableUnit | 795

RACKABLEUNIT
Operations
• Get the list of Rackable Units: Get-NTNXRackableUnit

• Delete the specified Rackable Unit: Remove-NTNXRackableUnit
Delete a Rackable Unit with the specified id

> Remove-NTNXRackableUnit [[-Servers] <string[]>] -Id <Object>
> Remove-NTNXRackableUnit [-Id <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXRackableUnit [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Rackable Unit
Optional arguments
Template
Get the list of Rackable Units configured on the cluster

> Get-NTNXRackableUnit [[-Servers] <string[]>] [-Id <Object>]
> Get-NTNXRackableUnit [-Id <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXRackableUnit [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Rackable Unit
182
AOS | RecentCertificateTestResults | 797

RECENTCERTIFICATETESTRESULTS
Operations
• Get recent certificate test results: Get-NTNXRecentCertificateTestResults
Get recent certificate test results

> Get-NTNXRecentCertificateTestResults [[-Servers] <string[]>] [-HostIds
<Object>] [-KmsServerNames <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXRecentCertificateTestResults [-HostIds <Object>] [-KmsServerNames

> Get-NTNXRecentCertificateTestResults [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
HostIds
List of Host ids
KmsServerNames
List of Key Management Server names
183
AOS | RemoteSite | 799

REMOTESITE
Operations
• Get the list of Remote Sites: Get-NTNXRemoteSite

• Add a Remote Site: New-NTNXRemoteSite
• Modify a Remote Site: Set-NTNXRemoteSite
A remote cluster to be used as a DR site

> New-NTNXRemoteSite [[-Servers] <string[]>] [-Name <string>] [-Uuid <string>]
[-RemoteIpPorts <Object>] [-CloudType <NewRemoteSite+CloudType_Enum>]
[-CredentialName <string>] [-Region <string>] [-CvmName <string>]
[-ProxyEnabled <bool>] [-CompressionEnabled <bool>] [-SshEnabled <bool>]
[-VstoreNameMap <Object>] [-MaxBps <int>] [-MarkedForRemoval <bool>]
[-ClusterId <long>] [-ClusterIncarnationId <long>] [-ReplicationLinks
<ReplicationLinkDTO[]>] [-Capabilities <NewRemoteSite+Capabilities_Enum[]>]
[-Status <NewRemoteSite+Status_Enum>] [-LatencyInUsecs <long>]
[-RemoteVStoreInfo <Object>] [-MetroReady <bool>] [-BandwidthPolicy
<BandwidthPolicyDTO>] [-BandwidthPolicyEnabled <bool>] [-Stats <Object>]
[-UsageStats <Object>] [-HealthSummary <HealthSummaryDTO>] [-AlertSummary
<AlertSummaryDTO>] [-NetworkMapping <NetworkMappingDTO>]
[-ClusterExternalDataServicesIPAddress <string>] [-ExpandedOutput] [-GridView]
> New-NTNXRemoteSite [-Name <string>] [-Uuid <string>] [-RemoteIpPorts

<Object>] [-CloudType <NewRemoteSite+CloudType_Enum>] [-CredentialName
<string>] [-Region <string>] [-CvmName <string>] [-ProxyEnabled <bool>]
[-CompressionEnabled <bool>] [-SshEnabled <bool>] [-VstoreNameMap <Object>]
[-MaxBps <int>] [-MarkedForRemoval <bool>] [-ClusterId <long>]
[-ClusterIncarnationId <long>] [-ReplicationLinks <ReplicationLinkDTO[]>]
[-Capabilities <NewRemoteSite+Capabilities_Enum[]>] [-Status
<NewRemoteSite+Status_Enum>] [-LatencyInUsecs <long>] [-RemoteVStoreInfo
<Object>] [-MetroReady <bool>] [-BandwidthPolicy <BandwidthPolicyDTO>]
[-BandwidthPolicyEnabled <bool>] [-Stats <Object>] [-UsageStats <Object>]
[-NetworkMapping <NetworkMappingDTO>] [-ClusterExternalDataServicesIPAddress
> New-NTNXRemoteSite [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
Name of the remote site.
Uuid
Uuid of the remote site.
RemoteIpPorts
Dictionary having IP address as key and Port as value

CloudType
Cloud type
CredentialName
Credential Name
Region
Region
CvmName
CVM Name
ProxyEnabled
CompressionEnabled
SshEnabled
VstoreNameMap
Dictionary having map of local vStore to remote vStore
MaxBps
MarkedForRemoval
ClusterId
ReplicationLinks
Capabilities
Status
LatencyInUsecs
RemoteVStoreInfo
MetroReady
BandwidthPolicy
BandwidthPolicyEnabled
Stats
UsageStats
HealthSummary
AlertSummary
NetworkMapping
Template

Modify the configuration of the specified Remote Site
> Set-NTNXRemoteSite [[-Servers] <string[]>] [-Name <string>] [-Uuid <string>]
[-RemoteIpPorts <Object>] [-CloudType <SetRemoteSite+CloudType_Enum>]
[-CredentialName <string>] [-Region <string>] [-CvmName <string>]
[-ProxyEnabled <bool>] [-CompressionEnabled <bool>] [-SshEnabled <bool>]
[-VstoreNameMap <Object>] [-MaxBps <int>] [-MarkedForRemoval <bool>]
[-ClusterId <long>] [-ClusterIncarnationId <long>] [-ReplicationLinks
<ReplicationLinkDTO[]>] [-Capabilities <SetRemoteSite+Capabilities_Enum[]>]
[-Status <SetRemoteSite+Status_Enum>] [-LatencyInUsecs <long>]
[-RemoteVStoreInfo <Object>] [-MetroReady <bool>] [-BandwidthPolicy
<BandwidthPolicyDTO>] [-BandwidthPolicyEnabled <bool>] [-Stats <Object>]
[-UsageStats <Object>] [-HealthSummary <HealthSummaryDTO>] [-AlertSummary
<AlertSummaryDTO>] [-NetworkMapping <NetworkMappingDTO>]
[-ClusterExternalDataServicesIPAddress <string>] [-Operation <string>]
> Set-NTNXRemoteSite [-Name <string>] [-Uuid <string>] [-RemoteIpPorts

<Object>] [-CloudType <SetRemoteSite+CloudType_Enum>] [-CredentialName
<string>] [-Region <string>] [-CvmName <string>] [-ProxyEnabled <bool>]
[-CompressionEnabled <bool>] [-SshEnabled <bool>] [-VstoreNameMap <Object>]
[-MaxBps <int>] [-MarkedForRemoval <bool>] [-ClusterId <long>]
[-ClusterIncarnationId <long>] [-ReplicationLinks <ReplicationLinkDTO[]>]
[-Capabilities <SetRemoteSite+Capabilities_Enum[]>] [-Status
<SetRemoteSite+Status_Enum>] [-LatencyInUsecs <long>] [-RemoteVStoreInfo
<Object>] [-MetroReady <bool>] [-BandwidthPolicy <BandwidthPolicyDTO>]
[-BandwidthPolicyEnabled <bool>] [-Stats <Object>] [-UsageStats <Object>]
[-NetworkMapping <NetworkMappingDTO>] [-ClusterExternalDataServicesIPAddress
<string>] [-Operation <string>] [-GenericDTO <string>] [-ClusterUuid <string>]
> Set-NTNXRemoteSite [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
Name of the remote site.
Uuid
Uuid of the remote site.
RemoteIpPorts
Dictionary having IP address as key and Port as value
CloudType
Cloud type
CredentialName
Credential Name
Region
Region
CvmName
CVM Name

ProxyEnabled
CompressionEnabled
SshEnabled
VstoreNameMap
Dictionary having map of local vStore to remote vStore
MaxBps
MarkedForRemoval
ClusterId
ReplicationLinks
Capabilities
Status
LatencyInUsecs
RemoteVStoreInfo
MetroReady
BandwidthPolicy
BandwidthPolicyEnabled
Stats
UsageStats
HealthSummary
AlertSummary
NetworkMapping
Operation
GenericDTO
ClusterUuid
Template
Get the list of Remote Sites configured in the cluster

> Get-NTNXRemoteSite [[-Servers] <string[]>] [-Names <Object>]
[-MetroCompatible] [-FullDetails] [-RemoteContainers <Object>]
[-IncludeDeleted] [-Projection <Object>] [-RemoteSiteType <Object>] [-Name
> Get-NTNXRemoteSite [-Names <Object>] [-MetroCompatible] [-FullDetails]

[-RemoteContainers <Object>] [-IncludeDeleted] [-Projection <Object>]
[-RemoteSiteType <Object>] [-Name <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXRemoteSite [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the Remote Site
Optional arguments
Names
Remote Site names
MetroCompatible
Remote Site stretchable
FullDetails
Remote cluster detail
RemoteContainers
Remote container to fetch
IncludeDeleted
Include deleted
Projection
RemoteSiteType
Type of Remote site (legacy/entity-centric)
FullDetails
Remote cluster details
184
AOS | RemoteSiteAlert | 805

REMOTESITEALERT
Operations
• Get the list of alerts generated on any Remote Site: Get-NTNXRemoteSiteAlert
> Get-NTNXRemoteSiteAlert [[-Servers] <string[]>] [-Name <Object>]

> Get-NTNXRemoteSiteAlert [-Name <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXRemoteSiteAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
185
AOS | RemoteSiteEvent | 807

REMOTESITEEVENT
Operations
• Get the list of events generated on any Remote Site: Get-NTNXRemoteSiteEvent
> Get-NTNXRemoteSiteEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]

[-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-Name
> Get-NTNXRemoteSiteEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

[-Count <int>] [-Acknowledged] [-Page <int>] [-Name <Object>]
> Get-NTNXRemoteSiteEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
186
AOS | RemoteSiteForRemoval | 809

REMOTESITEFORREMOVAL
Operations
• Delete a Remote Site: Mark-NTNXRemoteSiteForRemoval
Delete a Remote Site with the specified name from the cluster
> Mark-NTNXRemoteSiteForRemoval [[-Servers] <string[]>] -Name <Object>
> Mark-NTNXRemoteSiteForRemoval [-Name <Object>] [-Template] [-ExpandedOutput]

> Mark-NTNXRemoteSiteForRemoval [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Optional arguments
Template
187
AOS | RemoteSiteHealthCheckSummary | 811

REMOTESITEHEALTHCHECKSUMMARY
Operations
• Get the health check summary for the Remote Sites: Get-NTNXRemoteSiteHealthCheckSummary
> Get-NTNXRemoteSiteHealthCheckSummary [[-Servers] <string[]>]

[-FilterCriteria <Object>] [-DetailedSummary] [-ExpandedOutput] [-GridView]
> Get-NTNXRemoteSiteHealthCheckSummary [-FilterCriteria <Object>]

[-DetailedSummary] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXRemoteSiteHealthCheckSummary [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
FilterCriteria
Filter criteria
DetailedSummary
Detailed summary
188
AOS | RemoteSitePendingReplication | 813

REMOTESITEPENDINGREPLICATION
Operations
• Get all pending replications: Get-NTNXRemoteSitePendingReplication
Get the list of backlogged/pending replications in the cluster

> Get-NTNXRemoteSitePendingReplication [[-Servers] <string[]>]
[-ProtectionDomainNames <Object>] [-RemoteSiteNames <Object>] [-Name <Object>]
> Get-NTNXRemoteSitePendingReplication [-ProtectionDomainNames <Object>]

[-RemoteSiteNames <Object>] [-Name <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXRemoteSitePendingReplication [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Optional arguments
Protection Domain Names
RemoteSiteNames
Remote Site Names
189
AOS | RemoteSiteSnapshot | 815

REMOTESITESNAPSHOT
Operations
• Get the list of Snapshots: Get-NTNXRemoteSiteSnapshot
Get the list of all Snapshots created in Remote Sites

> Get-NTNXRemoteSiteSnapshot [[-Servers] <string[]>] [-Count <int>]
[-FilterCriteria <Object>] [-SortCriteria <Object>] [-FullDetails] [-Name
> Get-NTNXRemoteSiteSnapshot [-Count <int>] [-FilterCriteria <Object>]

[-SortCriteria <Object>] [-FullDetails] [-Name <Object>] [-ExpandedOutput]
> Get-NTNXRemoteSiteSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Optional arguments
Count
Maximum number of DR Snapshots to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
FullDetails
Whether to include consistency group / vm details
190
AOS | RemoteSiteStat | 817

REMOTESITESTAT
Operations
• Get the stats for a specified Remote Site: Get-NTNXRemoteSiteStat
> Get-NTNXRemoteSiteStat [[-Servers] <string[]>] -Name <Object> -Metrics
> Get-NTNXRemoteSiteStat [-Name <Object>] [-Metrics <Object>]

> Get-NTNXRemoteSiteStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
191
AOS | RemoteSupportSetting | 819

REMOTESUPPORTSETTING
Operations
• Get Remote Support settings: Get-NTNXRemoteSupportSetting

• Update Remote Support settings: Set-NTNXRemoteSupportSetting
Get the status of Remote Support settings on the cluster

> Get-NTNXRemoteSupportSetting [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXRemoteSupportSetting [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Update the Remote Support settings on the cluster

> Set-NTNXRemoteSupportSetting [[-Servers] <string[]>] [-Enabled <bool>]
[-Duration <long>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXRemoteSupportSetting [-Enabled <bool>] [-Duration <long>]

> Set-NTNXRemoteSupportSetting [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Enabled
Duration
Time to keep enabled
Template
192
AOS | ServiceCenter | 821

SERVICECENTER
Operations
• Get the list of Service Centers: Get-NTNXServiceCenter

• Add a Service Center: New-NTNXServiceCenter
• Delete the specified Service Center: Remove-NTNXServiceCenter
• Update a Service Center: Set-NTNXServiceCenter
Update the specified Service Center

> Set-NTNXServiceCenter [[-Servers] <string[]>] -Name <string> -IpAddress
<string> -Username <string> -Port <int> [-ExpandedOutput] [-GridView]
> Set-NTNXServiceCenter [-Name <string>] [-IpAddress <string>] [-Username

<string>] [-Port <int>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXServiceCenter [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name.
IpAddress
Ip Address.
Username
username.
Port
Port number.
Optional arguments
Template
Add a Service Center to the cluster

> New-NTNXServiceCenter [[-Servers] <string[]>] -Name <string> -IpAddress
<string> -Username <string> -Port <int> [-ExpandedOutput] [-GridView]
> New-NTNXServiceCenter [-Name <string>] [-IpAddress <string>] [-Username

<string>] [-Port <int>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXServiceCenter [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name.
IpAddress
Ip Address.
Username
username.
Port
Port number.
Optional arguments
Template
Delete a Service Center with the specified name

> Remove-NTNXServiceCenter [[-Servers] <string[]>] -Name <Object>
> Remove-NTNXServiceCenter [-Name <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXServiceCenter [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of a Service Center
Optional arguments
Template
Get the list of Service Centers configured in the cluster

> Get-NTNXServiceCenter [[-Servers] <string[]>] [-Name <Object>]
> Get-NTNXServiceCenter [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXServiceCenter [[-NutanixClusters] <NutanixCluster[]>]


Required arguments
Name
Name of a Service Center
193
AOS | Share | 825

SHARE
Operations
• Get the Share: Get-NTNXShare

• Add new Share: New-NTNXShare
• Delete Share: Remove-NTNXShare
• Update share configuration: Set-NTNXShare
Add new Share

> New-NTNXShare [[-Servers] <string[]>] -Name <string> [-Uuid <string>]
[-Description <string>] [-FileServerUuid <string>] [-EnablePreviousVersion
<bool>] [-ContainerId <string>] [-ContainerUuid <string>] [-ShareType
<NewShare+ShareType_Enum>] [-MaxSizeGiB <long>] [-DefaultQuotaLimitGiB
<float>] [-QuotaEnforcementType <NewShare+QuotaEnforcementType_Enum>]
[-SendQuotaNotificationsToUser <bool>] [-EnableAccessBasedEnumeration <bool>]
[-EnableSmb3Encryption <bool>] [-ProtocolType
<NewShare+ShareProtocolType_Enum>] [-SecondaryProtocolType
<NewShare+ShareProtocolType_Enum>] [-SymlinkCreationEnabled <bool>]
[-SimultaneousAccessEnabled <bool>] [-CompressionEnabled <bool>] [-SharePath
<string>] [-ParentShareUuid <string>] [-AuthenticationType
<NewShare+AuthenticationType_Enum>] [-DefaultShareAccessType
<NewShare+DefaultShareAccessType_Enum>] [-ClientReadWrite <string>]
[-ClientReadOnly <string>] [-ClientNoAccess <string>] [-AnonymousUid <int>]
[-AnonymousGid <int>] [-SquashType <NewShare+SquashType_Enum>]
[-FileBlockingExtensions <string[]>] [-ExpandedOutput] [-GridView]
> New-NTNXShare [-Uuid <string>] [-Name <string>] [-Description <string>]

[-FileServerUuid <string>] [-EnablePreviousVersion <bool>] [-ContainerId
<string>] [-ContainerUuid <string>] [-ShareType <NewShare+ShareType_Enum>]
[-MaxSizeGiB <long>] [-DefaultQuotaLimitGiB <float>] [-QuotaEnforcementType
<NewShare+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser <bool>]
[-EnableAccessBasedEnumeration <bool>] [-EnableSmb3Encryption <bool>]
[-ProtocolType <NewShare+ShareProtocolType_Enum>] [-SecondaryProtocolType
<NewShare+ShareProtocolType_Enum>] [-SymlinkCreationEnabled <bool>]
[-SimultaneousAccessEnabled <bool>] [-CompressionEnabled <bool>] [-SharePath
<string>] [-ParentShareUuid <string>] [-AuthenticationType
<NewShare+AuthenticationType_Enum>] [-DefaultShareAccessType
<NewShare+DefaultShareAccessType_Enum>] [-ClientReadWrite <string>]
[-ClientReadOnly <string>] [-ClientNoAccess <string>] [-AnonymousUid <int>]
[-AnonymousGid <int>] [-SquashType <NewShare+SquashType_Enum>]
[-FileBlockingExtensions <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXShare [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the Share
AOS | Share | 826

Optional arguments
Uuid
Description
Description of the Share
FileServerUuid
EnablePreviousVersion
Enable self service restore flag
ContainerId
ContainerUuid
ShareType
Type of Share. Distributed or Standard (General Purpose)
MaxSizeGiB
Share size in Gibs
DefaultQuotaLimitGiB
Default quota limit in Gibs (Quota applies to all users of the share)
EnableAccessBasedEnumeration
Enable access based enumeration flag
EnableSmb3Encryption
Enable SMB3 Encryption
ProtocolType
SecondaryProtocolType
Secondary protocol type (SMB or NFS)
SymlinkCreationEnabled
Symlink Creation Enabled
SimultaneousAccessEnabled
Simultaneous Access Enabled
CompressionEnabled
Compression Enabled
SharePath
Share path for nested share
ParentShareUuid
UUID of parent share
AuthenticationType
Type of Share Authentication. (System-none, Kerberos)
DefaultShareAccessType
Type of Default Share Access. (Read-write, Read-only, No-Access)
AOS | Share | 827

ClientReadWrite
Comma-separated list of clients
ClientReadOnly
ClientNoAccess
AnonymousUid
Anonymous UID.
AnonymousGid
Anonymous GID.
SquashType
Squash Type.(root-squash,all-squash,none)
Comma-separated list of file blocking extensions.
Template
Update share configuration

> Set-NTNXShare [[-Servers] <string[]>] -Uuid <string> [-Name <string>]
[-EnablePreviousVersion <bool>] [-Description <string>] [-MaxSizeGiB <long>]
[-DefaultQuotaLimitGiB <float>] [-QuotaEnforcementType
<SetShare+QuotaEnforcementType_Enum>] [-SendQuotaNotificationsToUser <bool>]
[-EnableAccessBasedEnumeration <bool>] [-EnableSmb3Encryption <bool>]
[-ProtocolType <SetShare+ShareProtocolType_Enum>] [-SecondaryProtocolType
<SetShare+ShareProtocolType_Enum>] [-SymlinkCreationEnabled <bool>]
[-SimultaneousAccessEnabled <bool>] [-CompressionEnabled <bool>]
[-AuthenticationType <SetShare+AuthenticationType_Enum>]
[-DefaultShareAccessType <SetShare+DefaultShareAccessType_Enum>]
[-ClientReadWrite <string>] [-ClientReadOnly <string>] [-ClientNoAccess
<string>] [-AnonymousUid <int>] [-AnonymousGid <int>] [-SquashType
<SetShare+SquashType_Enum>] [-FileBlockingExtensions <string[]>]
> Set-NTNXShare [-Uuid <string>] [-Name <string>] [-EnablePreviousVersion

<bool>] [-Description <string>] [-MaxSizeGiB <long>] [-DefaultQuotaLimitGiB
<float>] [-QuotaEnforcementType <SetShare+QuotaEnforcementType_Enum>]
[-SendQuotaNotificationsToUser <bool>] [-EnableAccessBasedEnumeration <bool>]
[-EnableSmb3Encryption <bool>] [-ProtocolType
<SetShare+ShareProtocolType_Enum>] [-SecondaryProtocolType
<SetShare+ShareProtocolType_Enum>] [-SymlinkCreationEnabled <bool>]
[-SimultaneousAccessEnabled <bool>] [-CompressionEnabled <bool>]
[-AuthenticationType <SetShare+AuthenticationType_Enum>]
[-DefaultShareAccessType <SetShare+DefaultShareAccessType_Enum>]
[-ClientReadWrite <string>] [-ClientReadOnly <string>] [-ClientNoAccess
<string>] [-AnonymousUid <int>] [-AnonymousGid <int>] [-SquashType
<SetShare+SquashType_Enum>] [-FileBlockingExtensions <string[]>] [-Template]
> Set-NTNXShare [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

AOS | Share | 828

Required arguments
Uuid
Uuid of the Share
Optional arguments
Name
Name of the Share
EnablePreviousVersion
Enable self service restore flag
Description
Description of the Share
MaxSizeGiB
Share size in Gibs
DefaultQuotaLimitGiB
Default quota limit in Gibs (Quota applies to all users of the share)
EnableAccessBasedEnumeration
Enable access based enumeration flag
EnableSmb3Encryption
Enable SMB3 Encryption
ProtocolType
SecondaryProtocolType
Secondary protocol type (SMB or NFS)
SymlinkCreationEnabled
Symlink Creation Enabled
SimultaneousAccessEnabled
Simultaneous Access Enabled
CompressionEnabled
Compression Enabled
AuthenticationType
Type of Share Authentication. (System-none, Kerberos)
DefaultShareAccessType
Type of Default Share Access. (Read-write, Read-only, No-Access)
ClientReadWrite
ClientReadOnly
AOS | Share | 829

ClientNoAccess
AnonymousUid
Anonymous UID.
AnonymousGid
Anonymous GID.
SquashType
Squash Type.(root-squash,all-squash,none)
Comma-separated list of file blocking extensions.
Template
Delete Share
Required arguments
Uuid
uuid of the Share
Optional arguments
Force
force delete Share
Template
Get the Share with the specified uuid

> Get-NTNXShare [[-Servers] <string[]>] -Uuid <Object> [-Projection <Object>]
> Get-NTNXShare [-Uuid <Object>] [-Projection <Object>] [-ExpandedOutput]

> Get-NTNXShare [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
Optional arguments
Projection
194
AOS | ShareInfectedFile | 831

SHAREINFECTEDFILE
Operations
• Get a infected file: Get-NTNXShareInfectedFile
Get a infected file associated with a file server share

> Get-NTNXShareInfectedFile [[-Servers] <string[]>] -Uuid <Object>
-InfectedFileUuid <Object> [-Quarantined] [-ExpandedOutput] [-GridView]
> Get-NTNXShareInfectedFile [-Uuid <Object>] [-InfectedFileUuid <Object>]

[-Quarantined] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXShareInfectedFile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
InfectedFileUuid
uuid of the infected file
Optional arguments
Quarantined
Quarantined
195
AOS | ShareInfectedFiles | 833

SHAREINFECTEDFILES
Operations
• Get the list of infected files: Get-NTNXShareInfectedFiles
Get the list of infected files associated with a file server share
> Get-NTNXShareInfectedFiles [[-Servers] <string[]>] -Uuid <Object>
-Quarantined [-Count <long>] [-Page <long>] [-FilterCriteria <Object>]
[-SearchString <Object>] [-Projection <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXShareInfectedFiles [-Uuid <Object>] [-Quarantined] [-Count <long>]

[-Page <long>] [-FilterCriteria <Object>] [-SearchString <Object>]
> Get-NTNXShareInfectedFiles [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Quarantined
Quarantined
Optional arguments
Count
Number of infected files to retrieve
Page
Page number
FilterCriteria
Filter criteria
SearchString
Search string
Projection
196
AOS | ShareStat | 835

SHARESTAT
Operations
• Get the stats for a specified share: Get-NTNXShareStat
> Get-NTNXShareStat [[-Servers] <string[]>] -Uuid <Object> -Metrics <Object>
> Get-NTNXShareStat [-Uuid <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXShareStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
uuid of the share
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
197
AOS | ShareVirusScanPolicies | 837

SHAREVIRUSSCANPOLICIES
Operations
• Add Virus Scan Policy: Add-NTNXShareVirusScanPolicies

• Update Virus Scan Policy: Update-NTNXShareVirusScanPolicies
Update Virus Scan Policy

> Update-NTNXShareVirusScanPolicies [[-Servers] <string[]>] -Uuid <Object>
[-ScanTimeoutIntervalInSecs <int>] [-VirusScanPolicy_Uuid <string>]
[-FileServerUuid <string>] [-ShareUuid <string>] [-ScanOnWrite <bool>]
[-ScanOnRead <bool>] [-FileSizeExclusion <long>] [-BlockAccessFile <bool>]
[-EnableAntiVirus <bool>] [-FileTypeExclusions <string[]>] [-ExpandedOutput]
> Update-NTNXShareVirusScanPolicies [-Uuid <Object>]

[-EnableAntiVirus <bool>] [-FileTypeExclusions <string[]>] [-Template]
> Update-NTNXShareVirusScanPolicies [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the share that virus scan policy is associated with
Optional arguments
ScanTimeoutIntervalInSecs
Scan time interval in uses
Uuid
FileServerUuid
ShareUuid
Uuid of the Share
ScanOnWrite
Scan on write policy
ScanOnRead
Scan on read policy
FileSizeExclusion
File size exclusion
BlockAccessFile
Block access file
EnableAntiVirus
Enable antivirus

FileTypeExclusions
File type exclusion list
Template

> Add-NTNXShareVirusScanPolicies [[-Servers] <string[]>] -Uuid <Object>
> Add-NTNXShareVirusScanPolicies [-Uuid <Object>] [-ScanTimeoutIntervalInSecs

<int>] [-VirusScanPolicy_Uuid <string>] [-FileServerUuid <string>] [-ShareUuid
<string>] [-ScanOnWrite <bool>] [-ScanOnRead <bool>] [-FileSizeExclusion
<long>] [-BlockAccessFile <bool>] [-EnableAntiVirus <bool>]
[-FileTypeExclusions <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXShareVirusScanPolicies [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Uuid
FileServerUuid
ShareUuid
Uuid of the Share
ScanOnWrite
ScanOnRead
Scan on read policy
FileSizeExclusion
File size exclusion
BlockAccessFile
Block access file
EnableAntiVirus
Enable antivirus
FileTypeExclusions

Template
198
AOS | ShareVirusScanPolicy | 841

SHAREVIRUSSCANPOLICY
Operations
• Get a virus scan policy: Get-NTNXShareVirusScanPolicy
Get a single virus scan policy associated with a file server

> Get-NTNXShareVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object>
> Get-NTNXShareVirusScanPolicy [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXShareVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
199
AOS | Shares | 843

SHARES
Operations
• Get the list of Shares: Get-NTNXShares

> Get-NTNXShares [[-Servers] <string[]>] [-Count <int>] [-FilterCriteria
<Object>] [-SearchString <Object>] [-SearchAttributeList <Object>]
> Get-NTNXShares [-Count <int>] [-FilterCriteria <Object>] [-SearchString

<Object>] [-SearchAttributeList <Object>] [-Projection <Object>]
> Get-NTNXShares [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Count
FilterCriteria
Filter criteria
SearchString
Search string
SearchAttributeList
Projection
200
AOS | SmtpServer | 845

SMTPSERVER
Operations
• Get the SMTP server config: Get-NTNXSmtpServer

• Delete SMTP server config: Remove-NTNXSmtpServer
• Modify the SMTP server config: Set-NTNXSmtpServer
Get the SMTP server configuration

> Get-NTNXSmtpServer [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXSmtpServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Modify the SMTP server configuration

> Set-NTNXSmtpServer [[-Servers] <string[]>] [-Address <string>] [-Port <int>]
[-Username <string>] [-Password <string>] [-SecureMode
<SetSmtpServer+SecurityMode_Enum>] [-FromEmailAddress <string>] [-EmailStatus
<CommunicationStatusDTO>] [-Operation <string>] [-GenericDTO <string>]
> Set-NTNXSmtpServer [-Address <string>] [-Port <int>] [-Username <string>]

[-Password <string>] [-SecureMode <SetSmtpServer+SecurityMode_Enum>]
[-FromEmailAddress <string>] [-EmailStatus <CommunicationStatusDTO>]
[-Operation <string>] [-GenericDTO <string>] [-ClusterUuid <string>]
> Set-NTNXSmtpServer [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Address
Port
Username
Password
SecureMode
FromEmailAddress
EmailStatus

Operation
GenericDTO
ClusterUuid
Template
Delete the SMTP server configuration

> Remove-NTNXSmtpServer [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Remove-NTNXSmtpServer [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXSmtpServer [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Template

201
AOS | SmtpServerSecurityModeType | 848

SMTPSERVERSECURITYMODETYPE
Operations
• Get the SMTP security modes: Get-NTNXSmtpServerSecurityModeType
Get the list of supported security modes for the SMTP server
> Get-NTNXSmtpServerSecurityModeType [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXSmtpServerSecurityModeType [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
AOS | SmtpServerSecurityModeType | 849

202
AOS | Snapshot | 850

SNAPSHOT
Operations
• Clone a Snapshot: Clone-NTNXSnapshot

• Get a list of snapshots in a cluster: Get-NTNXSnapshot
• Create Virtual Machine snapshots: New-NTNXSnapshot
• Delete a snapshot: Remove-NTNXSnapshot
• Restore Virtual Machines and/or NFS files: Restore-NTNXSnapshot
Clone a Snapshot
If a UUID is specified for the cloned snapshot, then the operation will be idempotent. If
overrideNetworkConfig is set to true in the clone spec, then the source snapshot's network
configuration is overridden by one specified in the nic list. If false, the clone will inherit its basic
network configuration from the source, minus MAC and IP address. This is also an asynchronous
operation that results in the creation of a task object.This is also an asynchronous operation
that results in the creation of a task object. The UUID of this task object is returned as the
response of this operation. This task can be monitored by using the /tasks/poll API.
> Clone-NTNXSnapshot [[-Servers] <string[]>] -Uuid <Object> [-SpecList
<VMCloneSpecDTO[]>] [-SnapshotClone_Uuid <string>] [-ExpandedOutput]
> Clone-NTNXSnapshot [-Uuid <Object>] [-SpecList <VMCloneSpecDTO[]>]

[-SnapshotClone_Uuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Clone-NTNXSnapshot [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
Id of the Snapshot
Optional arguments
SpecList
List of clone specifications.
Uuid
UUID of the Snapshot.
Template
Delete a snapshot
This operation is idempotent. The logical timestamp can optionally be provided for consistency.
If a logical timestamp is specified, then this operation will be rejected if the logical timestamp
specified is not the value of the snapshot logical timestamp. This is also an asynchronous

operation that results in the creation of a task object. The UUID of this task object is returned as
the response of this operation. This task can be monitored by using the /tasks/poll API.
> Remove-NTNXSnapshot [[-Servers] <string[]>] -Uuid <Object>
> Remove-NTNXSnapshot [-Uuid <Object>] [-LogicalTimestamp <long>] [-Template]

> Remove-NTNXSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Id of the Snapshot
Optional arguments
LogicalTimestamp
Logical timestamp
Template
Get a list of snapshots in a cluster

> Get-NTNXSnapshot [[-Servers] <string[]>] [-Uuid <Object>] [-ExpandedOutput]
> Get-NTNXSnapshot [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnapshot [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
Id of the Snapshot
Create Virtual Machine snapshots

If a UUID is specified for the snapshot, this operation will be idempotent. If multiple VMs are
specified, all of their configurations and disks will fall into the same consistency group. Since
this operation requires the coordination of multiple resources, it should not be abused by
specifying more than several VMs at a time. Snapshots are crash-consistent. They do not
include the VM's current memory image, only the VM configuration and its disk contents. The
snapshot is taken atomically across all of a VM's configuration and disks to ensure consistency.
This is also an asynchronous operation that results in the creation of a task object. The UUID
of this task object is returned as the response of this operation. This task can be monitored by
using the /tasks/poll API.
> New-NTNXSnapshot [[-Servers] <string[]>] [-SnapshotSpecs
<SnapshotSpecDTO[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> New-NTNXSnapshot [-SnapshotSpecs <SnapshotSpecDTO[]>] [-Template]

> New-NTNXSnapshot [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
SnapshotSpecs
List of snapshot specifications. All disks for all Virtual Machines are treated as a
single consistency group for the vdisk snapshot
Template
Restore Virtual Machines and/or NFS files in a Protection Domain to a given Snapshot
> Restore-NTNXSnapshot [[-Servers] <string[]>] -PdName <Object> -SnapshotId
<Object> [-VmNames <string[]>] [-NfsFiles <string[]>] [-VolumeGroupUuids
<string[]>] [-Replace <bool>] [-PathPrefix <string>] [-VmNamePrefix <string>]
[-VgNamePrefix <string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Restore-NTNXSnapshot [-PdName <Object>] [-SnapshotId <Object>] [-VmNames

<string[]>] [-NfsFiles <string[]>] [-VolumeGroupUuids <string[]>] [-Replace
<bool>] [-PathPrefix <string>] [-VmNamePrefix <string>] [-VgNamePrefix
> Restore-NTNXSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
SnapshotId
Snapshot Id
Optional arguments
VmNames
Names of VM to be restored.
VmUuids
Uuids of VM to be restored.
NfsFiles
Names of NFS files to be restored
VolumeGroupUuids
UUIDs of Volume Groups to be restored
Replace
Whether to replace entities.

PathPrefix
Path prefix to be applied for cloning VMs. It is recommended to not use
path_prefix while restoring a virtual machine or volume group.
VmNamePrefix
Name prefix to be applied for cloning VMs.
VgNamePrefix
Name prefix to be applied for cloning VGs.
SnapshotId
Id of the snapshot to restore entities from.
Template
203
AOS | SnapshotForVDisk | 855

SNAPSHOTFORVDISK
Operations
• Snapshot a VDisk: Add-NTNXSnapshotForVDisk

• Get the list of Snapshots: Get-NTNXSnapshotForVDisk
Create a Snapshot for the specified VDisk

> Add-NTNXSnapshotForVDisk [[-Servers] <string[]>] -Name <Object> -Arg1
> Add-NTNXSnapshotForVDisk [-Name <Object>] [-Arg1 <string>] [-Template]

> Add-NTNXSnapshotForVDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the VDisk
Arg1
Optional arguments
Template
Get the list of Snapshots for the specified VDisk

> Get-NTNXSnapshotForVDisk [[-Servers] <string[]>] -Name <Object>
> Get-NTNXSnapshotForVDisk [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnapshotForVDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the VDisk
204
AOS | SnapshotInfo | 857

SNAPSHOTINFO
Operations
• Get File server snapshot info: Get-NTNXSnapshotInfo
Get File server snapshot info

> Get-NTNXSnapshotInfo [[-Servers] <string[]>] [-PdName <string>]
[-SnapshotUuids <string[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXSnapshotInfo [-PdName <string>] [-SnapshotUuids <string[]>]

> Get-NTNXSnapshotInfo [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
PdName
SnapshotUuids
Template
205
AOS | SnapshotPolicies | 859

SNAPSHOTPOLICIES
Operations
• Get the list of snapshot policies: Get-NTNXSnapshotPolicies
Get the list of snapshot policies associated with a file server

> Get-NTNXSnapshotPolicies [[-Servers] <string[]>] -Uuid <Object>
> Get-NTNXSnapshotPolicies [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnapshotPolicies [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
206
AOS | SnapshotPolicy | 861

SNAPSHOTPOLICY
Operations
• Add new Snapshot Policy: Add-NTNXSnapshotPolicy

• Delete Snapshot Policy: Remove-NTNXSnapshotPolicy
• Update Snapshot Policy: Update-NTNXSnapshotPolicy
Add new Snapshot Policy

> Add-NTNXSnapshotPolicy [[-Servers] <string[]>] -Uuid <Object>
-SnapshotPolicyType <AddSnapshotPolicy+SnapshotPolicyScheduleType_Enum>
-SnapshotPolicyFrequency <int> -LocalMaxSnapshots <int> [-DaysOfWeek <int[]>]
[-DaysOfMonth <int[]>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Add-NTNXSnapshotPolicy [-Uuid <Object>] [-SnapshotPolicyType

<AddSnapshotPolicy+SnapshotPolicyScheduleType_Enum>] [-SnapshotPolicyFrequency
<int>] [-DaysOfWeek <int[]>] [-DaysOfMonth <int[]>] [-LocalMaxSnapshots <int>]
> Add-NTNXSnapshotPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that snapshot policy is associated with
SnapshotPolicyType
Snapshot policy type - hourly, daily, weekly, monthly
SnapshotPolicyFrequency
Snapshot policy frequency. Repeat snapshot every nth hour/day. For weekly and
monthly, frequency is 1.
LocalMaxSnapshots
Maximum number of snapshots to retain locally
Optional arguments
DaysOfWeek
Comma-separated day of week values for the schedule: 1-7 (starts with
Sunday(1))
DaysOfMonth
Comma-separated day of month values for the schedule: 1-31
Template
Update Snapshot Policy

> Update-NTNXSnapshotPolicy [[-Servers] <string[]>] -Uuid <Object>
-SnapshotPolicy_Uuid <string> [-SnapshotPolicyType

<UpdateSnapshotPolicy+SnapshotPolicyScheduleType_Enum>]
[-SnapshotPolicyFrequency <int>] [-DaysOfWeek <int[]>] [-DaysOfMonth <int[]>]
[-LocalMaxSnapshots <int>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXSnapshotPolicy [-Uuid <Object>] [-SnapshotPolicy_Uuid <string>]

[-SnapshotPolicyType <UpdateSnapshotPolicy+SnapshotPolicyScheduleType_Enum>]
[-SnapshotPolicyFrequency <int>] [-DaysOfWeek <int[]>] [-DaysOfMonth <int[]>]
[-LocalMaxSnapshots <int>] [-Template] [-ExpandedOutput] [-GridView]
> Update-NTNXSnapshotPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid
Uuid of the Snapshot Policy
Optional arguments
SnapshotPolicyType
Snapshot policy type - hourly, daily, weekly, monthly
SnapshotPolicyFrequency
Snapshot policy frequency. Repeat snapshot every nth hour/day. For weekly and
monthly, frequency is 1.
DaysOfWeek
Comma-separated day of week values for the schedule: 1-7 (starts with
Sunday(1))
DaysOfMonth
Comma-separated day of month values for the schedule: 1-31
LocalMaxSnapshots
Maximum number of snapshots to retain locally
Template
Delete Snapshot Policy

> Remove-NTNXSnapshotPolicy [[-Servers] <string[]>] -Uuid <Object>
-SnapshotPolicyUuid <Object> [-ExpandedOutput] [-GridView]
> Remove-NTNXSnapshotPolicy [-Uuid <Object>] [-SnapshotPolicyUuid <Object>]

> Remove-NTNXSnapshotPolicy [[-NutanixClusters] <NutanixCluster[]>]


Required arguments
Uuid
SnapshotPolicyUuid
uuid of the snapshot policy
Optional arguments
Template
207
AOS | SnmpInfo | 865

SNMPINFO
Operations
• Get SNMP configuration: Get-NTNXSnmpInfo
Get the complete SNMP configuration including Users, Transports and Traps configured in the
cluster
> Get-NTNXSnmpInfo [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXSnmpInfo [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
208
AOS | SnmpProfile | 867

SNMPPROFILE
Operations
• Get the list of SNMP Profiles: Get-NTNXSnmpProfile

• Add new SNMP Profile: New-NTNXSnmpProfile
• Delete SNMP Profile: Remove-NTNXSnmpProfile
• Update SNMP Profile: Set-NTNXSnmpProfile
Add new SNMP Profile

> New-NTNXSnmpProfile [[-Servers] <string[]>] -Name <string> [-Uuid <string>]
[-DefaultProfile <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> New-NTNXSnmpProfile [-Name <string>] [-Uuid <string>] [-DefaultProfile

> New-NTNXSnmpProfile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
SNMP profile name
Optional arguments
Uuid
SNMP profile UUID
DefaultProfile
Used as Default SNMP profile
Template
Get the list of SNMP Profiles configured in the cluster

> Get-NTNXSnmpProfile [[-Servers] <string[]>] [-Uuid <Object>]
> Get-NTNXSnmpProfile [-Uuid <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnmpProfile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
UUID of the SNMP Profile

Optional arguments
Uuid
Delete SNMP Profile

> Remove-NTNXSnmpProfile [[-Servers] <string[]>] -Uuid <Object>
> Remove-NTNXSnmpProfile [-Uuid <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXSnmpProfile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Template
Update SNMP Profile

> Set-NTNXSnmpProfile [[-Servers] <string[]>] -Uuid <string> [-Name <string>]
[-DefaultProfile <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXSnmpProfile [-Name <string>] [-Uuid <string>] [-DefaultProfile

> Set-NTNXSnmpProfile [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
SNMP profile UUID
Optional arguments
Name
SNMP profile name
DefaultProfile
Used as Default SNMP profile
Template

209
AOS | SnmpStatus | 870

SNMPSTATUS
Operations
• Get the SNMP status: Get-NTNXSnmpStatus

• Enable/Disable SNMP configuration: Set-NTNXSnmpStatus
Enable/Disable SNMP configuration in the cluster

> Set-NTNXSnmpStatus [[-Servers] <string[]>] -Arg0 <bool> [-ExpandedOutput]
> Set-NTNXSnmpStatus [-Arg0 <bool>] [-Template] [-ExpandedOutput] [-GridView]

> Set-NTNXSnmpStatus [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Arg0
Optional arguments
Template
Get the SNMP status

> Get-NTNXSnmpStatus [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXSnmpStatus [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
AOS | SnmpStatus | 871

210
AOS | SnmpTransport | 872

SNMPTRANSPORT
Operations
• Add SNMP Transports: Add-NTNXSnmpTransport

• Get the list of SNMP Transports: Get-NTNXSnmpTransport
• Remove SNMP Transports: Remove-NTNXSnmpTransport
Remove SNMP Transports from the existing SNMP Transports

> Remove-NTNXSnmpTransport [[-Servers] <string[]>] -TransportProtocol
<RemoveSnmpTransport+TransportProtocol_Enum> -Port <int> [-ExpandedOutput]
> Remove-NTNXSnmpTransport [-TransportProtocol

<RemoveSnmpTransport+TransportProtocol_Enum>] [-Port <int>] [-Template]
> Remove-NTNXSnmpTransport [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
TransportProtocol
Transport protocol dto.
Port
Port number.
Optional arguments
Template
Add SNMP Transports to the existing SNMP Transports

> Add-NTNXSnmpTransport [[-Servers] <string[]>] -TransportProtocol
<AddSnmpTransport+TransportProtocol_Enum> -Port <int> [-ExpandedOutput]
> Add-NTNXSnmpTransport [-TransportProtocol

<AddSnmpTransport+TransportProtocol_Enum>] [-Port <int>] [-Template]
> Add-NTNXSnmpTransport [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
TransportProtocol
Transport protocol dto.
AOS | SnmpTransport | 873

Port
Port number.
Optional arguments
Template
Get the list of SNMP Transports configured in the cluster

> Get-NTNXSnmpTransport [[-Servers] <string[]>] [-ExpandedOutput] [-GridView]
> Get-NTNXSnmpTransport [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
211
AOS | SnmpTrap | 875

SNMPTRAP
Operations
• Add SNMP Trap: Add-NTNXSnmpTrap

• Get the list of SNMP Traps: Get-NTNXSnmpTrap
• Delete SNMP Trap: Remove-NTNXSnmpTrap
• Modify SNMP Trap: Set-NTNXSnmpTrap
Get the list of SNMP Traps configured in the cluster

> Get-NTNXSnmpTrap [[-Servers] <string[]>] [-TrapAddress <Object>]
> Get-NTNXSnmpTrap [-TrapAddress <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnmpTrap [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
TrapAddress
Address of the SNMP Trap
Delete SNMP Trap with the specified address

> Remove-NTNXSnmpTrap [[-Servers] <string[]>] -TrapAddress <Object>
> Remove-NTNXSnmpTrap [-TrapAddress <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXSnmpTrap [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
TrapAddress
Address of the SNMP Trap
Optional arguments
Template
Modify the specified SNMP Trap

> Set-NTNXSnmpTrap [[-Servers] <string[]>] -TrapAddress <string>
[-TrapUsername <string>] [-TransportProtocol
<SetSnmpTrap+TransportProtocol_Enum>] [-Port <int>] [-Inform <bool>]
[-EngineId <string>] [-Version <SetSnmpTrap+SnmpVersion_Enum>]

[-CommunityString <string>] [-ReceiverName <string>] [-Operation <string>]
> Set-NTNXSnmpTrap [-TrapAddress <string>] [-TrapUsername <string>]

[-TransportProtocol <SetSnmpTrap+TransportProtocol_Enum>] [-Port <int>]
[-Inform <bool>] [-EngineId <string>] [-Version
<SetSnmpTrap+SnmpVersion_Enum>] [-CommunityString <string>] [-ReceiverName
<string>] [-Operation <string>] [-GenericDTO <string>] [-ClusterUuid <string>]
> Set-NTNXSnmpTrap [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
TrapAddress
Trap address.
Optional arguments
TrapUsername
Trap Username.
TransportProtocol
Port
Port number.
Inform
EngineId
Version
SNMP version.
CommunityString
ReceiverName
Operation
GenericDTO
ClusterUuid
Template
Add SNMP Trap to the cluster

> Add-NTNXSnmpTrap [[-Servers] <string[]>] -TrapAddress <string>
[-TrapUsername <string>] [-TransportProtocol
<AddSnmpTrap+TransportProtocol_Enum>] [-Port <int>] [-Inform <bool>]
[-EngineId <string>] [-Version <AddSnmpTrap+SnmpVersion_Enum>]
[-CommunityString <string>] [-ReceiverName <string>] [-ExpandedOutput]
> Add-NTNXSnmpTrap [-TrapAddress <string>] [-TrapUsername <string>]

[-TransportProtocol <AddSnmpTrap+TransportProtocol_Enum>] [-Port <int>]

[-Inform <bool>] [-EngineId <string>] [-Version
<AddSnmpTrap+SnmpVersion_Enum>] [-CommunityString <string>] [-ReceiverName
> Add-NTNXSnmpTrap [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
TrapAddress
Trap address.
Optional arguments
TrapUsername
Trap Username.
TransportProtocol
Port
Port number.
Inform
EngineId
Version
SNMP version.
CommunityString
ReceiverName
Template
212
AOS | SnmpUser | 879

SNMPUSER
Operations
• Add SNMP User: Add-NTNXSnmpUser

• Get the list of SNMP Users: Get-NTNXSnmpUser
• Delete SNMP User: Remove-NTNXSnmpUser
• Modify SNMP User: Set-NTNXSnmpUser
Get the list of SNMP Users configured in the cluster

> Get-NTNXSnmpUser [[-Servers] <string[]>] [-Username <Object>]
> Get-NTNXSnmpUser [-Username <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXSnmpUser [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Username
Name of the SNMP User
Delete SNMP User with the specified name

> Remove-NTNXSnmpUser [[-Servers] <string[]>] -Username <Object>
> Remove-NTNXSnmpUser [-Username <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXSnmpUser [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Username
Name of the SNMP User
Optional arguments
Template
Modify the specified SNMP User

> Set-NTNXSnmpUser [[-Servers] <string[]>] -Username <string> -AuthType
<SetSnmpUser+AuthorizationType_Enum> -AuthKey <string> [-PrivType
<SetSnmpUser+PriviligeType_Enum>] [-PrivKey <string>] [-Operation <string>]

> Set-NTNXSnmpUser [-Username <string>] [-AuthType

<SetSnmpUser+AuthorizationType_Enum>] [-AuthKey <string>] [-PrivType
<SetSnmpUser+PriviligeType_Enum>] [-PrivKey <string>] [-Operation <string>]
> Set-NTNXSnmpUser [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Username
User name.
AuthType
Authorization type dto.
AuthKey
Authentication key.
Optional arguments
PrivType
PrivKey
Operation
GenericDTO
ClusterUuid
Template
Add SNMP User to the cluster

> Add-NTNXSnmpUser [[-Servers] <string[]>] -Username <string> -AuthType
<AddSnmpUser+AuthorizationType_Enum> -AuthKey <string> [-PrivType
<AddSnmpUser+PriviligeType_Enum>] [-PrivKey <string>] [-ExpandedOutput]
> Add-NTNXSnmpUser [-Username <string>] [-AuthType

<AddSnmpUser+AuthorizationType_Enum>] [-AuthKey <string>] [-PrivType
<AddSnmpUser+PriviligeType_Enum>] [-PrivKey <string>] [-Template]
> Add-NTNXSnmpUser [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Username
User name.

AuthType
Authorization type dto.
AuthKey
Authentication key.
Optional arguments
PrivType
PrivKey
Template
213
AOS | SpotlightSearchResult | 883

SPOTLIGHTSEARCHRESULT
Operations
• Get spotlight search results: Get-NTNXSpotlightSearchResult
Perform a spotlight search on the cluster

> Get-NTNXSpotlightSearchResult [[-Servers] <string[]>] -SearchString <Object>
[-EntityTypes <Object>] [-FieldNames <Object>] [-MaxCount <int>]
> Get-NTNXSpotlightSearchResult [-SearchString <Object>] [-EntityTypes

<Object>] [-FieldNames <Object>] [-MaxCount <int>] [-ExpandedOutput]
> Get-NTNXSpotlightSearchResult [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SearchString
Search string
Optional arguments
EntityTypes
Entity types
FieldNames
Field Names
MaxCount
Maximum entities to retrieve, the default value is 100
214
AOS | StorageAlert | 885

STORAGEALERT
Operations
• Get the list of storage Alerts: Get-NTNXStorageAlert
Get the list of storage Alerts generated in the cluster

> Get-NTNXStorageAlert [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
> Get-NTNXStorageAlert [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

> Get-NTNXStorageAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
215
AOS | StorageEvent | 887

STORAGEEVENT
Operations
• Get the list of storage Events: Get-NTNXStorageEvent
Get the list of storage Events generated in the cluster

> Get-NTNXStorageEvent [[-Servers] <string[]>] [-StartTimeInUsecs <long>]
> Get-NTNXStorageEvent [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]

> Get-NTNXStorageEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
216
AOS | StoragePool | 889

STORAGEPOOL
Operations
• Get the list of Storage Pools: Get-NTNXStoragePool

• Add a Storage Pool: New-NTNXStoragePool
• Delete a Storage Pool: Remove-NTNXStoragePool
• Update a Storage Pool: Set-NTNXStoragePool
Delete a Storage Pool with the specified id from the cluster

> Remove-NTNXStoragePool [[-Servers] <string[]>] -Id <Object>
> Remove-NTNXStoragePool [-Id <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXStoragePool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of the Storage Pool
Optional arguments
Template
Get the list of Storage Pools configured in the cluster

> Get-NTNXStoragePool [[-Servers] <string[]>] [-Count <int>] [-FilterCriteria
<Object>] [-SortCriteria <Object>] [-SearchString <Object>]
[-SearchAttributeList <Object>] [-Page <int>] [-Projection <Object>] [-Id
> Get-NTNXStoragePool [-Count <int>] [-FilterCriteria <Object>] [-SortCriteria

<int>] [-Projection <Object>] [-Id <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXStoragePool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of the Storage Pool

Optional arguments
Count
Number of Storage Pools to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
Projection
Add a Storage Pool to the cluster

> New-NTNXStoragePool [[-Servers] <string[]>] [-Force <bool>] [-Id <string>]
[-StoragePoolUuid <string>] [-Name <string>] [-Disks <string[]>] [-DiskUuids
<string[]>] [-Capacity <long>] [-ReservedCapacity <long>] [-MarkedForRemoval
<bool>] [-TierwiseFreeCapacityMap <Object>] [-IlmDownMigratePctThreshold
<int>] [-Stats <Object>] [-UsageStats <Object>] [-HealthSummary
<HealthSummaryDTO>] [-AlertSummary <AlertSummaryDTO>] [-ExpandedOutput]
> New-NTNXStoragePool [-Force <bool>] [-Id <string>] [-StoragePoolUuid

<string>] [-Name <string>] [-Disks <string[]>] [-DiskUuids <string[]>]
[-Capacity <long>] [-ReservedCapacity <long>] [-MarkedForRemoval <bool>]
[-TierwiseFreeCapacityMap <Object>] [-IlmDownMigratePctThreshold <int>]
[-Stats <Object>] [-UsageStats <Object>] [-HealthSummary <HealthSummaryDTO>]
[-AlertSummary <AlertSummaryDTO>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXStoragePool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Id
StoragePoolUuid
Name
Disks
DiskUuids
Capacity

ReservedCapacity
MarkedForRemoval
TierwiseFreeCapacityMap
IlmDownMigratePctThreshold
Stats
UsageStats
HealthSummary
AlertSummary
Force
Force the operation
Template
Update the specified Storage Pool

> Set-NTNXStoragePool [[-Servers] <string[]>] [-Force <bool>] [-Id <string>]
[-StoragePoolUuid <string>] [-Name <string>] [-Disks <string[]>] [-DiskUuids
<string[]>] [-Capacity <long>] [-ReservedCapacity <long>] [-MarkedForRemoval
<bool>] [-TierwiseFreeCapacityMap <Object>] [-IlmDownMigratePctThreshold
<int>] [-Stats <Object>] [-UsageStats <Object>] [-HealthSummary
<HealthSummaryDTO>] [-AlertSummary <AlertSummaryDTO>] [-Operation <string>]
> Set-NTNXStoragePool [-Force <bool>] [-Id <string>] [-StoragePoolUuid

<string>] [-Name <string>] [-Disks <string[]>] [-DiskUuids <string[]>]
[-Capacity <long>] [-ReservedCapacity <long>] [-MarkedForRemoval <bool>]
[-TierwiseFreeCapacityMap <Object>] [-IlmDownMigratePctThreshold <int>]
[-Stats <Object>] [-UsageStats <Object>] [-HealthSummary <HealthSummaryDTO>]
[-AlertSummary <AlertSummaryDTO>] [-Operation <string>] [-GenericDTO <string>]
> Set-NTNXStoragePool [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Id
StoragePoolUuid
Name
Disks
DiskUuids

Capacity
ReservedCapacity
MarkedForRemoval
TierwiseFreeCapacityMap
IlmDownMigratePctThreshold
Stats
UsageStats
HealthSummary
AlertSummary
Operation
GenericDTO
ClusterUuid
Force
Force the operation
Template

217
AOS | StoragePoolAlert | 894

STORAGEPOOLALERT
Operations
• Get the list of alerts generated on any Storage Pool: Get-NTNXStoragePoolAlert
> Get-NTNXStoragePoolAlert [[-Servers] <string[]>] [-Id <Object>]

> Get-NTNXStoragePoolAlert [-Id <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXStoragePoolAlert [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Id of a Storage Pool
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
AOS | StoragePoolAlert | 895

218
AOS | StoragePoolEvent | 896

STORAGEPOOLEVENT
Operations
• Get the list of events generated on any Storage Pool: Get-NTNXStoragePoolEvent
> Get-NTNXStoragePoolEvent [[-Servers] <string[]>] [-Id <Object>]

> Get-NTNXStoragePoolEvent [-Id <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXStoragePoolEvent [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
AOS | StoragePoolEvent | 897

219
AOS | StoragePoolStat | 898

STORAGEPOOLSTAT
Operations
• Get the stats for a specified Storage Pool: Get-NTNXStoragePoolStat
> Get-NTNXStoragePoolStat [[-Servers] <string[]>] -Id <Object> -Metrics
> Get-NTNXStoragePoolStat [-Id <Object>] [-Metrics <Object>]

> Get-NTNXStoragePoolStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | StoragePoolStat | 899

220
AOS | StretchFailureHandling | 900

STRETCHFAILUREHANDLING
Operations
• Change failure handling mode for a protection domain: Update-NTNXStretchFailureHandling
Change failure handling mode for a protection domain

> Update-NTNXStretchFailureHandling [[-Servers] <string[]>] -PdName <Object>
-FailureHandlingMode <UpdateStretchFailureHandling+FailureHandling_Enum>
[-LocalOnly <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXStretchFailureHandling [-PdName <Object>] [-FailureHandlingMode

<UpdateStretchFailureHandling+FailureHandling_Enum>] [-LocalOnly <bool>]
> Update-NTNXStretchFailureHandling [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
PdName
FailureHandlingMode
Failure handling mode (Modes : [Automatic, Manual, Witness])
Optional arguments
LocalOnly
Limit the configuration changes only to this cluster
Template
AOS | StretchFailureHandling | 901

221
AOS | Subnets | 902

SUBNETS
Operations
• Get a list of subnets: Get-NTNXSubnets
Get a list of subnets

> Get-NTNXSubnets [[-Servers] <string[]>] -CloudType <Object> -Region <Object>
[-CredentialName <Object>] [-Count <int>] [-FilterCriteria <Object>]
[-SortCriteria <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXSubnets [-CloudType <Object>] [-Region <Object>] [-CredentialName

> Get-NTNXSubnets [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
CloudType
Cloud type
Region
Region
Optional arguments
CredentialName
Count
Maximum number of subnets to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
AOS | Subnets | 903

222
AOS | Switch | 904

SWITCH
Operations
• Get the list of switches in the cluster: Get-NTNXSwitch
Get the switches information

> Get-NTNXSwitch [[-Servers] <string[]>] -SwitchId <Object> [-ConfigOnly]
> Get-NTNXSwitch [-SwitchId <Object>] [-ConfigOnly] [-ExpandedOutput]

> Get-NTNXSwitch [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
SwitchId
ID of the switch
Optional arguments
ConfigOnly
Config-only flag
SwitchId
ID of the switch
AOS | Switch | 905

223
AOS | SwitchCollectorConfig | 906

SWITCHCOLLECTORCONFIG
Operations
• Get the switch collector config: Get-NTNXSwitchCollectorConfig

• Update switch collector config: Set-NTNXSwitchCollectorConfig
Update switch collector config

> Set-NTNXSwitchCollectorConfig [[-Servers] <string[]>] [-Enabled <bool>]
[-ScheduleIntervalInSecs <int>] [-ScheduleDiscoveryInSecs <int>]
> Set-NTNXSwitchCollectorConfig [-Enabled <bool>] [-ScheduleIntervalInSecs

<int>] [-ScheduleDiscoveryInSecs <int>] [-Template] [-ExpandedOutput]
> Set-NTNXSwitchCollectorConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
Enabled
Enable/Disable switch collector
ScheduleIntervalInSecs
Scheduled interval to collect the switch stats (in seconds)
ScheduleDiscoveryInSecs
Switch discovery interval (in seconds)
Template
Get the switch collector config

> Get-NTNXSwitchCollectorConfig [[-Servers] <string[]>] [-ExpandedOutput]
> Get-NTNXSwitchCollectorConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
AOS | SwitchCollectorConfig | 907

224
AOS | SwitchConfig | 908

SWITCHCONFIG
Operations
• Add new switch configuration: New-NTNXSwitchConfig

• Delete switch configuration: Remove-NTNXSwitchConfig
• Update switch configuration: Set-NTNXSwitchConfig
Delete switch configuration

> Remove-NTNXSwitchConfig [[-Servers] <string[]>] -SwitchId <Object>
> Remove-NTNXSwitchConfig [-SwitchId <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXSwitchConfig [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SwitchId
ID of the switch
Optional arguments
Template
Update switch configuration

> Set-NTNXSwitchConfig [[-Servers] <string[]>] -Id <string> [-Uuid <string>]
[-Address <string>] [-SnmpProfileNameToApply <string>] [-HostAddresses
<string[]>] [-Name <string>] [-ManagementAddresses <string[]>] [-Description
<string>] [-ObjectId <string>] [-ContactInfo <string>] [-LocationInfo
<string>] [-VendorName <string>] [-Services <string>] [-Stats <Object>]
[-InterfaceIds <string[]>] [-InterfaceUuids <string[]>] [-ExpandedOutput]
> Set-NTNXSwitchConfig [-Id <string>] [-Uuid <string>] [-Address <string>]

[-SnmpProfileNameToApply <string>] [-HostAddresses <string[]>] [-Name
<string>] [-ManagementAddresses <string[]>] [-Description <string>] [-ObjectId
<string>] [-ContactInfo <string>] [-LocationInfo <string>] [-VendorName
<string>] [-Services <string>] [-Stats <Object>] [-InterfaceIds <string[]>]
[-InterfaceUuids <string[]>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXSwitchConfig [[-NutanixClusters] <NutanixCluster[]>]


Required arguments
Id
Switch ID
Optional arguments
Uuid
Address
Switch address
SnmpProfileNameToApply
SNMP profile name to apply on switch config
HostAddresses
List of comma-separated Host addresses which is connected to this switch
Name
ManagementAddresses
Description
ObjectId
ContactInfo
LocationInfo
VendorName
Services
Stats
InterfaceIds
InterfaceUuids
Template
Add new switch configuration

> New-NTNXSwitchConfig [[-Servers] <string[]>] -Address <string> [-Id
<string>] [-Uuid <string>] [-SnmpProfileNameToApply <string>] [-HostAddresses
<string[]>] [-Name <string>] [-ManagementAddresses <string[]>] [-Description
<string>] [-ObjectId <string>] [-ContactInfo <string>] [-LocationInfo
<string>] [-VendorName <string>] [-Services <string>] [-Stats <Object>]
[-InterfaceIds <string[]>] [-InterfaceUuids <string[]>] [-ExpandedOutput]
> New-NTNXSwitchConfig [-Id <string>] [-Uuid <string>] [-Address <string>]

[-SnmpProfileNameToApply <string>] [-HostAddresses <string[]>] [-Name
<string>] [-ManagementAddresses <string[]>] [-Description <string>] [-ObjectId
<string>] [-ContactInfo <string>] [-LocationInfo <string>] [-VendorName
<string>] [-Services <string>] [-Stats <Object>] [-InterfaceIds <string[]>]
[-InterfaceUuids <string[]>] [-Template] [-ExpandedOutput] [-GridView]

> New-NTNXSwitchConfig [[-NutanixClusters] <NutanixCluster[]>]
Required arguments
Address
Switch address
Optional arguments
Id
Switch ID
Uuid
SnmpProfileNameToApply
SNMP profile name to apply on switch config
HostAddresses
List of comma-separated Host addresses which is connected to this switch
Name
ManagementAddresses
Description
ObjectId
ContactInfo
LocationInfo
VendorName
Services
Stats
InterfaceIds
InterfaceUuids
Template

225
AOS | SwitchInterface | 912

SWITCHINTERFACE
Operations
• Get the list of switch interfaces in the switch: Get-NTNXSwitchInterface
Get the switch interfaces information

> Get-NTNXSwitchInterface [[-Servers] <string[]>] -SwitchId <Object> -PortId
> Get-NTNXSwitchInterface [-SwitchId <Object>] [-PortId <Object>]

> Get-NTNXSwitchInterface [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SwitchId
ID of the switch
PortId
port ID of the switch interface
Optional arguments
PortId
AOS | SwitchInterface | 913

226
AOS | SwitchInterfaceStat | 914

SWITCHINTERFACESTAT
Operations
• Get the switch interface: Get-NTNXSwitchInterfaceStat
Get the switch interface information

> Get-NTNXSwitchInterfaceStat [[-Servers] <string[]>] -SwitchId <Object>
-PortId <Object> -Metrics <Object> [-StartTimeInUsecs <long>] [-EndTimeInUsecs
<long>] [-IntervalInSecs <int>] [-ExpandedOutput] [-GridView]
> Get-NTNXSwitchInterfaceStat [-SwitchId <Object>] [-PortId <Object>]

[-Metrics <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs <long>]
> Get-NTNXSwitchInterfaceStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SwitchId
ID of the switch
PortId
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | SwitchInterfaceStat | 915

227
AOS | Tag | 916

TAG
Operations
• Get tags based on passed criteria: Get-NTNXTag

• Create a new tag: New-NTNXTag
• Remove a tag: Remove-NTNXTag
• Update a tag with new content: Set-NTNXTag
Completely replace an existing tag with a new tag, maintaining the current uuid
> Set-NTNXTag [[-Servers] <string[]>] -TagUuid <Object> [-Name <string>]
[-Description <string>] [-EntityType <string>] [-ExpandedOutput] [-GridView]
> Set-NTNXTag [-TagUuid <Object>] [-Name <string>] [-Description <string>]

[-EntityType <string>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXTag [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
TagUuid
Uuid of tag to update
Optional arguments
Name
The friendly name for this tag.
Description
The description for this tag.
EntityType
The entity type that the tag has been tagged with.
Template
Remove the tag with the given uuid

> Remove-NTNXTag [[-Servers] <string[]>] -TagUuid <Object> [-ExpandedOutput]
> Remove-NTNXTag [-TagUuid <Object>] [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXTag [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

AOS | Tag | 917

Required arguments
TagUuid
UUID for tag to remove.
Optional arguments
Template
Create a new tag based on the name and entities provided

> New-NTNXTag [[-Servers] <string[]>] -Name <string> -EntityType <string>
[-Uuid <string>] [-Description <string>] [-ExpandedOutput] [-GridView]
> New-NTNXTag [-Uuid <string>] [-Name <string>] [-Description <string>]

[-EntityType <string>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXTag [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
The friendly name for this tag.
EntityType
The entity type that the tag has been tagged with.
Optional arguments
Uuid
The id for this tag.
Description
The description for this tag.
Template
Get a collection of tags which are optionally filtered by the passed criteria
> Get-NTNXTag [[-Servers] <string[]>] [-FilterCriteria <Object>] [-TagUuid
> Get-NTNXTag [-FilterCriteria <Object>] [-TagUuid <Object>] [-ExpandedOutput]

> Get-NTNXTag [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

AOS | Tag | 918

Required arguments
TagUuid
UUID for tag requested.
Optional arguments
FilterCriteria
Filtering on attributes of the tag.
AOS | Tag | 919

228
AOS | TaggedEntity | 920

TAGGEDENTITY
Operations
• Gets a list of tagged entities: Get-NTNXTaggedEntity
Gets a list of entities tagged with either of the tags

> Get-NTNXTaggedEntity [[-Servers] <string[]>] -EntityType <string> -TagIds
<string[]> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXTaggedEntity [-EntityType <string>] [-TagIds <string[]>] [-Template]

> Get-NTNXTaggedEntity [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
EntityType
The entity type
TagIds
The list of tag uuids
Optional arguments
Template
AOS | TaggedEntity | 921

229
AOS | Task | 922

TASK
Operations
• Get a list of tasks: Get-NTNXTask

• Poll a task: Poll-NTNXTask
Get a list of tasks generated in the cluster

By default, completed tasks are excluded. Set the includeCompeted flag to true to include
completed tasks. Tasks can also be filtered based on the entites, entity types and operation
type.
> Get-NTNXTask [[-Servers] <string[]>] [-Taskid <Object>]
[-IncludeEntityNames] [-EntityTypes <Object>] [-EntityUuids <Object>]
[-OperationTypeList <Object>] [-IncludeCompleted] [-EpochCutOffTime <long>]
[-Count <int>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXTask [-Taskid <Object>] [-IncludeEntityNames] [-EntityTypes

<Object>] [-EntityUuids <Object>] [-OperationTypeList <Object>]
[-IncludeCompleted] [-EpochCutOffTime <long>] [-Count <int>] [-ExpandedOutput]
> Get-NTNXTask [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Taskid
Id of the task
Optional arguments
IncludeEntityNames
Include entity names
EntityTypes
Comma separated Entity types
EntityUuids
Comma separated Entity types
OperationTypeList
Comma separated Operation types
IncludeCompleted
Include Completed Tasks
EpochCutOffTime
Tasks greater than cut off epoch time in microseconds will be returned. This is
applicable only when include completed is set to True.
Count
Maximum number of tasks
AOS | Task | 923

Poll a task to check if its ready
The maximum timeout that can be specified is 30 minutes, i.e. 1800 seconds.
> Poll-NTNXTask [[-Servers] <string[]>] -Taskid <Object> [-Timeoutseconds
<long>] [-IncludeEntityNames] [-ExpandedOutput] [-GridView]
> Poll-NTNXTask [-Taskid <Object>] [-Timeoutseconds <long>]

[-IncludeEntityNames] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Poll-NTNXTask [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Taskid
Id of the task
Optional arguments
Timeoutseconds
Timeout seconds
IncludeEntityNames
Include entity names
230
AOS | UnprotectedVM | 925

UNPROTECTEDVM
Operations
• Get list of unprotected VMs in a cluster: Get-NTNXUnprotectedVM
Get list of unprotected VMs in a cluster that can participate in Nutanix native Backup and DR
> Get-NTNXUnprotectedVM [[-Servers] <string[]>] [-HostIds <Object>] [-VmIds
<Object>] [-VmNames <Object>] [-ContainerNames <Object>] [-ExpandedOutput]
> Get-NTNXUnprotectedVM [-HostIds <Object>] [-VmIds <Object>] [-VmNames

<Object>] [-ContainerNames <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXUnprotectedVM [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
HostIds
Host IDs
VmIds
VM IDs
VmNames
VM Names
ContainerNames
Container Names
231
AOS | UserMapping | 927

USERMAPPING
Operations
• Get the user mapping: Get-NTNXUserMapping

• Add new User Mapping: New-NTNXUserMapping
• Search User Mapping: Search-NTNXUserMapping
• Update User Mapping: Update-NTNXUserMapping
Search User Mapping

> Search-NTNXUserMapping [[-Servers] <string[]>] -Uuid <Object> -NameOrIds
<string[]> -SearchMappingType <SearchUserMapping+SearchMappingType_Enum>
-MappingType <SearchUserMapping+IdentityMappingType_Enum> [-FileServerUuid
<string>] [-ActionType <SearchUserMapping+IdentityActionType_Enum>]
> Search-NTNXUserMapping [-Uuid <Object>] [-FileServerUuid <string>]

[-NameOrIds <string[]>] [-SearchMappingType
<SearchUserMapping+SearchMappingType_Enum>] [-MappingType
<SearchUserMapping+IdentityMappingType_Enum>] [-ActionType
<SearchUserMapping+IdentityActionType_Enum>] [-Template] [-ExpandedOutput]
> Search-NTNXUserMapping [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
NameOrIds
Search identity mapping name or ids
SearchMappingType
Search user mapping (SMB_TO_NFS or NFS_TO_SMB)
MappingType
Mapping type of the search user ie. user or group.
Optional arguments
FileServerUuid
ActionType
Template

Get the user mapping associated with a file server
Required arguments
Uuid
Add new User Mapping

> New-NTNXUserMapping [[-Servers] <string[]>] -Uuid <Object> [-FileServerUuid
<string>] [-RuleBasedMapping <RuleBasedMappingDTO>] [-ExplicitMapping
<ExplicitIdentityMappingDTO>] [-ExpandedOutput] [-GridView]
> New-NTNXUserMapping [-Uuid <Object>] [-FileServerUuid <string>]

[-RuleBasedMapping <RuleBasedMappingDTO>] [-ExplicitMapping
<ExplicitIdentityMappingDTO>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXUserMapping [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
FileServerUuid
RuleBasedMapping
ExplicitMapping
Template
Update User Mapping

> Update-NTNXUserMapping [[-Servers] <string[]>] -Uuid <Object>
[-FileServerUuid <string>] [-RuleBasedMapping <RuleBasedMappingDTO>]
[-ExplicitMapping <ExplicitIdentityMappingDTO>] [-ExpandedOutput] [-GridView]
> Update-NTNXUserMapping [-Uuid <Object>] [-FileServerUuid <string>]

[-RuleBasedMapping <RuleBasedMappingDTO>] [-ExplicitMapping
<ExplicitIdentityMappingDTO>] [-Template] [-ExpandedOutput] [-GridView]
> Update-NTNXUserMapping [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid

Optional arguments
FileServerUuid
RuleBasedMapping
ExplicitMapping
Template
232
AOS | VDisk | 931

VDISK
Operations
• Get the list of VDisks: Get-NTNXVDisk

• Add a VDisk: New-NTNXVDisk
• Delete a VDisk: Remove-NTNXVDisk
• Update a VDisk: Set-NTNXVDisk
Delete a VDisk with the specified name

> Remove-NTNXVDisk [[-Servers] <string[]>] -Name <Object> [-ExpandedOutput]
> Remove-NTNXVDisk [-Name <Object>] [-Template] [-ExpandedOutput] [-GridView]

> Remove-NTNXVDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the VDisk
Optional arguments
Template
Get the list of VDisks configured in the cluster

> Get-NTNXVDisk [[-Servers] <string[]>] [-Name <Object>] [-Projection
<Object>] [-Includedeleted] [-VdiskNames <Object>] [-ExpandedOutput]
> Get-NTNXVDisk [-Name <Object>] [-Projection <Object>] [-Includedeleted]

[-VdiskNames <Object>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXVDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the VDisk
Optional arguments
Projection
AOS | VDisk | 932

Includedeleted
Include deleted
VdiskNames
vdisk names
Update the specified VDisk

> Set-NTNXVDisk [[-Servers] <string[]>] [-Name <string>] [-ContainerId
<string>] [-ContainerUuid <string>] [-ContainerName <string>] [-StoragePoolId
<string>] [-StoragePoolUuid <string>] [-StoragePoolName <string>] [-Shared
<bool>] [-NfsFile <bool>] [-Immutable <bool>] [-Snapshot <bool>] [-QosPriority
<string>] [-QosFairshare <string>] [-ErasureCode <string>]
<SetVDisk+FingerPrintOnWrite_Enum>] [-OnDiskDedup <SetVDisk+OnDiskDedup_Enum>]
[-TotalReservedCapacityBytes <long>] [-MaxCapacityBytes <long>]
[-IscsiTargetName <string>] [-IscsiLun <int>] [-NfsFileName <string>]
[-ParentNfsFileName <string>] [-Disabled <bool>]
[-CreationTimeInMicrosSinceEpoch <long>] [-Snapshots <string[]>] [-Stats
<Object>] [-UsageStats <Object>] [-HealthSummary <HealthSummaryDTO>]
[-AlertSummary <AlertSummaryDTO>] [-VdiskUuid <string>] [-Operation <string>]
> Set-NTNXVDisk [-Name <string>] [-ContainerId <string>] [-ContainerUuid

<string>] [-ContainerName <string>] [-StoragePoolId <string>]
[-StoragePoolUuid <string>] [-StoragePoolName <string>] [-Shared <bool>]
[-NfsFile <bool>] [-Immutable <bool>] [-Snapshot <bool>] [-QosPriority
<SetVDisk+FingerPrintOnWrite_Enum>] [-OnDiskDedup <SetVDisk+OnDiskDedup_Enum>]
[-AlertSummary <AlertSummaryDTO>] [-VdiskUuid <string>] [-Operation <string>]
> Set-NTNXVDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
ContainerId
ContainerUuid
ContainerName
StorageContainerId
AOS | VDisk | 933

StoragePoolId
StoragePoolUuid
StoragePoolName
Shared
NfsFile
Immutable
Snapshot
QosPriority
QosFairshare
ErasureCode
FingerPrintOnWrite
OnDiskDedup
TotalReservedCapacityBytes
MaxCapacityBytes
IscsiTargetName
IscsiLun
NfsFileName
ParentNfsFileName
Disabled
CreationTimeInMicrosSinceEpoch
Snapshots
Stats
UsageStats
HealthSummary
AlertSummary
VdiskUuid
Operation
GenericDTO
ClusterUuid
Template
AOS | VDisk | 934

Add a VDisk to the cluster
> New-NTNXVDisk [[-Servers] <string[]>] [-Name <string>] [-ContainerId
<string>] [-ContainerUuid <string>] [-ContainerName <string>] [-StoragePoolId
<string>] [-StoragePoolUuid <string>] [-StoragePoolName <string>] [-Shared
<bool>] [-NfsFile <bool>] [-Immutable <bool>] [-Snapshot <bool>] [-QosPriority
<NewVDisk+FingerPrintOnWrite_Enum>] [-OnDiskDedup <NewVDisk+OnDiskDedup_Enum>]
[-AlertSummary <AlertSummaryDTO>] [-VdiskUuid <string>] [-ExpandedOutput]
> New-NTNXVDisk [-Name <string>] [-ContainerId <string>] [-ContainerUuid

<string>] [-ContainerName <string>] [-StoragePoolId <string>]
[-StoragePoolUuid <string>] [-StoragePoolName <string>] [-Shared <bool>]
[-NfsFile <bool>] [-Immutable <bool>] [-Snapshot <bool>] [-QosPriority
<NewVDisk+FingerPrintOnWrite_Enum>] [-OnDiskDedup <NewVDisk+OnDiskDedup_Enum>]
[-AlertSummary <AlertSummaryDTO>] [-VdiskUuid <string>] [-Template]
> New-NTNXVDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
None
Optional arguments
Name
ContainerId
ContainerUuid
ContainerName
StorageContainerId
StoragePoolId
StoragePoolUuid
StoragePoolName
Shared
AOS | VDisk | 935

NfsFile
Immutable
Snapshot
QosPriority
QosFairshare
ErasureCode
FingerPrintOnWrite
OnDiskDedup
TotalReservedCapacityBytes
MaxCapacityBytes
IscsiTargetName
IscsiLun
NfsFileName
ParentNfsFileName
Disabled
CreationTimeInMicrosSinceEpoch
Snapshots
Stats
UsageStats
HealthSummary
AlertSummary
VdiskUuid
Template
233
AOS | VDiskAlert | 937

VDISKALERT
Operations
• Get the list of alerts generated on any VDisk: Get-NTNXVDiskAlert
> Get-NTNXVDiskAlert [[-Servers] <string[]>] [-Name <Object>]

> Get-NTNXVDiskAlert [-Name <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXVDiskAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the VDisk
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
234
AOS | VDiskEvent | 939

VDISKEVENT
Operations
• Get the list of events generated on any VDisk: Get-NTNXVDiskEvent
> Get-NTNXVDiskEvent [[-Servers] <string[]>] [-Name <Object>]

> Get-NTNXVDiskEvent [-Name <Object>] [-StartTimeInUsecs <long>]

> Get-NTNXVDiskEvent [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the VDisk
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
235
AOS | VDiskSnapshot | 941

VDISKSNAPSHOT
Operations
• Get the complete list of Snapshots: Get-NTNXVDiskSnapshot
Get the complete list of Snapshots in the cluster

> Get-NTNXVDiskSnapshot [[-Servers] <string[]>] [-Name <Object>]
> Get-NTNXVDiskSnapshot [-Name <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXVDiskSnapshot [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Name of the snapshot
236
AOS | VDiskStat | 943

VDISKSTAT
Operations
• Get the stats for a specified VDisk: Get-NTNXVDiskStat
> Get-NTNXVDiskStat [[-Servers] <string[]>] -Name <Object> -Metrics <Object>
> Get-NTNXVDiskStat [-Name <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXVDiskStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Name
Name of the VDisk
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
237
AOS | VM | 945

VM
Operations
• Get the list of VMs: Get-NTNXVM
Get the list of VMs configured in the cluster

> Get-NTNXVM [[-Servers] <string[]>] [-Count <int>] [-FilterCriteria <Object>]
[-SortCriteria <Object>] [-SearchString <Object>] [-SearchAttributeList
<Object>] [-Page <int>] [-Projection <Object>] [-VmId <Object>]
> Get-NTNXVM [-Count <int>] [-FilterCriteria <Object>] [-SortCriteria

<int>] [-Projection <Object>] [-VmId <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXVM [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of the VM
Optional arguments
Count
Number of VMs to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Search attribute list, only searches on few attributes. For accurate search,
provide field names
Page
Page number
Projection
238
AOS | VMAlert | 947

VMALERT
Operations
• Get the list of alerts generated on any VM: Get-NTNXVMAlert
> Get-NTNXVMAlert [[-Servers] <string[]>] [-VmId <Object>] [-StartTimeInUsecs

> Get-NTNXVMAlert [-VmId <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs

> Get-NTNXVMAlert [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of a VM
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Resolved
Acknowledged
Severity
Alert severities
AlertTypeUuid
Alert type ids
Page
Page number
239
AOS | VMDisk | 949

VMDISK
Operations
• Create a disk in a Virtual Machine: Add-NTNXVMDisk

• Get list of disks in a Virtual Machine: Get-NTNXVMDisk
• Delete a disk from a Virtual Machine: Remove-NTNXVMDisk
• Update info of a disk in a Virtual Machine: Set-NTNXVMDisk
Delete a disk from a Virtual Machine

If the VM is running, the disk is hot-removed from the VM. Note that certain buses, like IDE,
are not hot-pluggable. The logical timestamp can optionally be provided for consistency. If
a logical timestamp is specified, then this operation will be rejected if the logical timestamp
specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can
be obtained from the Virtual Machine object. This is also an asynchronous operation that results
in the creation of a task object. The UUID of this task object is returned as the response of this
> Remove-NTNXVMDisk [[-Servers] <string[]>] -Vmid <Object> -Diskaddress
<Object> [-VmLogicalTimestamp <long>] [-ExpandedOutput] [-GridView]
> Remove-NTNXVMDisk [-Vmid <Object>] [-Diskaddress <Object>]

[-VmLogicalTimestamp <long>] [-Template] [-ExpandedOutput] [-GridView]
> Remove-NTNXVMDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Id of the Virtual Machine
Diskaddress
Address of the Disk
Optional arguments
VmLogicalTimestamp
Virtual Machine Logical timestamp
Template
Create a disk in a Virtual Machine

A disk drive may either be a regular disk drive, or a CD-ROM drive. Only CD-ROM drives may be
empty. By default, regular disk drives are configured on the SCSI bus, and CD-ROM drives are
configured on the IDE bus. The user may override this behavior with the deviceBus attribute.
By default, a disk drive is placed on the first available bus slot. The user may override this
AOS | VMDisk | 950

behavior with the deviceIndex attribute. Disks on the SCSI bus may optionally be configured
for passthrough on platforms that support iSCSI. When in passthrough mode, SCSI commands
are passed directly to NDFS via iSCSI. When SCSI passthrough is disabled, the hypervisor
provides a SCSI emulation layer, and treats the underlying iSCSI target as a block device. By
default, SCSI passthrough is enabled for SCSI devices on supported platforms. If the disk image
is cloned from an existing vmdisk or NFS file, the user may specify a minimum size for the
resulting clone. This can be used to expand a disk image at clone time. If the VM is running,
the disk is hot-added to the VM. Note that certain buses, like IDE, are not hot-pluggable. The
logical timestamp can optionally be provided for consistency. If a logical timestamp is specified,
then this operation will be rejected if the logical timestamp specified is not the value of the
Virtual Machine logical timestamp. The logical timestamp can be obtained from the Virtual
Machine object. This is also an asynchronous operation that results in the creation of a task
> Add-NTNXVMDisk [[-Servers] <string[]>] -Vmid <Object> [-VmLogicalTimestamp
<long>] [-Disks <VMDiskDTO[]>] [-Uuid <string>] [-ExpandedOutput] [-GridView]
> Add-NTNXVMDisk [-Vmid <Object>] [-VmLogicalTimestamp <long>] [-Disks

<VMDiskDTO[]>] [-Uuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Add-NTNXVMDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Optional arguments
VmLogicalTimestamp
Virtual Machine object.
Disks
List of specs for disks to add to the Virtual Machine.
Uuid
UUID of the VM.
Template
Update info of a disk in a Virtual Machine

This API results in the existing disk image to be deleted and replaced by the new image (which
may be a clone of the existing image). If CD-ROM drive is locked, then a request to alter its
contents will be rejected. The new disk drive may either be a regular disk drive, or a CD-ROM
drive. Only CD-ROM drives may be empty. By default, regular disk drives are configured on
the SCSI bus, and CD-ROM drives are configured on the IDE bus. The user may override this
behavior with the deviceBus attribute. By default, a disk drive is placed on the first available
bus slot. The user may override this behavior with the deviceIndex attribute. Disks on the
SCSI bus may optionally be configured for passthrough on platforms that support iSCSI.
When in passthrough mode, SCSI commands are passed directly to NDFS via iSCSI. When
AOS | VMDisk | 951

SCSI passthrough is disabled, the hypervisor provides a SCSI emulation layer, and treats the
underlying iSCSI target as a block device. By default, SCSI passthrough is enabled for SCSI
devices on supported platforms. If the disk image is cloned from an existing vmdisk or NFS
file, the user may specify a minimum size for the resulting clone. This can be used to expand
a disk image at clone time. If the VM is running, the disk is hot-added to the VM. Note that
certain buses, like IDE, are not hot-pluggable. The logical timestamp can optionally be provided
for consistency. If a logical timestamp is specified, then this operation will be rejected if the
logical timestamp specified is not the value of the Virtual Machine logical timestamp. The logical
timestamp can be obtained from the Virtual Machine object. This is also an asynchronous
> Set-NTNXVMDisk [[-Servers] <string[]>] -Vmid <Object> -Diskaddress <Object>
[-VmLogicalTimestamp <long>] [-UpdateSpec <VMDiskUpdateSpecDTO>] [-Uuid
<string>] [-DiskId <string>] [-DiskUuid <string>] [-DeviceUuid <string>]
[-FlashModeEnabled <bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Set-NTNXVMDisk [-Vmid <Object>] [-Diskaddress <Object>] [-VmLogicalTimestamp

<long>] [-UpdateSpec <VMDiskUpdateSpecDTO>] [-Uuid <string>] [-DiskId
<string>] [-DiskUuid <string>] [-DeviceUuid <string>] [-FlashModeEnabled
> Set-NTNXVMDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Diskaddress
Address of the Disk
Optional arguments
VmLogicalTimestamp
Virtual Machine object
UpdateSpec
Disk specification to use for updating Virtual Machine disk.
Uuid
UUID of the VM.
DiskId
ID of the Disk.
DiskUuid
Uuid of the Disk.
DeviceUuid
Device uuid of the Disk.
FlashModeEnabled
Flash mode enabled or not for the volume
AOS | VMDisk | 952

Template
Get list of disks in a Virtual Machine

Disk size is not include by default as calculating disk size is an expensive operation. To include
disk size, set the includeDiskSizes flag to true.
> Get-NTNXVMDisk [[-Servers] <string[]>] -Vmid <Object> [-BusType <Object>]
[-DeviceIndex <Object>] [-IncludeDiskSizes] [-Diskid <Object>]
> Get-NTNXVMDisk [-Vmid <Object>] [-BusType <Object>] [-DeviceIndex <Object>]

[-IncludeDiskSizes] [-Diskid <Object>] [-ExpandedOutput] [-GridView]
> Get-NTNXVMDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Diskid
Id of the disk
Optional arguments
BusType
Bus Type of the disk(IDE/SCSI)
DeviceIndex
Device Index
IncludeDiskSizes
Include disk sizes in bytes
AOS | VMDisk | 953

240
AOS | VMEvent | 954

VMEVENT
Operations
• Get the list of events generated on any VM: Get-NTNXVMEvent
> Get-NTNXVMEvent [[-Servers] <string[]>] [-VmId <Object>] [-StartTimeInUsecs

<long>] [-EndTimeInUsecs <long>] [-Count <int>] [-Acknowledged] [-Page <int>]
> Get-NTNXVMEvent [-VmId <Object>] [-StartTimeInUsecs <long>] [-EndTimeInUsecs

<long>] [-Count <int>] [-Acknowledged] [-Page <int>] [-ExpandedOutput]
> Get-NTNXVMEvent [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of a VM
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
Count
Acknowledged
Page
Page number
AOS | VMEvent | 955

241
AOS | VMHealthCheckSummary | 956

VMHEALTHCHECKSUMMARY
Operations
• Get the health check summary for VMs: Get-NTNXVMHealthCheckSummary
> Get-NTNXVMHealthCheckSummary [[-Servers] <string[]>] [-FilterCriteria

> Get-NTNXVMHealthCheckSummary [-FilterCriteria <Object>] [-DetailedSummary]

> Get-NTNXVMHealthCheckSummary [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
FilterCriteria
Filter criteria
DetailedSummary
Detailed summary
AOS | VMHealthCheckSummary | 957

242
AOS | VMMove | 958

VMMOVE
Operations
• Abort migrate of a Virtual Machine: Stop-NTNXVMMove
Abort migrate of a Virtual Machine

of the Virtual Machine logical timestamp. The logicaltimestamp can be obtained from the
Virtual Machine object. This is an asynchronous operation that results in the creation of a task
> Stop-NTNXVMMove [[-Servers] <string[]>] -Vmid <Object> [-LogicalTimestamp
> Stop-NTNXVMMove [-Vmid <Object>] [-LogicalTimestamp <long>] [-Template]

> Stop-NTNXVMMove [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Optional arguments
LogicalTimestamp
Template
AOS | VMMove | 959

243
AOS | VMNIC | 960

VMNIC
Operations
• Add a NIC to a Virtual Machine: Add-NTNXVMNIC

• Get list of NICs in a Virtual Machine: Get-NTNXVMNIC
• Delete a NIC from a Virtual Machine: Remove-NTNXVMNIC
Add a NIC to a Virtual Machine

A VM NIC must be associated with a virtual network. It is not possible to change this
association. To connect a VM to a different virtual network, it is necessary to create a new
NIC. If the virtual network is managed (see POST /networks/), the NIC must be assigned
an IPv4 address at creation time. If the network has no DHCP pool, the user must specify
the IPv4 address manually. If the VM is running, the NIC is hot-added to the VM. The logical
this operation will be rejected if the logical timestamp specified is not the value of the Virtual
Machine logical timestamp. The logical timestamp can be obtained from the Virtual Machine
object. This is also an asynchronous operation that results in the creation of a task object.
The UUID of this task object is returned as the response of this operation. This task can be
monitored by using the /tasks/poll API.
> Add-NTNXVMNIC [[-Servers] <string[]>] -Vmid <Object> -SpecList
<VMNicSpecDTO[]> [-Uuid <string>] [-ExpandedOutput] [-GridView]
> Add-NTNXVMNIC [-Vmid <Object>] [-SpecList <VMNicSpecDTO[]>] [-Uuid <string>]

> Add-NTNXVMNIC [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
SpecList
List of specification for NICS to add to the Virtual Machine.
Optional arguments
Uuid
UUID of the VM to create NIC on.
Template
Get list of NICs in a Virtual Machine

Address assignments are not included by default as fetching these is an expensive operation.
Address assignments can be included by setting includeAddressAssignments to true.
> Get-NTNXVMNIC [[-Servers] <string[]>] -Vmid <Object> [-Nicid <Object>]
AOS | VMNIC | 961

[-IncludeAddressAssignments] [-ExpandedOutput] [-GridView]
> Get-NTNXVMNIC [-Vmid <Object>] [-Nicid <Object>]

[-IncludeAddressAssignments] [-ExpandedOutput] [-GridView]
> Get-NTNXVMNIC [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Nicid
Virtual Machine NIC identifier
Optional arguments
IncludeAddressAssignments
Include address assignments
Delete a NIC from a Virtual Machine

If the VM is running, the NIC is hot-removed from the VM. If the NIC to be removed is specified
as the boot device in the boot configuration, the boot device configuration will be cleared
as a side effect of removing the NIC. The logical timestamp can optionally be provided for
timestamp specified is not the value of the Virtual Machine logical timestamp. The logical
> Remove-NTNXVMNIC [[-Servers] <string[]>] -Vmid <Object> -Nicid <Object>
[-VmLogicalTimestamp <long>] [-ExpandedOutput] [-GridView]
> Remove-NTNXVMNIC [-Vmid <Object>] [-Nicid <Object>] [-VmLogicalTimestamp

> Remove-NTNXVMNIC [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Nicid
NIC identifier
Optional arguments
VmLogicalTimestamp
Virtual Machine Logical timestamp
AOS | VMNIC | 962

Template
AOS | VMNIC | 963

244
AOS | VMPowerOff | 964

VMPOWEROFF
Operations
• Power off a Virtual Machine: Set-NTNXVMPowerOff
Power off a Virtual Machine

of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the
Virtual Machine object. This is also an asynchronous operation that results in the creation of a
task object. The UUID of this task object is returned as the response of this operation. This task
can be monitored by using the /tasks/poll API.
> Set-NTNXVMPowerOff [[-Servers] <string[]>] -Vmid <Object> [-LogicalTimestamp
> Set-NTNXVMPowerOff [-Vmid <Object>] [-LogicalTimestamp <long>] [-Template]

> Set-NTNXVMPowerOff [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Id of the VM
Optional arguments
LogicalTimestamp
Template
AOS | VMPowerOff | 965

245
AOS | VMPowerOn | 966

VMPOWERON
Operations
• Power on a Virtual Machine: Set-NTNXVMPowerOn
Power on a Virtual Machine

If no host is specified, the scheduler will pick the one with the most available CPU and memory
that can support the VM. Note that no such host may be available. The logical timestamp can
optionally be provided for consistency. If a logical timestamp is specified, then this operation
will be rejected if the logical timestamp specified is not the value of the Virtual Machine logical
timestamp. The logical timestamp can be obtained from the Virtual Machine object. This is also
an asynchronous operation that results in the creation of a task object. The UUID of this task
object is returned as the response of this operation. This task can be monitored by using the /
tasks/poll API.
> Set-NTNXVMPowerOn [[-Servers] <string[]>] -Vmid <Object> [-LogicalTimestamp
<long>] [-HostUuid <string>] [-ExpandedOutput] [-GridView]
> Set-NTNXVMPowerOn [-Vmid <Object>] [-LogicalTimestamp <long>] [-HostUuid

> Set-NTNXVMPowerOn [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Id of the VM
Optional arguments
LogicalTimestamp
HostUuid
Explicit host UUID on which to power on the VM. This parameter is only honored
for kPowerOn, or kPowerCycle when change host is also requested explicitly.
Template
AOS | VMPowerOn | 967

246
AOS | VMPowerState | 968

VMPOWERSTATE
Operations
• Set power state of a Virtual Machine: Set-NTNXVMPowerState
Set power state of a Virtual Machine

If the Virtual Machine is being powered on and no host is specified, the scheduler will pick the
one with the most available CPU and memory that can support the Virtual Machine. Note that
no such host may not be available. If the Virtual Machine is being power cycled, a different
host can be specified to start it on. The logical timestamp can optionally be provided for
timestamp specified is not the value of the Virtual Machine logical timestamp. The logical
the response of this operation. This task can be monitored by using the /tasks/poll API. Virtual
Machine power state can be set to: ON | OFF | POWERCYCLE | RESET | PAUSE | SUSPEND |
RESUME | ACPI_SHUTDOWN | ACPI_REBOOT.
> Set-NTNXVMPowerState [[-Servers] <string[]>] -Vmid <Object> -Transition
<SetVMPowerState+Transition_Enum> [-VMPowerState_Vmid <string>] [-HostUuid
> Set-NTNXVMPowerState [-Vmid <Object>] [-VMPowerState_Vmid <string>]

[-Transition <SetVMPowerState+Transition_Enum>] [-HostUuid <string>]
> Set-NTNXVMPowerState [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Vmid
Transition
The desired power state transition
Optional arguments
Vmid
Uuid of the VM.
HostUuid
Explicit version 4 host UUID on which to power on the VM. This parameter is
only honored for kPowerOn, or kPowerCycle when change host is also requested
explicitly.
Template
AOS | VMPowerState | 969

247
AOS | VMSnapshot | 970

VMSNAPSHOT
Operations
• Get a hierarchy of snapshots for a Virtual Machine: Get-NTNXVMSnapshot
Get a hierarchy of snapshots for a Virtual Machine

By default, snapshot information is included. If only UUIDs of snapshots are desired, then
includeSnapshots should be set to false.
> Get-NTNXVMSnapshot [[-Servers] <string[]>] -Vmid <Object>
[-IncludeSnapshots] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXVMSnapshot [-Vmid <Object>] [-IncludeSnapshots] [-ExpandedOutput]

> Get-NTNXVMSnapshot [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Vmid
Optional arguments
IncludeSnapshots
Whether to include snapshot info
AOS | VMSnapshot | 971

248
AOS | VMStat | 972

VMSTAT
Operations
• Get the stats for a specified VM: Get-NTNXVMStat
> Get-NTNXVMStat [[-Servers] <string[]>] -VmId <Object> -Metrics <Object>
> Get-NTNXVMStat [-VmId <Object>] [-Metrics <Object>] [-StartTimeInUsecs

> Get-NTNXVMStat [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of the VM
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
AOS | VMStat | 973

249
AOS | VMVDisk | 974

VMVDISK
Operations
• Get the list of VDisks: Get-NTNXVMVDisk
Get the list of VDisks attached to the specified VM

> Get-NTNXVMVDisk [[-Servers] <string[]>] -VmId <Object> [-ExpandedOutput]
> Get-NTNXVMVDisk [-VmId <Object>] [-ExpandedOutput] [-GridView]

> Get-NTNXVMVDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
VmId
Id of the VM
AOS | VMVDisk | 975

250
AOS | VMVirtualDisk | 976

VMVIRTUALDISK
Operations
• Get the list of VirtualDisks: Get-NTNXVMVirtualDisk
Get the list of VirtualDisks attached to the specified VM

> Get-NTNXVMVirtualDisk [[-Servers] <string[]>] -VmId <Object> [-SortCriteria
> Get-NTNXVMVirtualDisk [-VmId <Object>] [-SortCriteria <Object>] [-Projection

> Get-NTNXVMVirtualDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
VmId
Uuid of the VM
Optional arguments
SortCriteria
Sort criteria
Projection
AOS | VMVirtualDisk | 977

251
AOS | VStore | 978

VSTORE
Operations
• Get the list of VStores: Get-NTNXVStore

• Protect a VStore: Protect-NTNXVStore
• Unprotect a VStore: UnProtect-NTNXVStore
Protect a VStore with the specified id

> Protect-NTNXVStore [[-Servers] <string[]>] -Id <Object> [-VmLevelConsistency
<bool>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Protect-NTNXVStore [-Id <Object>] [-VmLevelConsistency <bool>] [-Template]

> Protect-NTNXVStore [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Uuid of the VStore
Optional arguments
VmLevelConsistency
Create vm level consistent snapshots for the vStore
Template
Unprotect a VStore with the specified id

> UnProtect-NTNXVStore [[-Servers] <string[]>] -Id <Object> [-ExpandedOutput]
> UnProtect-NTNXVStore [-Id <Object>] [-Template] [-ExpandedOutput]

> UnProtect-NTNXVStore [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Uuid of the VStore
AOS | VStore | 979

Optional arguments
Template
Get the list of VStores configured in the cluster

> Get-NTNXVStore [[-Servers] <string[]>] [-Id <Object>] [-Ids <Object>]
[-Names <Object>] [-IncludeDeleted] [-ExpandedOutput] [-GridView]
> Get-NTNXVStore [-Id <Object>] [-Ids <Object>] [-Names <Object>]

[-IncludeDeleted] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXVStore [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Id
Uuid of the VStore
Optional arguments
Ids
VStore uuids
Names
VStore names
IncludeDeleted
Include deleted
252
AOS | VStoreProtection | 981

VSTOREPROTECTION
Operations
• Protect a VStore: Update-NTNXVStoreProtection
Protect a VStore with the specified uuid

> Update-NTNXVStoreProtection [[-Servers] <string[]>] -Id <Object>
-VmLevelConsistency <bool> [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Update-NTNXVStoreProtection [-Id <Object>] [-VmLevelConsistency <bool>]

> Update-NTNXVStoreProtection [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Uuid of the VStore
VmLevelConsistency
Create vm level consistent snapshots for the vStore
Optional arguments
Template
253
AOS | VirtualDisk | 983

VIRTUALDISK
Operations
• Get the list of VirtualDisks: Get-NTNXVirtualDisk
Get the list of VirtualDisks configured in the cluster

> Get-NTNXVirtualDisk [[-Servers] <string[]>] [-Id <Object>] [-Projection
> Get-NTNXVirtualDisk [-Id <Object>] [-Projection <Object>] [-Count <int>]

> Get-NTNXVirtualDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Uuid of the VirtualDisk
Optional arguments
Projection
Count
Number of VirtualDisks to retrieve
FilterCriteria
Filter criteria
SortCriteria
Sort criteria
SearchString
Search string
SearchAttributeList
Page
Page number
254
AOS | VirtualDiskStat | 985

VIRTUALDISKSTAT
Operations
• Get the stats for a specified VirtualDisk: Get-NTNXVirtualDiskStat
> Get-NTNXVirtualDiskStat [[-Servers] <string[]>] -Id <Object> -Metrics
> Get-NTNXVirtualDiskStat [-Id <Object>] [-Metrics <Object>]

> Get-NTNXVirtualDiskStat [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Id
Uuid of the VirtualDisk
Metrics
List of metrics
Optional arguments
StartTimeInUsecs
EndTimeInUsecs
IntervalInSecs
255
AOS | VirtualMachine | 987

VIRTUALMACHINE
Operations
• Clone a Virtual Machine: Clone-NTNXVirtualMachine

• Get a list of KVM managed Virtual Machines: Get-NTNXVirtualMachine
• Migrate a Virtual Machine: Move-NTNXVirtualMachine
• Create a Virtual Machine: New-NTNXVirtualMachine
• Delete a Virtual Machine: Remove-NTNXVirtualMachine
• Restore a Virtual Machine to a snapshotted state: Restore-NTNXVirtualMachine
• Update a Virtual Machine: Set-NTNXVirtualMachine
Restore a Virtual Machine to a snapshotted state

If the VM is currently running, it will be powered poweredoff. Since Virtual Machine snapshot
do not include the Virtual Machine memory image, the Virtual Machine will remain powered off
after the restore is complete. A Virtual Machine snapshot may no longer be compatible with
the current virtual network configuration. In this case, the user may choose not to restore the
Virtual Machine's network adpaters using the restoreNetworkConfig keyword argument. If a
UUID is specified for the restored Virtual Machine, then the operation will be idempotent. This
is also an asynchronous operation that results in the creation of a task object. The UUID of this
task object is returned as the response of this operation. This task can be monitored by using
the /tasks/poll API.
> Restore-NTNXVirtualMachine [[-Servers] <string[]>] -Vmid <Object>
-SnapshotUuid <string> [-Uuid <string>] [-RestoreNetworkConfiguration <bool>]
> Restore-NTNXVirtualMachine [-Vmid <Object>] [-Uuid <string>] [-SnapshotUuid

<string>] [-RestoreNetworkConfiguration <bool>] [-Template] [-ExpandedOutput]
> Restore-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Vmid
SnapshotUuid
The version 4 UUID of the snapshot from which to restore
Optional arguments
Uuid
UUID of the VM.
RestoreNetworkConfiguration
Whether to reset the VM's current networking configuration. If this flag is set,
the VM's current network adapters will be replaced with the network adapters
specified in the snapshot. Otherwise, the VM's current networking adapters will

be retained, and the network adapters specified in the snapshot will be ignored.
This is set to 'true' by default.
Template
Migrate a Virtual Machine

If no host is specified, the scheduler will pick the one with the most available CPU and memory
that can support the VM. Note that no such host may be available. The user may abort an in-
progress migration with the /vms/{vmid}/migrate-abort API. This is an asynchronous operation
that results in the creation of a task object. The UUID of this task object is returned as the
response of this operation. This task can be monitored by using the /tasks/poll API.
> Move-NTNXVirtualMachine [[-Servers] <string[]>] -Vmid <Object> -Live <bool>
[-VmLogicalTimeStamp <long>] [-VMMigrate_Vmid <string>] [-HostUuid <string>]
[-BandwidthMbps <int>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Move-NTNXVirtualMachine [-Vmid <Object>] [-VmLogicalTimeStamp <long>]

[-VMMigrate_Vmid <string>] [-HostUuid <string>] [-Live <bool>] [-BandwidthMbps
<int>] [-Template] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Move-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Vmid
Live
Whether the migration should live ('true') or suspended ('false'). The default
value is 'true'
Optional arguments
VmLogicalTimeStamp
Vmid
UUID of the VM.
HostUuid
The version 4 UUID of the host to migrate the Virtual Machine to. If no host is
specified, then the scheduler will pick theone with the most available CPU and
memory that can support the VM.
BandwidthMbps
Target maximum bandwidth in MiB/s to use for migration.Zero means that all
available bandwidth will be used. The default value is zero.
Template
Delete a Virtual Machine

This is an idempotent operation. If the Virtual Machine is currently powered on, it will be
forcefully powered off. The logical timestamp can optionally be provided for consistency. If

a logical timestamp is specified, then this operation will be rejected if the logical timestamp
specified is not the value of the Virtual Machine logical timestamp. The logical timestamp can
be obtained from the Virtual Machine object. This is also an asynchronous operation that results
in the creation of a task object. The UUID of this task object is returned as the response of this
> Remove-NTNXVirtualMachine [[-Servers] <string[]>] -Vmid <Object>
> Remove-NTNXVirtualMachine [-Vmid <Object>] [-Template] [-ExpandedOutput]

> Remove-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Vmid
Optional arguments
Template
Update a Virtual Machine

Field that are not set or are not specified are ignored. Note that some attributes may not be
modifiable while the Virtual Machine is running. For instance, the KVM hypervisor does not
support CPU or memory hot-plug. The hwclockTimezone attribute specifies the VM's hardware
clock timezone. Most operating systems assume the system clock is UTC, but some (like
Windows) expect the local timezone. Changes to the clock timezone only take effect after a
full Virtual Machine power cycle. This API can be used to reclaim memory from guests using a
balloon driver. It is not currently possible to return ballooned memory to a guest. The attempt
to reclaim memory may fail if the balloon driver is not installed, or is unable to allocate the
requested amount of memory from the guest OS. In this case, the Virtual Machine's memory
reservation will be restored to its value from before the balloon attempt. If a logical timestamp
is specified, then this operation will be rejected if the logical timestamp specified is not the
value of the Virtual Machine logical timestamp. The logical timestamp can be obtained from the
Virtual Machine object. This is also an asynchronous operation that results in the creation of a
task object. The UUID of this task object is returned as the response of this operation. This task
can be monitored by using the /tasks/poll API.
> Set-NTNXVirtualMachine [[-Servers] <string[]>] -Vmid <Object>
[-VmLogicalTimestamp <long>] [-Uuid <string>] [-Name <string>] [-Description
<string>] [-NumVcpus <long>] [-NumCoresPerVcpu <long>] [-MemoryMb <long>]
[-Boot <BootConfigDTO>] [-Timezone <string>] [-HaPriority <long>]
> Set-NTNXVirtualMachine [-Vmid <Object>] [-VmLogicalTimestamp <long>] [-Uuid

<string>] [-Name <string>] [-Description <string>] [-NumVcpus <long>]
[-NumCoresPerVcpu <long>] [-MemoryMb <long>] [-Boot <BootConfigDTO>]
[-Timezone <string>] [-HaPriority <long>] [-Template] [-ExpandedOutput]
> Set-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]


Required arguments
Vmid
Optional arguments
VmLogicalTimestamp
Virtual Machine object.
Uuid
UUID of the VM.
Name
The Virtual Machine human readable name.
Description
Description for the Virtual Machine.
NumVcpus
Number of VCPUs assigned to the Virtual Machine.
NumCoresPerVcpu
Number of cores assigned to each VCPUs.
MemoryMb
RAM in megabytes assigned to the Virtual Machine.
Boot
Boot configuration for the Virtual Machine. Any updates to the boot
configuration will be applied during the next Virtual Machine power cycle but not
reset.
Timezone
The timezone for the VM's hardware clock. Any updates to the timezone will be
applied during the next VM power cycle (but not reset). The default is UTC.
HaPriority
Priority for restarting in case of HA event.
Template
Get a list of KVM managed Virtual Machines

Virtual Machine disk sizes and network address assignments are not included by default
as fetching these are expensive operations. These can be included by setting the
includeVMDiskSizes and includeAddressAssignments flags respectively.
> Get-NTNXVirtualMachine [[-Servers] <string[]>] [-Vmid <Object>]
[-IncludeVMDiskSizes] [-IncludeAddressAssignments] [-IncludeVMDiskPaths]
> Get-NTNXVirtualMachine [-Vmid <Object>] [-IncludeVMDiskSizes]

[-IncludeAddressAssignments] [-IncludeVMDiskPaths] [-ExpandedOutput]

> Get-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]
Required arguments
Vmid
Optional arguments
IncludeVMDiskSizes
Whether to include Virtual Machine disk sizes in bytes
IncludeVMDiskSizes
Whether to include Virtual Machine disk paths
Whether to include address assignments
IncludeVMDiskPaths
Whether to include Virtual Machine disk paths
Whether to include network address assignments
Clone a Virtual Machine from a snapshot or Virtual Machine.If a UUID is specified for the
cloned Virtual Machine, this operation will be idempotent
If overrideNetworkConfig is set to true in the clone spec, then the source Virtual Machine's
network configuration is overridden by one specified in the nic list. If false, the clone will inherit
its basic network configuration from the source, minus MAC and IP address. This is also an
asynchronous operation that results in the creation of a task object. The UUID of this task
tasks/poll API.
> Clone-NTNXVirtualMachine [[-Servers] <string[]>] -Vmid <Object> -SpecList
<VMCloneSpecDTO[]> [-Uuid <string>] [-VmCustomizationConfig
<VMCustomizationConfigDTO>] [-ContainerUuid <string>] [-ExpandedOutput]
> Clone-NTNXVirtualMachine [-Vmid <Object>] [-SpecList <VMCloneSpecDTO[]>]

[-Uuid <string>] [-VmCustomizationConfig <VMCustomizationConfigDTO>]
[-ContainerUuid <string>] [-Template] [-ExpandedOutput] [-GridView]
> Clone-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Vmid
SpecList
Optional arguments
Uuid
Uuid of the VM to clone.

VmCustomizationConfig
Vm customization configuration. At boot time, this config will be replayed by VM
customization tool(cloudinit/sysprep) installed in the VM to bring VM to the state
defined by this config.
ContainerUuid
UUID of the container on which the customization config iso files should be
created. Must be provided when cluster has more than one container.
UUID of the storage container on which the customization config iso files should
be created. Must be provided when cluster has more than one container.
Template
Create a Virtual Machine with specified configuration

If a UUID is specified for the Virtual Machine, this operation will be idempotent. This is an
asynchronous operation that results in the creation of a task object. The UUID of this task
tasks/poll API.
> New-NTNXVirtualMachine [[-Servers] <string[]>] -Name <string> -NumVcpus
<long> -MemoryMb <long> [-Description <string>] [-NumCoresPerVcpu <long>]
[-VcpuReservationHz <long>] [-MemoryReservationMb <long>] [-Uuid <string>]
[-VmDisks <VMDiskDTO[]>] [-VmNics <VMNicSpecDTO[]>] [-HostId <string>]
[-HypervisorType <NewVirtualMachine+Enum_Enum>] [-BootConfig <BootConfigDTO>]
[-HaPriority <long>] [-VmCustomizationConfig <VMCustomizationConfigDTO>]
[-ContainerUuid <string>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> New-NTNXVirtualMachine [-Name <string>] [-Description <string>] [-NumVcpus

<long>] [-NumCoresPerVcpu <long>] [-VcpuReservationHz <long>] [-MemoryMb
<long>] [-MemoryReservationMb <long>] [-Uuid <string>] [-VmDisks
<VMDiskDTO[]>] [-VmNics <VMNicSpecDTO[]>] [-HostId <string>] [-HypervisorType
<NewVirtualMachine+Enum_Enum>] [-BootConfig <BootConfigDTO>] [-HaPriority
<long>] [-VmCustomizationConfig <VMCustomizationConfigDTO>] [-ContainerUuid
> New-NTNXVirtualMachine [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
The Virtual Machine human readable name.
NumVcpus
Number of VCPUs assigned to the Virtual Machine.
MemoryMb
RAM, in megabytes assigned to the Virtual Machine.
Optional arguments
Description
Description for the Virtual Machine.

NumCoresPerVcpu
Number of cores assigned to each VCPUs.
VcpuReservationHz
CPU, in Hertz reserved for the Virtual Machine.
MemoryReservationMb
RAM, in megabytes reserved for the Virtual Machine.
Uuid
A version 4 UUID that the client may specify for idempotence
VmDisks
List of disk specification to add to the Virtual Machine.
VmNics
List of NIC specification to add to the Virtual Machine.
HostId
UUID of the host where the Virtual Machine needs to be placed. Either this or
hypervisorType needs to be specified.
HypervisorType
The hypervisor type for the Virtual Machine placement.Possible values are
VMware, Hyperv and Acropolis. Either this or hostId needs to be specified.
BootConfig
Boot configuration for the Virtual Machine. Any updates to the boot
configuration will be applied during the next Virtual Machine power cycle but not
reset.
HaPriority
Priority for restarting in case of HA event.
VmCustomizationConfig
Vm customization configuration. At boot time, this config will be replayed by VM
customization tool(cloudinit/sysprep) installed in the VM to bring VM to the state
defined by this config.
ContainerUuid
UUID of the container on which the customization config iso files should be
created. Must be provided when cluster has more than one container.
Template
256
AOS | VirusScanPolicy | 995

VIRUSSCANPOLICY
Operations
• Add Virus Scan Policy: Add-NTNXVirusScanPolicy

• Delete Virus Scan Policy: Del-NTNXVirusScanPolicy
• Delete virus Scan Policy: Delete-NTNXVirusScanPolicy
• Get a virus scan policy: Get-NTNXVirusScanPolicy
• Update Antivirus Server Scan Policy: Update-NTNXVirusScanPolicy

> Delete-NTNXVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object>
> Delete-NTNXVirusScanPolicy [-Uuid <Object>] [-Template] [-ExpandedOutput]

> Delete-NTNXVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Template
Get a single virus scan policy associated with a file server

> Get-NTNXVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object> [-ShareUuid
> Get-NTNXVirusScanPolicy [-Uuid <Object>] [-ShareUuid <Object>]

> Get-NTNXVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
ShareUuid

> Del-NTNXVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object> -ShareUuid
> Del-NTNXVirusScanPolicy [-Uuid <Object>] [-ShareUuid <Object>] [-Template]

> Del-NTNXVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that virus scan policy is associated with
ShareUuid
Optional arguments
Template

> Add-NTNXVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object>
> Add-NTNXVirusScanPolicy [-Uuid <Object>] [-ScanTimeoutIntervalInSecs <int>]

[-VirusScanPolicy_Uuid <string>] [-FileServerUuid <string>] [-ShareUuid
> Add-NTNXVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server
Optional arguments
Uuid
FileServerUuid
ShareUuid
Uuid of the Share

ScanOnWrite
ScanOnRead
Scan on read policy
FileSizeExclusion
File size exclusion
BlockAccessFile
Block access file
EnableAntiVirus
Enable antivirus
FileTypeExclusions
Template
Update Antivirus Server Scan Policy

> Update-NTNXVirusScanPolicy [[-Servers] <string[]>] -Uuid <Object>
> Update-NTNXVirusScanPolicy [-Uuid <Object>] [-ScanTimeoutIntervalInSecs

<int>] [-VirusScanPolicy_Uuid <string>] [-FileServerUuid <string>] [-ShareUuid
> Update-NTNXVirusScanPolicy [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Uuid of the file server that antivirus scan policy is associated with
Optional arguments
Uuid
FileServerUuid
ShareUuid
Uuid of the Share
ScanOnWrite

ScanOnRead
Scan on read policy
FileSizeExclusion
File size exclusion
BlockAccessFile
Block access file
EnableAntiVirus
Enable antivirus
FileTypeExclusions
Template

257
AOS | VolumeDisk | 1000

VOLUMEDISK
Operations
• Delete a Volume Disk: Delete-NTNXVolumeDisk

• Create a Volume Disk: New-NTNXVolumeDisk
• Updates a Volume Disk: Set-NTNXVolumeDisk
Creates a Volume Disk with specified configuration

> New-NTNXVolumeDisk [[-Servers] <string[]>] -Uuid <Object> [-VolumeGroupUuid
<string>] [-Index <int>] [-CreateSpec <VmDiskSpecCreateDTO>] [-CloneSpec
<VMDiskSpecCloneDTO>] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> New-NTNXVolumeDisk [-Uuid <Object>] [-VolumeGroupUuid <string>] [-Index

<int>] [-CreateSpec <VmDiskSpecCreateDTO>] [-CloneSpec <VMDiskSpecCloneDTO>]
> New-NTNXVolumeDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
UUID of the Volume Group
Optional arguments
VolumeGroupUuid
Index
Volume Group index of the disk
CreateSpec
VM disk create configuration
CreateConfig
VM disk create configuration
CloneSpec
VM disk clone configuration
CloneConfig
VM disk clone configuration
Template
Updates a Volume Disk with specified configuration

> Set-NTNXVolumeDisk [[-Servers] <string[]>] -Uuid <Object> -Index <int>
[-VolumeGroupUuid <string>] [-UpgradeSpec <UpgradeSpec>] [-CloneSpec
<VMDiskSpecCloneDTO>] [-FlashModeEnabled <bool>] [-ExpandedOutput] [-GridView]

> Set-NTNXVolumeDisk [-Uuid <Object>] [-Index <int>] [-VolumeGroupUuid
<string>] [-UpgradeSpec <UpgradeSpec>] [-CloneSpec <VMDiskSpecCloneDTO>]
[-FlashModeEnabled <bool>] [-Template] [-ExpandedOutput] [-GridView]
> Set-NTNXVolumeDisk [[-NutanixClusters] <NutanixCluster[]>] [-ExpandedOutput]

Required arguments
Uuid
Index
Optional arguments
VolumeGroupUuid
UpgradeSpec
CloneSpec
Clone
FlashModeEnabled
Flash mode enabled or not for the volume
Template
Delete a Volume Disk with specified configuration

> Delete-NTNXVolumeDisk [[-Servers] <string[]>] -Uuid <Object> -Index <int>
> Delete-NTNXVolumeDisk [-Uuid <Object>] [-Index <int>] [-LogicalTimestamp

> Delete-NTNXVolumeDisk [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Index
Optional arguments
LogicalTimestamp
The logical timestamp

Template

258
AOS | VolumeGroup | 1004

VOLUMEGROUP
Operations
• Attach Volume Group to Virtual Machine: AttachVm-NTNXVolumeGroup

• Clone a new Volume Group: Clone-NTNXVolumeGroup
• Close Volume Group for iSCSI initiators: Close-NTNXVolumeGroup
• Remove an existing Volume Group configuration: Delete-NTNXVolumeGroup
• Detach Volume Group to Virtual Machine: DetachVm-NTNXVolumeGroup
• Retrieve Volume Group configuration: Get-NTNXVolumeGroup
• Create a new Volume Group configuration: New-NTNXVolumeGroup
• Open Volume Group for iSCSI initiators: Open-NTNXVolumeGroup
• Modify an existing Volume Group configuration: Set-NTNXVolumeGroup
> New-NTNXVolumeGroup [[-Servers] <string[]>] -Name <string> [-Uuid <string>]

[-Description <string>] [-DiskList <VolumeDiskCreateSpecDTO[]>] [-IsShared
<bool>] [-IscsiTarget <string>] [-IscsiTargetPrefix <string>]
[-IscsiInitiatorNameList <string[]>] [-AttachedClients <IscsiClientDTO[]>]
[-FlashModeEnabled <bool>] [-LoadBalanceVmAttachments <bool>]
[-EnabledAuthentications <ClientAuthenticationDTO[]>] [-ExpandedOutput]
> New-NTNXVolumeGroup [-Uuid <string>] [-Name <string>] [-Description

<string>] [-DiskList <VolumeDiskCreateSpecDTO[]>] [-IsShared <bool>]
[-IscsiTarget <string>] [-IscsiTargetPrefix <string>] [-IscsiInitiatorNameList
<string[]>] [-AttachedClients <IscsiClientDTO[]>] [-FlashModeEnabled <bool>]
[-LoadBalanceVmAttachments <bool>] [-EnabledAuthentications
<ClientAuthenticationDTO[]>] [-Template] [-ExpandedOutput] [-GridView]
> New-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Name
Volume Group name
Optional arguments
Uuid
Volume Group UUID (optional)
Description
Volume Group description
DiskList
Volume Group disk specification

IsShared
True or false indicating whether volume is shared across multiple iSCSI initiators
IscsiTarget
iSCSI target name
IscsiTargetPrefix
iSCSI target prefix name
IscsiInitiatorNameList
iSCSI qualified name list
AttachedClients
List of the attached clients
FlashModeEnabled
Flash mode enabled or not for the volume group
LoadBalanceVmAttachments
Whether to enable VG load balancing for vm attachments
EnabledAuthentications
List of supported authentication types
Template
> Get-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object>

[-IncludeDiskSize] [-IncludeDiskPath] [-ExpandedOutput] [-GridView]
> Get-NTNXVolumeGroup [-Uuid <Object>] [-IncludeDiskSize] [-IncludeDiskPath]

> Get-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
IncludeDiskSize
Whether to include disk sizes
IncludeDiskPath
Whether to include disk paths
> Set-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object>

[-VolumeGroupUpdate_Uuid <string>] [-Name <string>] [-Description <string>]
[-LogicalTimestamp <long>] [-IsShared <bool>] [-IscsiTarget <string>]
[-IscsiTargetPrefix <string>] [-IscsiInitiatorNameList <string[]>]
[-AttachedClients <IscsiClientDTO[]>] [-FlashModeEnabled <bool>]
<ClientAuthenticationDTO[]>] [-ExpandedOutput] [-GridView]

> Set-NTNXVolumeGroup [-Uuid <Object>] [-VolumeGroupUpdate_Uuid <string>]

[-Name <string>] [-Description <string>] [-LogicalTimestamp <long>] [-IsShared
<bool>] [-IscsiTarget <string>] [-IscsiTargetPrefix <string>]
[-IscsiInitiatorNameList <string[]>] [-AttachedClients <IscsiClientDTO[]>]
[-FlashModeEnabled <bool>] [-LoadBalanceVmAttachments <bool>]
[-EnabledAuthentications <ClientAuthenticationDTO[]>] [-Template]
> Set-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Uuid
Name
Volume Group name
Description
Volume Group description
LogicalTimestamp
IsShared
True or false indicating whether volume is shared across multiple iSCSI initiators
IscsiTarget
iSCSI target name
IscsiTargetPrefix
iSCSI target prefix
IscsiInitiatorNameList
iSCSI qualified name list
AttachedClients
List of the attached clients
FlashModeEnabled
Flash mode enabled or not for the volume group
Template
> Close-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object>

[-VolumeGroupAttachExternal_Uuid <string>] [-LogicalTimestamp <long>]
[-IscsiInitiator <string>] [-IscsiClientIp <string>] [-Operation
<CloseVolumeGroup+VolumeGroupAttachOperation_Enum>] [-ExpandedOutput]
> Close-NTNXVolumeGroup [-Uuid <Object>] [-VolumeGroupAttachExternal_Uuid

<string>] [-LogicalTimestamp <long>] [-IscsiInitiator <string>]
[-IscsiClientIp <string>] [-Operation
<CloseVolumeGroup+VolumeGroupAttachOperation_Enum>] [-Template]
> Close-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Uuid
LogicalTimestamp
IscsiInitiator
iSCSI qualified name
IscsiClientIp
iSCSI client ip address
IscsiClient
Operation
Template
> AttachVm-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object> -VmUuid

<string> [-VolumeGroupAttachVm_Uuid <string>] [-LogicalTimestamp <long>]
[-VmLogicalTimestamp <long>] [-Index <int>] [-Operation
<AttachVmVolumeGroup+VolumeGroupAttachOperation_Enum>] [-ExpandedOutput]
> AttachVm-NTNXVolumeGroup [-Uuid <Object>] [-VolumeGroupAttachVm_Uuid

<string>] [-VmUuid <string>] [-LogicalTimestamp <long>] [-VmLogicalTimestamp
<long>] [-Index <int>] [-Operation
<AttachVmVolumeGroup+VolumeGroupAttachOperation_Enum>] [-Template]
> AttachVm-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]


Required arguments
Uuid
VmUuid
Virtual machine UUID
Optional arguments
Uuid
LogicalTimestamp
The volume group logical timestamp
VmLogicalTimestamp
The virtual machine logical timestamp
Index
Operation
Template
> DetachVm-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object> -VmUuid

<string> [-VolumeGroupAttachVm_Uuid <string>] [-LogicalTimestamp <long>]
[-VmLogicalTimestamp <long>] [-Index <int>] [-Operation
<DetachVmVolumeGroup+VolumeGroupAttachOperation_Enum>] [-ExpandedOutput]
> DetachVm-NTNXVolumeGroup [-Uuid <Object>] [-VolumeGroupAttachVm_Uuid

<string>] [-VmUuid <string>] [-LogicalTimestamp <long>] [-VmLogicalTimestamp
<long>] [-Index <int>] [-Operation
<DetachVmVolumeGroup+VolumeGroupAttachOperation_Enum>] [-Template]
> DetachVm-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
VmUuid
Virtual machine UUID
Optional arguments
Uuid
LogicalTimestamp
The volume group logical timestamp
VmLogicalTimestamp
The virtual machine logical timestamp

Index
Operation
Template
> Clone-NTNXVolumeGroup [[-Servers] <string[]>] -SourceVolumeGroupUuid

<Object> [-Name <string>] [-Uuid <string>] [-IscsiTarget <string>]
[-IscsiTargetPrefix <string>] [-LogicalTimestamp <long>]
<ClientAuthenticationDTO[]>] [-ExpandedOutput] [-GridView]
> Clone-NTNXVolumeGroup [-SourceVolumeGroupUuid <Object>] [-Name <string>]

[-Uuid <string>] [-IscsiTarget <string>] [-IscsiTargetPrefix <string>]
[-LogicalTimestamp <long>] [-LoadBalanceVmAttachments <bool>]
[-EnabledAuthentications <ClientAuthenticationDTO[]>] [-Template]
> Clone-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
SourceVolumeGroupUuid
UUID of the source Volume Group
Optional arguments
Name
Name of the clone (optional)
Uuid
UUID of the cloned Volume Group (optional)
IscsiTarget
iSCSI target name for the clone (optional)
IscsiTargetPrefix
iSCSI target prefix for the clone (optional)
LogicalTimestamp
Template

> Open-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object>
[-VolumeGroupAttachExternal_Uuid <string>] [-LogicalTimestamp <long>]
[-IscsiInitiator <string>] [-IscsiClientIp <string>] [-Operation
<OpenVolumeGroup+VolumeGroupAttachOperation_Enum>] [-ExpandedOutput]
> Open-NTNXVolumeGroup [-Uuid <Object>] [-VolumeGroupAttachExternal_Uuid

<string>] [-LogicalTimestamp <long>] [-IscsiInitiator <string>]
[-IscsiClientIp <string>] [-Operation
<OpenVolumeGroup+VolumeGroupAttachOperation_Enum>] [-Template]
> Open-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid
Optional arguments
Uuid
LogicalTimestamp
IscsiInitiator
iSCSI qualified name
IscsiClientIp
iSCSI client ip address
IscsiClient
Operation
Template
> Delete-NTNXVolumeGroup [[-Servers] <string[]>] -Uuid <Object>

> Delete-NTNXVolumeGroup [-Uuid <Object>] [-LogicalTimestamp <long>]

> Delete-NTNXVolumeGroup [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
Uuid

Optional arguments
LogicalTimestamp
Template
259
AOS | VolumeGroups | 1013

VOLUMEGROUPS
Operations
• Retrieve Volume Group configuration: Get-NTNXVolumeGroups
> Get-NTNXVolumeGroups [[-Servers] <string[]>] [-IncludeDiskSize]

[-IncludeDiskPath] [-ExpandedOutput] [-GridView] [<CommonParameters>]
> Get-NTNXVolumeGroups [-IncludeDiskSize] [-IncludeDiskPath] [-ExpandedOutput]

> Get-NTNXVolumeGroups [[-NutanixClusters] <NutanixCluster[]>]

Required arguments
None
Optional arguments
IncludeDiskSize
Whether to include disk sizes, true by default
IncludeDiskPath
Whether to include disk paths, true by default
COPYRIGHT
Copyright 2021 Nutanix, Inc.
Nutanix, Inc.
1740 Technology Drive, Suite 150
San Jose, CA 95110
All rights reserved. This product is protected by U.S. and international copyright and intellectual
property laws. Nutanix and the Nutanix logo are registered trademarks of Nutanix, Inc. in the
United States and/or other jurisdictions. All other brand and product names mentioned herein
are for identification purposes only and may be trademarks of their respective holders.
License
The provision of this software to you does not grant any licenses or other rights under any
Microsoft patents with respect to anything other than the file server implementation portion of
the binaries for this software, including no licenses or any other rights in any hardware or any
devices or software that are used to communicate with or in connection with this software.
Conventions
Convention Description
variable_value The action depends on a value that is unique to your environment.
ncli> command The commands are executed in the Nutanix nCLI.
user@host$ command The commands are executed as a non-privileged user (such as

nutanix) in the system shell.
root@host# command The commands are executed as the root user in the vSphere or
Acropolis host shell.
> command The commands are executed in the Hyper-V host shell.
output The information is displayed as output from a command or in a

log file.
Version
Last modified: June 14, 2021 (2021-06-14T10:17:11+05:30)
AOS |

API Ref AOS v6 - 0

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Ref AOS v6 - 0

Uploaded by

Copyright:

Available Formats

AOS 6.

Acropolis v1 API Reference

1. Nutanix REST API...................................................................................................15

2. About Nutanix PowerShell Cmdlets..............................................................20

Part I: REST API Reference.................................................................................... 26

Part II: PowerShell Cmdlets Reference........................................................... 409

• v1: The original Nutanix REST API.

Accessing the REST API Explorer

AOS | Nutanix REST API | 15

1. Open the explorer for the desired version of the API.

Figure 1: User menu

Figure 2: API version selection

• Show/Hide: Expand or reduce the detail shown for the object

AOS | Nutanix REST API | 16

Figure 4: Cluster Operations

AOS | Nutanix REST API | 17

Figure 5: Get Cluster Details

Figure 6: Get Cluster Details Response

AOS | Nutanix REST API | 18

Status Code Definition

Status Code Definition

Status Code Definition

AOS | Nutanix REST API | 19

Installing PowerShell Cmdlets

1. Sign in to the Nutanix web console.

PowerShell Cmdlets Usage

• Replace cluster_ip_address with the cluster virtual IP address or a Controller VM IP address.

• Replace admin_password with the Nutanix user password.

AOS | About Nutanix PowerShell Cmdlets | 20

Cmdlets version info

Cmdlet Name Parameter Name Valid Values

Set-NTNXSmtpServer SecureMode STARTTLS

Set-NTNXCluster SupportVerbosityType NOTHING

AOS | About Nutanix PowerShell Cmdlets | 21

Set-NTNXHealthCheck AffectedEntityTypes CLUSTER

New-NTNXRemoteSite Capabilities BACKUP

Set-NTNXRemoteSite Capabilities BACKUP

New-NTNXContainer FingerPrintOnWrite NONE

New-NTNXContainer OnDiskDedup NONE

Set-NTNXContainer FingerPrintOnWrite NONE

Set-NTNXContainer OnDiskDedup NONE

AOS | About Nutanix PowerShell Cmdlets | 22

New-NTNXVdisk FingerPrintOnWrite NONE

New-NTNXVdisk OnDiskDedup NONE

Set-NTNXVdisk FingerPrintOnWrite NONE

Set-NTNXVdisk OnDiskDedup NONE

Add-NTNXAuthType InputList LOCAL

Add-NTNXDirectoryConfig DirectoryType ACTIVE_DIRECTORY

Add-NTNXDirectoryConfig ConnectionType LDAP

Remove-NTNXAuthType InputList LOCAL

Set-NTNXDirectoryConfig DirectoryType ACTIVE_DIRECTORY

Set-NTNXDirectoryConfig ConnectionType LDAP

Set-NTNXAuthType InputList LOCAL

Set-NTNXAuthConfig AuthTypeList LOCAL

Remove-NTNXSnmpTransport TransportProtocol TCP

Add-NTNXSnmpTransport TransportProtocol TCP

Add-NTNXSnmpUser AuthType MD_5

AOS | About Nutanix PowerShell Cmdlets | 23

Add-NTNXSnmpUser privType DES

Set-NTNXSnmpTrap TransportProtocol TCP

Set-NTNXSnmpUser AuthType MD_5

Set-NTNXSnmpUser privType DES

Add-NTNXProtectionDomainCronSchedule Type MINUTELY