Kelverion.Vmware.Vsphere.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.41--> <!-- Module: Kelverion.Vmware.Vsphere Version: 1.0.0.0 --> <!-- All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Add-VsphereVmDevice</command:name> <maml:description> <maml:para>Adds a new device to an existing VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>VsphereVmDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds a new device to an existing VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="HardDisk" default="true"> <!--TAG: DEFAULT--> <!--NAME: HardDisk--> <maml:name>Add-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeMb</maml:name> <maml:description> <maml:para>Size of the new hard disk, in MB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Provision type for the new hard disk. Allowed values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NetworkAdapter"> <!--NAME: NetworkAdapter--> <maml:name>Add-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the drive should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the network to be assigned to the new network adapter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkAdapterType</maml:name> <maml:description> <maml:para>The type of network adapter to be added. This should be one of the NICs available for the Compute Resource (or Cluster Compute Resource) owner of the Resource Pool of the VM, and it should be supported by the operating system of the VM. Accepted values are: VirtualE1000 VirtualE1000e VirtualPCNet32 VirtualVmxnet VirtualVmxnet2 VirtualVmxnet3</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VirtualE1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualE1000e</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualPCNet32</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet2</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet3</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveDatastoreIso"> <!--NAME: CdDriveDatastoreIso--> <maml:name>Add-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the drive should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>The type of CD/DVD drive that is to be added to the VM. This parameter is only available when DeviceType is CD/DVD Drive. Accepted values are: Client Device - connect the device to a physical CD/DVD device on the system from which you access the vSphere Client Host Device - connect the device to a physical CD/DVD device on the host. Datastore ISO File - connect the device to an ISO file that is stored on a datastore accessible to the host.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoFilePath</maml:name> <maml:description> <maml:para>Location of the datastore ISO file for the device, in the form [<datastore name>] <ISO file Path>. For example: [DS-DEV-01] ISO/windows/ windows_10_x64.iso</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoDatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the ISO file is stored. The datastore must correspond to the datastore specified in the ISO File Path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveClientDevice"> <!--NAME: CdDriveClientDevice--> <maml:name>Add-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>The type of CD/DVD drive that is to be added to the VM. This parameter is only available when DeviceType is CD/DVD Drive. Accepted values are: Client Device - connect the device to a physical CD/DVD device on the system from which you access the vSphere Client Host Device - connect the device to a physical CD/DVD device on the host. Datastore ISO File - connect the device to an ISO file that is stored on a datastore accessible to the host.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveHostDevice"> <!--NAME: CdDriveHostDevice--> <maml:name>Add-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the drive should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>The type of CD/DVD drive that is to be added to the VM. This parameter is only available when DeviceType is CD/DVD Drive. Accepted values are: Client Device - connect the device to a physical CD/DVD device on the system from which you access the vSphere Client Host Device - connect the device to a physical CD/DVD device on the host. Datastore ISO File - connect the device to an ISO file that is stored on a datastore accessible to the host.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostDevicePath</maml:name> <maml:description> <maml:para>Location of host device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of device that is to be added to the VM. Accepted values are: CD/DVD Drive Hard Disk Network Adapter</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM to which the device is to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskSizeMb</maml:name> <maml:description> <maml:para>Size of the new hard disk, in MB.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Provision type for the new hard disk. Allowed values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the drive should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the network to be assigned to the new network adapter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NetworkAdapterType</maml:name> <maml:description> <maml:para>The type of network adapter to be added. This should be one of the NICs available for the Compute Resource (or Cluster Compute Resource) owner of the Resource Pool of the VM, and it should be supported by the operating system of the VM. Accepted values are: VirtualE1000 VirtualE1000e VirtualPCNet32 VirtualVmxnet VirtualVmxnet2 VirtualVmxnet3</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VirtualE1000</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualE1000e</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualPCNet32</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet2</command:parameterValue> <command:parameterValue required="false" variableLength="false">VirtualVmxnet3</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>The type of CD/DVD drive that is to be added to the VM. This parameter is only available when DeviceType is CD/DVD Drive. Accepted values are: Client Device - connect the device to a physical CD/DVD device on the system from which you access the vSphere Client Host Device - connect the device to a physical CD/DVD device on the host. Datastore ISO File - connect the device to an ISO file that is stored on a datastore accessible to the host.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IsoFilePath</maml:name> <maml:description> <maml:para>Location of the datastore ISO file for the device, in the form [<datastore name>] <ISO file Path>. For example: [DS-DEV-01] ISO/windows/ windows_10_x64.iso</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IsoDatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the ISO file is stored. The datastore must correspond to the datastore specified in the ISO File Path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>HostDevicePath</maml:name> <maml:description> <maml:para>Location of host device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The Device Key of the newly added device.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Get-VsphereCustomAttribute</command:name> <maml:description> <maml:para>Retrieves VM or Host custom attributes.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsphereCustomAttribute</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves VM or Host custom attributes.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="ById" default="true"> <!--NAME: ById--> <!--TAG: DEFAULT--> <maml:name>Get-VsphereCustomAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VsphereObjectId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM or host for which custom attributes are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-VsphereCustomAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM or host for which custom attributes are to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VsphereObjectId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM or host for which custom attributes are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM or host for which custom attributes are to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Attribute Key - Unique custom attribute identifier. Attribute Name - Name of the custom attribute. Attribute Type - Custom attribute type. Can be Global, Host or VM Attribute Value - Custom attribute value.</maml:para> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Get-VsphereObject</command:name> <maml:description> <maml:para>Retrieves vSphere objects.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsphereObject</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves vSphere objects. Supported vSphere object types: Cluster, Compute Resource, Datacenter, Datastore, Folder, Host, Network, Resource Pool, VM.</maml:para> <maml:para /> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="VM" default="true"> <!--NAME: VM--> <!--TAG: DEFAULT--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific VM to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Cluster"> <!--NAME: Cluster--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClusterId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific cluster to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ComputeResource"> <!--NAME: ComputeResource--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputeResourceId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific compute resource to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeCluster</maml:name> <maml:description> <maml:para>Specifies that cluster objects are to be excluded, when retrieving compute resources.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Datacenter"> <!--NAME: Datacenter--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatacenterId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific datacenter to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Datastore"> <!--NAME: Datastore--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific datastore to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreComputeResourceId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a compute resource for which datastores are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Folder"> <!--NAME: Folder--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific folder to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Host"> <!--NAME: Host--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific host to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Network"> <!--NAME: Network--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific network object to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ResourcePool"> <!--NAME: ResourcePool--> <maml:name>Get-VsphereObject</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific resource pool to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeVirtualApp</maml:name> <maml:description> <maml:para>Specifies that Virtual App objects are to be excluded when retrieving resource pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ObjectType</maml:name> <maml:description> <maml:para>Specifies the type of objects that are to be retrieved. Accepted values are: Cluster Compute Resource Datacenter Datastore Folder Host Network Resource Pool VM</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Cluster</command:parameterValue> <command:parameterValue required="false" variableLength="false">Compute Resource</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datacenter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore</command:parameterValue> <command:parameterValue required="false" variableLength="false">Folder</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network</command:parameterValue> <command:parameterValue required="false" variableLength="false">Resource Pool</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more filters. For example: @([PSCustomObject]@{'Id'='Name';'Operator'='EqualTo';'Value'='VM-SqlServer'},[PSCustomObject]@{'Id'='Parent';'Operator'='EqualTo';'Value'='Folder-group-v123'})</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific VM to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ClusterId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific cluster to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ComputeResourceId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific compute resource to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExcludeCluster</maml:name> <maml:description> <maml:para>Specifies that cluster objects are to be excluded, when retrieving compute resources.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatacenterId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific datacenter to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific datastore to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreComputeResourceId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a compute resource for which datastores are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific folder to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific host to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific network object to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) for a specific resource pool to be retrieved.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ExcludeVirtualApp</maml:name> <maml:description> <maml:para>Specifies that Virtual App objects are to be excluded when retrieving resource pools.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The list of outputs returned by the cmdlet varies based on the specified Object Type. Refer to the Integration Module User Guide for details on each set of outputs.</maml:para> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Get-VsphereVmDevice</command:name> <maml:description> <maml:para>Retrieves VM devices.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsphereVmDevice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves VM devices.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM for which devices are to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of devices that are to be retrieved. Allowed values are: All Devices Hard Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">All Devices</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Get-VsphereVmDevice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which devices are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of devices that are to be retrieved. Allowed values are: All Devices Hard Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">All Devices</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM for which devices are to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DeviceType</maml:name> <maml:description> <maml:para>Specifies the type of devices that are to be retrieved. Allowed values are: All Devices Hard Disk</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">All Devices</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which devices are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The list of outputs returned by the cmdlet varies based on the specified Device Type. Refer to the Integration Module User Guide for details on each set of outputs.</maml:para> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Get-VsphereVmInfo</command:name> <maml:description> <maml:para>Retrieves additional VM details such as Guest OS information or VM state.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsphereVmInfo</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves additional VM details such as Guest OS information or VM state.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-VsphereVmInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM for which additional information is to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmInfoType</maml:name> <maml:description> <maml:para>Specifies the type of information to be retrieved. Accepted values are: VM Guest Info VM Status</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Guest Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Status</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Get-VsphereVmInfo</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmInfoType</maml:name> <maml:description> <maml:para>Specifies the type of information to be retrieved. Accepted values are: VM Guest Info VM Status</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Guest Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Status</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM for which additional information is to be retrieved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmInfoType</maml:name> <maml:description> <maml:para>Specifies the type of information to be retrieved. Accepted values are: VM Guest Info VM Status</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Guest Info</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Status</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The list of outputs returned by the cmdlet varies based on the specified Info Type. Refer to the Integration Module User Guide for details on each set of outputs.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-VsphereVmSnapshot</command:name> <maml:description> <maml:para>Retrieves VM snapshots.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>VsphereVmSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves VM snapshots.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByVmId" default="true"> <!--NAME: ByVmId--> <!--TAG: DEFAULT--> <maml:name>Get-VsphereVmSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="VM ID"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which snapshots are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="BySnapshotId"> <!--NAME: BySnapshotId--> <maml:name>Get-VsphereVmSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SnapshotId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the snapshot to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="VM ID"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which snapshots are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SnapshotId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the snapshot to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Snapshot objects that were retrieved. Refer to the Integration Module User Guide for details on output fields.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Move-VsphereVm</command:name> <maml:description> <maml:para>Moves a VM to another folder/datastore/resource pool.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Move</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Moves a VM to another folder/datastore/resource pool.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Move-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be moved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the folder where the VM is to be moved. When not specified: • If moving within the same datacenter, the VM will keep the same folder. • If moving to another datacenter, the root VM folder of the destination datacenter will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the host where the VM is to be moved. If specified, the specified resource pool and datastore must be accessible from the specified host. If not specified: • If the Resource Pool is not specified, the current VM host will be used. • If the Resource Pool is specified, and it is associated with a stand-alone host, that host will be used. • If the Resource Pool is specified, and it is associated with a DRS enabled cluster, a host selected by DRS will be used.</maml:para> <maml:para>Typically, this parameter is specified when moving the VM to another host in a cluster, where multiple hosts are associated with the same resource pool. When moving the VM to a stand-alone host, that host is implicitly specified by the resource pool and this parameter does not have to be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the VM is to be moved. The specified datastore must be accessible for the specified resource pool. • If not specified, the current VM datastore will be used. • If not specified and the current VM datastore is not accessible, the activity will fail. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM datastore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the resource pool where the VM is to be moved. Specifying the resource pool also implicitly specifies the host (in the case of a stand-alone host), or the cluster. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM resource pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Specifies provisioning for the moved VM disk(s). If Disk Drive Key is not specified, the specified provisioning will be applied to all VM disks. Acceptable values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskDriveKey</maml:name> <maml:description> <maml:para>Identifies the VM disk(s) for which DiskProvision is to be applied. If not specified, DiskProvision will be applied to all VM disks. To specify multiple disks, use a comma (,) separated list of drive keys.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Move-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the folder where the VM is to be moved. When not specified: • If moving within the same datacenter, the VM will keep the same folder. • If moving to another datacenter, the root VM folder of the destination datacenter will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the host where the VM is to be moved. If specified, the specified resource pool and datastore must be accessible from the specified host. If not specified: • If the Resource Pool is not specified, the current VM host will be used. • If the Resource Pool is specified, and it is associated with a stand-alone host, that host will be used. • If the Resource Pool is specified, and it is associated with a DRS enabled cluster, a host selected by DRS will be used.</maml:para> <maml:para>Typically, this parameter is specified when moving the VM to another host in a cluster, where multiple hosts are associated with the same resource pool. When moving the VM to a stand-alone host, that host is implicitly specified by the resource pool and this parameter does not have to be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the VM is to be moved. The specified datastore must be accessible for the specified resource pool. • If not specified, the current VM datastore will be used. • If not specified and the current VM datastore is not accessible, the activity will fail. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM datastore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the resource pool where the VM is to be moved. Specifying the resource pool also implicitly specifies the host (in the case of a stand-alone host), or the cluster. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM resource pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Specifies provisioning for the moved VM disk(s). If Disk Drive Key is not specified, the specified provisioning will be applied to all VM disks. Acceptable values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskDriveKey</maml:name> <maml:description> <maml:para>Identifies the VM disk(s) for which DiskProvision is to be applied. If not specified, DiskProvision will be applied to all VM disks. To specify multiple disks, use a comma (,) separated list of drive keys.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be moved. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the folder where the VM is to be moved. When not specified: • If moving within the same datacenter, the VM will keep the same folder. • If moving to another datacenter, the root VM folder of the destination datacenter will be used.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the host where the VM is to be moved. If specified, the specified resource pool and datastore must be accessible from the specified host. If not specified: • If the Resource Pool is not specified, the current VM host will be used. • If the Resource Pool is specified, and it is associated with a stand-alone host, that host will be used. • If the Resource Pool is specified, and it is associated with a DRS enabled cluster, a host selected by DRS will be used.</maml:para> <maml:para>Typically, this parameter is specified when moving the VM to another host in a cluster, where multiple hosts are associated with the same resource pool. When moving the VM to a stand-alone host, that host is implicitly specified by the resource pool and this parameter does not have to be specified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the VM is to be moved. The specified datastore must be accessible for the specified resource pool. • If not specified, the current VM datastore will be used. • If not specified and the current VM datastore is not accessible, the activity will fail. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM datastore.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the resource pool where the VM is to be moved. Specifying the resource pool also implicitly specifies the host (in the case of a stand-alone host), or the cluster. • Must be specified when moving the VM to another datacenter. • Must be specified when moving the VM to another host that is not associated with the current VM resource pool.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Specifies provisioning for the moved VM disk(s). If Disk Drive Key is not specified, the specified provisioning will be applied to all VM disks. Acceptable values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskDriveKey</maml:name> <maml:description> <maml:para>Identifies the VM disk(s) for which DiskProvision is to be applied. If not specified, DiskProvision will be applied to all VM disks. To specify multiple disks, use a comma (,) separated list of drive keys.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the moved VM.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>New-VsphereVm</command:name> <maml:description> <maml:para>Creates a new VM based on a template.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a new VM based on a template.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the folder where the new VM is to be located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the template on which the new VM is based.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the new VM is to be located. The specified datastore must be accessible for the specified resource pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the resource pool for the new VM. Specifying the resource pool also implicitly specifies the host (in the case of a stand-alone host), or the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the host where the VM should be created. If specified, the specified resource pool and datastore must be accessible from the specified host. • This parameter is optional when creating a new VM under a stand-alone host since the host is implicitly specified by the specified resource pool. • This parameter is optional when creating a new VM under a DRS enabled Cluster, since the host is assigned automatically from the DRS Cluster implicitly specified by the specified resource pool. • This parameter is required when creating a VM under to a non DRS Cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CustomSpec</maml:name> <maml:description> <maml:para>The name of a Customization Spec which is to be applied to the new VM. You can use the vSphere Customization Specifications Manager (under Home/Management) to configure VM customization specs. VMware Tools must be installed on the template source VM in order for a customization spec to be applied. A customization spec is applied on a new VM after the VM is started the first time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Provision type for the all the hard disks on the new VM. Use this parameter when you wish the new VM to have a different provision than the one specified in the VM template. Accepted values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>FolderId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the folder where the new VM is to be located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TemplateId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the template on which the new VM is based.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the new VM is to be located. The specified datastore must be accessible for the specified resource pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ResourcePoolId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the resource pool for the new VM. Specifying the resource pool also implicitly specifies the host (in the case of a stand-alone host), or the cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>HostId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the host where the VM should be created. If specified, the specified resource pool and datastore must be accessible from the specified host. • This parameter is optional when creating a new VM under a stand-alone host since the host is implicitly specified by the specified resource pool. • This parameter is optional when creating a new VM under a DRS enabled Cluster, since the host is assigned automatically from the DRS Cluster implicitly specified by the specified resource pool. • This parameter is required when creating a VM under to a non DRS Cluster.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CustomSpec</maml:name> <maml:description> <maml:para>The name of a Customization Spec which is to be applied to the new VM. You can use the vSphere Customization Specifications Manager (under Home/Management) to configure VM customization specs. VMware Tools must be installed on the template source VM in order for a customization spec to be applied. A customization spec is applied on a new VM after the VM is started the first time.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskProvision</maml:name> <maml:description> <maml:para>Provision type for the all the hard disks on the new VM. Use this parameter when you wish the new VM to have a different provision than the one specified in the VM template. Accepted values are: Thick Provision Lazy Zeroed Thick Provision Eager Zeroed Thin Provision</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Thick Provision Lazy Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thick Provision Eager Zeroed</command:parameterValue> <command:parameterValue required="false" variableLength="false">Thin Provision</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the new VM.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-VsphereVmSnapshot</command:name> <maml:description> <maml:para>Creates a new snapshot for the specified VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>VsphereVmSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a new snapshot for the specified VM.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-VsphereVmSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="VM ID"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which the snapshot will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name for the new snapshot. The name does not need to be unique for the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Snapshot description. If not specified, a default description may be provided.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVmMemory</maml:name> <maml:description> <maml:para>Specifies if a memory dump of the internal state of the virtual machine is included in the snapshot. Memory snapshots consume time and resources, and thus take longer to create. When set to False, the power state of the snapshot is set to powered off.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QuiesceGuestFileSystem</maml:name> <maml:description> <maml:para>Specifies if VMware Tools is used to quiesce the file system in the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If set to True, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system. If the virtual machine is powered off or VMware Tools are not available, the quiesce value is ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="VM ID"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM for which the snapshot will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name for the new snapshot. The name does not need to be unique for the VM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Snapshot description. If not specified, a default description may be provided.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeVmMemory</maml:name> <maml:description> <maml:para>Specifies if a memory dump of the internal state of the virtual machine is included in the snapshot. Memory snapshots consume time and resources, and thus take longer to create. When set to False, the power state of the snapshot is set to powered off.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>QuiesceGuestFileSystem</maml:name> <maml:description> <maml:para>Specifies if VMware Tools is used to quiesce the file system in the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If set to True, and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system. If the virtual machine is powered off or VMware Tools are not available, the quiesce value is ignored.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the new snapshot.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Remove-VsphereVm</command:name> <maml:description> <maml:para>Removes a VM from inventory, or permanently from disk.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a VM from inventory, or permanently from disk.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Remove-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be removed. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteFromDisk</maml:name> <maml:description> <maml:para>Specifies that the VM will be permanently deleted from disk. If not specified, the VM will be un-registered from inventory. Un-registered VMs can be later be re-registered and become part of inventory again. A re-registered VM will have a different ID (managed object reference) than before it was un-registered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Remove-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be removed. After the VM is removed, this ID is no longer valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeleteFromDisk</maml:name> <maml:description> <maml:para>Specifies that the VM will be permanently deleted from disk. If not specified, the VM will be un-registered from inventory. Un-registered VMs can be later be re-registered and become part of inventory again. A re-registered VM will have a different ID (managed object reference) than before it was un-registered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be removed. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DeleteFromDisk</maml:name> <maml:description> <maml:para>Specifies that the VM will be permanently deleted from disk. If not specified, the VM will be un-registered from inventory. Un-registered VMs can be later be re-registered and become part of inventory again. A re-registered VM will have a different ID (managed object reference) than before it was un-registered.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be removed. After the VM is removed, this ID is no longer valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the removed VM. Note that this ID is no longer valid after the VM removal.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-VsphereVmSnapshot</command:name> <maml:description> <maml:para>Removes a VM snapshot.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>VsphereVmSnapshot</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes a VM snapshot.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-VsphereVmSnapshot</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Snapshot ID"> <maml:name>SnapshotId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the snapshot that is to be removed. After the snapshot is removed, this ID is no longer valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveChildren</maml:name> <maml:description> <maml:para>Specifies if the entire snapshot subtree will be removed. Default value is False.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Consolidate</maml:name> <maml:description> <maml:para>Specifies if the virtual disk associated with this snapshot will be merged with other disk(s), if possible. Default value is True.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Snapshot ID"> <maml:name>SnapshotId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the snapshot that is to be removed. After the snapshot is removed, this ID is no longer valid.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RemoveChildren</maml:name> <maml:description> <maml:para>Specifies if the entire snapshot subtree will be removed. Default value is False.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Consolidate</maml:name> <maml:description> <maml:para>Specifies if the virtual disk associated with this snapshot will be merged with other disk(s), if possible. Default value is True.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[] </maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID managed object reference (MOR) of the snapshot that was removed. Note that this MOR is no longer valid, as the snapshot no longer exists.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Restart-VsphereVm</command:name> <maml:description> <maml:para>Restarts a running VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Restart</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Restarts a running VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Restart-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be restarted. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be rebooted (soft restart) or if the VM power will be reset (hard restart). The VM must have VMware Tools installed and running in order for the activity to reboot (soft restart) the VM.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the activity will be waiting for before completing. When the activity is configured to wait for a state, the VM is first Shut Down or Powered Off (as specified by Reboot Guest OS) and then it is started again. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the command waits, the command will not time out, it will wait indefinitely until the specified state is reached.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Restart-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be restarted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RebootGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be rebooted (soft restart) or if the VM power will be reset (hard restart). The VM must have VMware Tools installed and running in order for the activity to reboot (soft restart) the VM.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the activity will be waiting for before completing. When the activity is configured to wait for a state, the VM is first Shut Down or Powered Off (as specified by Reboot Guest OS) and then it is started again. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the command waits, the command will not time out, it will wait indefinitely until the specified state is reached.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be restarted. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RebootGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be rebooted (soft restart) or if the VM power will be reset (hard restart). The VM must have VMware Tools installed and running in order for the activity to reboot (soft restart) the VM.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the activity will be waiting for before completing. When the activity is configured to wait for a state, the VM is first Shut Down or Powered Off (as specified by Reboot Guest OS) and then it is started again. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the command waits, the command will not time out, it will wait indefinitely until the specified state is reached.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be restarted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the VM that was restarted.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Set-VsphereCustomAttribute</command:name> <maml:description> <maml:para>Sets a custom attribute from a VM or host.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsphereCustomAttribute</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets a custom attribute from a VM or host.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="ById" default="true"> <!--NAME: ById--> <!--TAG: DEFAULT--> <maml:name>Set-VsphereCustomAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VsphereObjectId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM or host for which custom attribute is to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributeType</maml:name> <maml:description> <maml:para>Specifies the custom attribute type. Accepted values are: Global - can be set for any object type. Host - can be set for hosts. VM - can be set for VMs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name for the custom attribute that is to be set. If an attribute with the specified name does not exist, by default the attribute is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value of the custom attribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DontCreate</maml:name> <maml:description> <maml:para>Specifies that the attribute should not be created if it doesn’t exist. In this case, the command will fail. By default, if an attribute does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Set-VsphereCustomAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM or host for which custom attribute is to be set. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttributeType</maml:name> <maml:description> <maml:para>Specifies the custom attribute type. Accepted values are: Global - can be set for any object type. Host - can be set for hosts. VM - can be set for VMs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name for the custom attribute that is to be set. If an attribute with the specified name does not exist, by default the attribute is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value of the custom attribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DontCreate</maml:name> <maml:description> <maml:para>Specifies that the attribute should not be created if it doesn’t exist. In this case, the command will fail. By default, if an attribute does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VsphereObjectId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM or host for which custom attribute is to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>AttributeType</maml:name> <maml:description> <maml:para>Specifies the custom attribute type. Accepted values are: Global - can be set for any object type. Host - can be set for hosts. VM - can be set for VMs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name for the custom attribute that is to be set. If an attribute with the specified name does not exist, by default the attribute is created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value of the custom attribute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DontCreate</maml:name> <maml:description> <maml:para>Specifies that the attribute should not be created if it doesn’t exist. In this case, the command will fail. By default, if an attribute does not exist, it will be created.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM or host for which custom attribute is to be set. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Attribute key for the custom attribute that was set.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Set-VsphereVm</command:name> <maml:description> <maml:para>Modifies the properties and/or devices of an existing VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modifies the properties and/or devices of an existing VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="HardDisk" default="true"> <!--NAME: HardDisk--> <!--TAG: DEFAULT--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DiskSizeMb</maml:name> <maml:description> <maml:para>Specifies the new disk size, in MB.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveDatastoreIso"> <!--NAME: CdDriveDatastoreIso--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the device should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>Specifies a new CD/DVD drive type when changing to a different drive type. Specifies the CD/DVD drive type of the drive that is to be modified when modifying properties of a drive. This parameter is only available when SetType is CD/DVD Drive. Accepted values are: Client Device Datastore ISO File Host Device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoFilePath</maml:name> <maml:description> <maml:para>Location of the datastore ISO file for the device, in the form [<datastore name>] <ISO file Path>. For Example: [DS-DEV-01] ISO/windows/ windows_10_x64.iso</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IsoDatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the ISO file is stored. The datastore must correspond to the datastore specified in the ISO File Path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveClientDevice"> <!--NAME: CdDriveClientDevice--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>Specifies a new CD/DVD drive type when changing to a different drive type. Specifies the CD/DVD drive type of the drive that is to be modified when modifying properties of a drive. This parameter is only available when SetType is CD/DVD Drive. Accepted values are: Client Device Datastore ISO File Host Device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CdDriveHostDevice"> <!--NAME: CdDriveHostDevice--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the device should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>Specifies a new CD/DVD drive type when changing to a different drive type. Specifies the CD/DVD drive type of the drive that is to be modified when modifying properties of a drive. This parameter is only available when SetType is CD/DVD Drive. Accepted values are: Client Device Datastore ISO File Host Device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostDevicePath</maml:name> <maml:description> <maml:para>Location of host device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CPU"> <!--NAME: CPU--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CoresPerSocket</maml:name> <maml:description> <maml:para>Number of CPU cores per socket for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TotalCores</maml:name> <maml:description> <maml:para>Total number of CPU cores for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Memory"> <!--NAME: Memory--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>Specifies the amount of memory, in MB, for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NetworkAdapter"> <!--NAME: NetworkAdapter--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the device should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the network to be assigned to the network adapter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="VmProperties"> <!--NAME: VmProperties--> <maml:name>Set-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GuestOsId</maml:name> <maml:description> <maml:para>Specifies a new Guest OS for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>Specifies a new name for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>SetType</maml:name> <maml:description> <maml:para>Specifies which part of the VM is to be modified. Accepted values are: CD/DVD Drive CPU Hard Disk Memory Network Adapter VM Properties</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">CD/DVD Drive</command:parameterValue> <command:parameterValue required="false" variableLength="false">CPU</command:parameterValue> <command:parameterValue required="false" variableLength="false">Hard Disk</command:parameterValue> <command:parameterValue required="false" variableLength="false">Memory</command:parameterValue> <command:parameterValue required="false" variableLength="false">Network Adapter</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Properties</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DeviceKey</maml:name> <maml:description> <maml:para>Specifies the device to be modified. When not specified, the first device found, if any, is modified.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DiskSizeMb</maml:name> <maml:description> <maml:para>Specifies the new disk size, in MB.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ConnectAtPowerOn</maml:name> <maml:description> <maml:para>Specifies if the device should be connected when the VM powers on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Nullable[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CdDriveType</maml:name> <maml:description> <maml:para>Specifies a new CD/DVD drive type when changing to a different drive type. Specifies the CD/DVD drive type of the drive that is to be modified when modifying properties of a drive. This parameter is only available when SetType is CD/DVD Drive. Accepted values are: Client Device Datastore ISO File Host Device</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Client Device</command:parameterValue> <command:parameterValue required="false" variableLength="false">Datastore ISO File</command:parameterValue> <command:parameterValue required="false" variableLength="false">Host Device</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IsoFilePath</maml:name> <maml:description> <maml:para>Location of the datastore ISO file for the device, in the form [<datastore name>] <ISO file Path>. For Example: [DS-DEV-01] ISO/windows/ windows_10_x64.iso</maml:para> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>IsoDatastoreId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datastore where the ISO file is stored. The datastore must correspond to the datastore specified in the ISO File Path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>HostDevicePath</maml:name> <maml:description> <maml:para>Location of host device.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>CoresPerSocket</maml:name> <maml:description> <maml:para>Number of CPU cores per socket for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TotalCores</maml:name> <maml:description> <maml:para>Total number of CPU cores for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>MemoryMb</maml:name> <maml:description> <maml:para>Specifies the amount of memory, in MB, for the modified VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>NetworkId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the network to be assigned to the network adapter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a new description for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>GuestOsId</maml:name> <maml:description> <maml:para>Specifies a new Guest OS for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmName</maml:name> <maml:description> <maml:para>Specifies a new name for the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the VM.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Start-VsphereVm</command:name> <maml:description> <maml:para>Starts a VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Starts a VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Start-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be started. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatacenterId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datacenter on which the VM should be started.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the command will be waiting for before completing. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideAutomationLevel</maml:name> <maml:description> <maml:para>Override the DRS automation level. Accepted values are: fullyAutomated - Specifies that VirtualCenter should automate both the migration of virtual machines and their placement with a host at power on. manual - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should not implement the recommendations automatically. partiallyAutomated - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should automatically implement only the placement at power on.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">fullyAutomated</command:parameterValue> <command:parameterValue required="false" variableLength="false">manual </command:parameterValue> <command:parameterValue required="false" variableLength="false">partiallyAutomated</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReserveResources</maml:name> <maml:description> <maml:para>Reserve resources for the powering-on VMs throughout the power-on session. When this option is set to true, the server will return at most one recommended host per manual VM, and the VM's reservations are held on the recommended host until the VM is actually powered on (either by applying the recommendation or by a power-on request on the VM), or until the recommendation is canceled, or until the recommendation expires. The expiration time is currently set to 10 minutes. This option does not have an effect on automatic VMs since their recommendations are executed immediately. This option is effective on DRS clusters only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the activity waits, the activity will not time out, it will wait indefinitely until the specified state is reached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Start-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be started.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DatacenterId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datacenter on which the VM should be started.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the command will be waiting for before completing. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OverrideAutomationLevel</maml:name> <maml:description> <maml:para>Override the DRS automation level. Accepted values are: fullyAutomated - Specifies that VirtualCenter should automate both the migration of virtual machines and their placement with a host at power on. manual - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should not implement the recommendations automatically. partiallyAutomated - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should automatically implement only the placement at power on.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">fullyAutomated</command:parameterValue> <command:parameterValue required="false" variableLength="false">manual </command:parameterValue> <command:parameterValue required="false" variableLength="false">partiallyAutomated</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReserveResources</maml:name> <maml:description> <maml:para>Reserve resources for the powering-on VMs throughout the power-on session. When this option is set to true, the server will return at most one recommended host per manual VM, and the VM's reservations are held on the recommended host until the VM is actually powered on (either by applying the recommendation or by a power-on request on the VM), or until the recommendation is canceled, or until the recommendation expires. The expiration time is currently set to 10 minutes. This option does not have an effect on automatic VMs since their recommendations are executed immediately. This option is effective on DRS clusters only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the activity waits, the activity will not time out, it will wait indefinitely until the specified state is reached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be started. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>DatacenterId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the datacenter on which the VM should be started.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>WaitForVmState</maml:name> <maml:description> <maml:para>Specifies a VM state that the command will be waiting for before completing. Accepted values are: VM Powered On – activity waits until the VM is in poweredOn state. VM Guest OS Running – activity waits until VM Guest operating system is in running state. VM Tools Running – activity waits until VMware Tools are in guestToolsRunning running state. Do Not Wait – activity does not wait.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">VM Powered On</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Guest OS Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">VM Tools Running</command:parameterValue> <command:parameterValue required="false" variableLength="false">Do Not Wait</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OverrideAutomationLevel</maml:name> <maml:description> <maml:para>Override the DRS automation level. Accepted values are: fullyAutomated - Specifies that VirtualCenter should automate both the migration of virtual machines and their placement with a host at power on. manual - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should not implement the recommendations automatically. partiallyAutomated - Specifies that VirtualCenter should generate recommendations for virtual machine migration and for placement with a host, but should automatically implement only the placement at power on.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">fullyAutomated</command:parameterValue> <command:parameterValue required="false" variableLength="false">manual </command:parameterValue> <command:parameterValue required="false" variableLength="false">partiallyAutomated</command:parameterValue> </command:parameterValueGroup> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ReserveResources</maml:name> <maml:description> <maml:para>Reserve resources for the powering-on VMs throughout the power-on session. When this option is set to true, the server will return at most one recommended host per manual VM, and the VM's reservations are held on the recommended host until the VM is actually powered on (either by applying the recommendation or by a power-on request on the VM), or until the recommendation is canceled, or until the recommendation expires. The expiration time is currently set to 10 minutes. This option does not have an effect on automatic VMs since their recommendations are executed immediately. This option is effective on DRS clusters only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when Wait For VM State is configured to wait for a VM state. If this parameter is not specified and Wait For VM State is configured so that the activity waits, the activity will not time out, it will wait indefinitely until the specified state is reached.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be started.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the VM that was started.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Stop-VsphereVm</command:name> <maml:description> <maml:para>Stops a running VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Stops a running VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Stop-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be stopped. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShutdownGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be shut down (soft stop) or if the VM will be powered off (hard stop). The VM must have VMware Tools installed and running in order for the activity to shut down (soft stop) the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmPoweredOff</maml:name> <maml:description> <maml:para>Specifies whether the command will be waiting for the VM to reach the poweredOff state before completing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when configured to wait. If this parameter is not specified and Wait For VM Powered Off is configured so that the command waits, the command will not time out, it will wait indefinitely until the powered off.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Stop-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be stopped.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ShutdownGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be shut down (soft stop) or if the VM will be powered off (hard stop). The VM must have VMware Tools installed and running in order for the activity to shut down (soft stop) the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WaitForVmPoweredOff</maml:name> <maml:description> <maml:para>Specifies whether the command will be waiting for the VM to reach the poweredOff state before completing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when configured to wait. If this parameter is not specified and Wait For VM Powered Off is configured so that the command waits, the command will not time out, it will wait indefinitely until the powered off.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be stopped. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ShutdownGuestOs</maml:name> <maml:description> <maml:para>Specifies whether the VM Guest OS will be shut down (soft stop) or if the VM will be powered off (hard stop). The VM must have VMware Tools installed and running in order for the activity to shut down (soft stop) the VM.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>WaitForVmPoweredOff</maml:name> <maml:description> <maml:para>Specifies whether the command will be waiting for the VM to reach the poweredOff state before completing.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>TimeoutSeconds</maml:name> <maml:description> <maml:para>Specifies the number of seconds before the command times out, when configured to wait. If this parameter is not specified and Wait For VM Powered Off is configured so that the command waits, the command will not time out, it will wait indefinitely until the powered off.</maml:para> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be stopped.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the VM that was stopped.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!-- Command--> <command:details> <command:name>Suspend-VsphereVm</command:name> <maml:description> <maml:para>Suspends a running VM.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>VsphereVm</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Suspends a running VM.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Suspend-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be suspended. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Suspend-VsphereVm</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be suspended.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Object representing the VM that is to be suspended. Use Get-VsphereObject to retrieve input object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the vCenter server. For example: @{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license key>;SkipCertificateValidation=$false}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>VmId</maml:name> <maml:description> <maml:para>ID (managed object reference) of the VM that is to be suspended.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>ID (managed object reference) of the VM that was suspended.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!-- Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.41--> </helpItems> |