Add Notes on VMware VM
This object will append or replace the notes on one or more VMware virtual machines.
Before using this VMware Automation Manager Object, you must install the PowerShell module VMware.PowerCLI.
This VMware Automation Object runs on 64-bit PowerShell, and the module must also be added to 64-bit PowerShell.
Before using this VMware Automation Manager Object, you must install PowerShell 5.0.
Input Parameters
Name | Type | Required | Description |
---|---|---|---|
Session ID | String | Yes | The session ID that is generated by the VMware connection object. This is required for this object to work. |
Virtual Machine Name | String | Yes | The name of the virtual machine(s) for which notes need to be added or updated. The field supports wildcards, so to update the notes on all virtual machines at once, use "*" as the value. |
Notes | String | Yes | These are the notes to be added or updated. |
Action | String | Yes | The action you want to take with the notes:
|
Output Parameters
Name | Type | Description |
---|---|---|
Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Result String | String | Object execution error details. |
Example Input Parameters
Name | Type | Required | Example |
---|---|---|---|
Session ID | String | Yes | ab4c55c1273cb609678a2bb6a15104e927ac8dec 10.199.2.23 |
Virtual Machine Name | String | Yes | Vmwin10 * |
Notes | String | Yes | VM created on 2019-08-01 |
Action | String | Yes | Replace |