VMware.VumAutomation.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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"> <command:details> <command:name>Attach-Baseline</command:name> <maml:description> <maml:para>Attaches baselines to the specified inventory object.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Attach</command:verb> <command:noun>Baseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Attaches baselines to the specified Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects. Attaching a baseline to a container object such as a folder or datacenter transitively attaches the baseline to all objects in the container.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>none</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- EXAMPLE 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Attach-Baseline -Entity $vm -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Attaches the baselines in the $baseline variable to the virtual machines objects saved in the $vm variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- EXAMPLE 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VM | Attach-Baseline -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Attaches the baselines saved in the $baseline variable to the virtual machine named VM.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- EXAMPLE 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Name *2009 | Attach-Baseline -Entity $vm</dev:code> <dev:remarks> <maml:para>Attaches the baselines with names that end with 2009 to the virtual machine objects saved in the $vm variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Detach-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Detach-Baseline</command:name> <maml:description> <maml:para>Detaches baselines from the specified inventory objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Detach</command:verb> <command:noun>Baseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Detaches baselines from the specified inventory objects. To detach inherited baselines, you must detach them from the parent inventory object.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>none</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- EXAMPLE 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VM | Detach-Baseline -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Detaches the baselines in the $baseline variable from the VM virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Detach-Baseline -Entity VM -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Detaches the baselines in the $baseline variable from the VM virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Attach-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Download-Patch</command:name> <maml:description> <maml:para>Downloads new patches into the Update Manager repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Download</command:verb> <command:noun>Patch</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Downloads new patches into the Update Manager patch repository from the enabled patch download sources.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.Patch[] or VMware.VimAutomation.Types.Task</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Download-Patch</dev:code> <dev:remarks> <maml:para>Downloads all new patches from the preconfigured metadata download URL address (www.vmware.com).</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$task = Download-Patch -RunAsync</dev:code> <dev:remarks> <maml:para>Initializes download of new patches and returns a Task object. To manage the Task object, use the vSphere PowerCLI cmdlets Get-Task, Wait-Task, and Stop-Task.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Stage-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Remediate-Inventory</command:name> <maml:description> <maml:para>Remediates an inventory object against the specified baselines.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remediate</command:verb> <command:noun>Inventory</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Remediates an inventory object against the specified baselines. If RunAsync is set, returns a task that can be used to monitor the remediation progress. You can remediate Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Types.InventoryItem object</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task[] or null</maml:name> <maml:uri /> <maml:description> <maml:para>If RunAsync is set, the return value is a Task object representing the remediation task on the vSphere server. If RunAsync is not set, no value is returned.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- EXAMPLE 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remediate-Inventory -Baseline $baseline -Entity $vmhost -RunAsync -Confirm $false</dev:code> <dev:remarks> <maml:para>Remediates a host in asynchronous mode.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remediate-Inventory -Baseline $vmHardwareUpgradeBaseline -Entity $vm -GuestCreateSnapshot:$true</dev:code> <dev:remarks> <maml:para>Upgrades a virtual machine with the latest virtual hardware. If the upgrade fails, the command creates a snapshot of the target virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remediate-Inventory -Baseline $baseline -Entity $cluster -ClusterDisableDistributedPowerManagement:$true -ClusterDisableFaultTolerance:$true -ClusterDisableHighAvailability:$true</dev:code> <dev:remarks> <maml:para>Remediates a cluster with DPM, HA, and FT that are enabled and need to be disabled during the remediation process.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remediate-Inventory -Baseline $baseline -Entity $cluster -ClusterEnableParallelRemediation:$true</dev:code> <dev:remarks> <maml:para>Remediates a cluster in parallel mode. All hosts in the cluster are remediated simultaneously and that saves time.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remediate-Inventory -Baseline $baseline -Entity $vmhost -HostIgnoreThirdPartyDrivers:$true</dev:code> <dev:remarks> <maml:para>Remediates a host with preinstalled third party drivers, which prevent host from upgrade.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Scan-Inventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Scan-Inventory</command:name> <maml:description> <maml:para>Scans inventory objects for baselines attached to them.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Scan</command:verb> <command:noun>Inventory</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Scans inventory objects for baselines attached to them. The following object types are supported - Template, VirtualMachine, VMHost, Cluster, Datacenter, and Folder. If the inventory objects are of different types, the cmdlet starts a separate task for each object.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task[] or null</maml:name> <maml:uri /> <maml:description> <maml:para>If RunAsync is set, the return value is a Task object that represents the scanning task on the vSphere server. If RunAsync is not set, no value is returned.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- EXAMPLE 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Scan-Inventory -Entity VM -RunAsync</dev:code> <dev:remarks> <maml:para>Scans the VM virtual machine. Since the -RunAsync parameter is set, the cmdlet runs asynchronously and a Task object is returned.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- EXAMPLE 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name VM | Scan-Inventory</dev:code> <dev:remarks> <maml:para>Scans the VM virtual machine for baselines attached to it.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name MyHost | Scan-Inventory -UpdateType HostPatch</dev:code> <dev:remarks> <maml:para>Scans virtual machine host for patches running asynchronously.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name MyVM | Scan-Inventory -UpdateType VmHardwareUpgrade, VmToolsUpgrade</dev:code> <dev:remarks> <maml:para>Scan the MyVM virtual machine for upgrades.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remediate-Inventory</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Stage-Patch</command:name> <maml:description> <maml:para>Initializes staging of patches.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Stage</command:verb> <command:noun>Patch</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>Initializes staging of patches. Staging allows you to download patches from the Update Manager server to the ESX/ESXi hosts, without applying the patches immediately. This functionality is supported only for VMHost, Cluster, and Datacenter objects.</maml:para> </maml:description> <command:syntax> </command:syntax> <command:parameters> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Stage-Patch -Entity Host</dev:code> <dev:remarks> <maml:para>Stages all patches included in baselines attached to the entity named Host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Download-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Add-EntityBaseline</command:name> <maml:description> <maml:para>This cmdlet attaches baselines to the specified inventory object.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Add</command:verb> <command:noun>EntityBaseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet attaches baselines to the specified Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects. Attaching a baseline to a container object such as a folder or data center transitively attaches the baseline to all objects in the container.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-EntityBaseline</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and vApp objects to which you want to attach the baselines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to attach to the specified objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and vApp objects to which you want to attach the baselines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to attach to the specified objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Add-EntityBaseline -Entity $vm -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Attaches the baselines in the $baseline variable to the virtual machines objects saved in the $vm variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VM | Add-EntityBaseline -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Attaches the baselines saved in the $baseline variable to the virtual machine named VM.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Name *2009 | Add-EntityBaseline -Entity $vm</dev:code> <dev:remarks> <maml:para>Attaches the baselines with names that end with 2009 to the virtual machine objects saved in the $vm variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Add-EntityBaseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntityBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Copy-Patch</command:name> <maml:description> <maml:para>This cmdlet initializes staging of patches.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Copy</command:verb> <command:noun>Patch</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet initializes staging of patches. Staging allows you to download patches from the Update Manager server to the ESXi hosts, without applying the patches immediately. This functionality is supported only for VMHost, Cluster, and Datacenter objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-Patch</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies VMHost, Cluster, and Datacenter objects for which you want to stage patches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies patch baselines you want to stage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchBaseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the patches you want to exclude from staging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies VMHost, Cluster, and Datacenter objects for which you want to stage patches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies patch baselines you want to stage.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchBaseline[]</command:parameterValue> <dev:type> <maml:name>PatchBaseline[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the patches you want to exclude from staging.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</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>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> <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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Copy-Patch -Entity Host</dev:code> <dev:remarks> <maml:para>Stages all patches included in baselines attached to the entity named Host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Copy-Patch.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Sync-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Get-Baseline</command:name> <maml:description> <maml:para>This cmdlet retrieves baselines.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Baseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves the baselines specified by the provided cmdlet parameters. There are two default dynamic patch baselines (Critical Host Patches (Predefined), and Non-Critical Host Patches(Predefined)) and three upgrade baselines (VMware Tools Upgrade to Match Host(Predefined), VM Hardware Upgrade to Match Host (Predefined),and VA Upgrade to Latest (Predefined)). You cannot edit or delete default baselines.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Baseline</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the baselines you want to retrieve. The valid values are VM, Host, and VA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >BaselineTargetType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BaselineType</maml:name> <maml:description> <maml:para>Specifies the type of the baselines you want to retrieve. The valid values are Patch (patch baselines) and Upgrade (upgrade baselines).</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >BaselineType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BaselineContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the baselines you want to retrieve. The valid values are Dynamic, Static, and Both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >BaselineContentType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names of the baselines you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the baselines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects to which the baselines you want to retrieve are attached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Inherit</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines inherited by the parent inventory entities.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Recurse</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines attached to the child inventory entities.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the baselines you want to retrieve. The valid values are VM, Host, and VA.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BaselineTargetType[]</command:parameterValue> <dev:type> <maml:name>BaselineTargetType[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaselineType</maml:name> <maml:description> <maml:para>Specifies the type of the baselines you want to retrieve. The valid values are Patch (patch baselines) and Upgrade (upgrade baselines).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BaselineType[]</command:parameterValue> <dev:type> <maml:name>BaselineType[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaselineContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the baselines you want to retrieve. The valid values are Dynamic, Static, and Both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BaselineContentType[]</command:parameterValue> <dev:type> <maml:name>BaselineContentType[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names of the baselines you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the baselines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects to which the baselines you want to retrieve are attached.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</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>Inherit</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines inherited by the parent inventory entities.</maml:para> </maml:description> <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>Recurse</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines attached to the child inventory entities.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.Baseline[]</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Name *critical*</dev:code> <dev:remarks> <maml:para>Retrieves all baselines that contain "critical" in their names.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -TargetType Host -BaselineType Upgrade</dev:code> <dev:remarks> <maml:para>Retrieves the available host upgrade baselines on the default server.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Entity VM -Inherit</dev:code> <dev:remarks> <maml:para>Retrieves the baselines that are attached directly to the VM virtual machine or are inherited by its parent objects.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -TargetType VM -BaselineType Upgrade</dev:code> <dev:remarks> <maml:para>Retrieves the default baselines (VMware Tools Upgrade to Match Host and VM Hardware Upgrade to Match Host).</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Get-Baseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntiryBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntityBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Get-Compliance</command:name> <maml:description> <maml:para>This cmdlet retrieves baseline compliance data for the specified object.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Compliance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves baseline compliance data for the specified object of type Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp. The cmdlet returns information about the compliance of the specified entity with the baselines that are attached to it. If the entity is a container, the cmdlet returns compliance data for all objects in the container.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Compliance</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies a Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, or VApp object for which you want to retrieve the compliance status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >InventoryItem</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the status of the compliance you want to retrieve. The valid values are Compliant, NotCompliant, Unknown, and Incompatible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >ComplianceStatus</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baseline for which you want to retrieve the compliance status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Detailed</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve detailed information about the compliance. For patch baselines, the patches with different statuses are listed. For VMTools upgrade baselines, the detailed information contains the VMware Tools status. For VM Hardware upgrade baseline, the recommended VM Hardware version and the current VM Hardware version are displayed.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies a Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, or VApp object for which you want to retrieve the compliance status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventoryItem</command:parameterValue> <dev:type> <maml:name>InventoryItem</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>ComplianceStatus</maml:name> <maml:description> <maml:para>Specifies the status of the compliance you want to retrieve. The valid values are Compliant, NotCompliant, Unknown, and Incompatible.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ComplianceStatus</command:parameterValue> <dev:type> <maml:name>ComplianceStatus</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baseline for which you want to retrieve the compliance status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</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>Detailed</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve detailed information about the compliance. For patch baselines, the patches with different statuses are listed. For VMTools upgrade baselines, the detailed information contains the VMware Tools status. For VM Hardware upgrade baseline, the recommended VM Hardware version and the current VM Hardware version are displayed.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.BaselineCompliance</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Compliance -Entity VM</dev:code> <dev:remarks> <maml:para>Retrieves a list of all baselines attached to the VM virtual machine and shows their compliance status and the number of the Compliant, NotCompliant, Unknown and NotApplicable patches.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Compliance -Entity $datacenter</dev:code> <dev:remarks> <maml:para>Retrieves a list of all baselines attached to the datacenters in $datacenter and shows their compliance status and the number of the Compliant, NotCompliant and Unknown patches.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VM | Get-Compliance</dev:code> <dev:remarks> <maml:para>Retrieves a list of all baselines attached to the VM virtual machine and shows their compliance status and the number of the Compliant, NotCompliant, Unknown and NotApplicable patches.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-DataCenter DataCenter | Get-VM "VM*" | Get-Compliance</dev:code> <dev:remarks> <maml:para>Retrieves the compliance status for all virtual machines in the Datacenter datacenter whose names start with "VM".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$statuses = Get-Compliance -Entity VM -ComplianceStatus Unknown if (([array]($statuses)).Count -gt 0) {Scan-Inventory -Entity VM}</dev:code> <dev:remarks> <maml:para>Retrieves the compliance status of the baselines attached to the VM virtual machine. If there is at least one baseline with Unknown compliance status, a scan is started.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Get-Compliance.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Compliance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Get-Patch</command:name> <maml:description> <maml:para>This cmdlet retrieves the available patches.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Patch</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves all available patches or those specified by the provided cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Patch</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>Specifies phrases that are contained in the Name, Description, Id, and Vendor properties of the patches you want to retrieve. Use commas to separate multiple phrases.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patches you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies baselines to which the patches you want to retrieve belong.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to retrieve. The valid values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchSeverity[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Product</maml:name> <maml:description> <maml:para>Specifies the names of software products for which you want to retrieve patches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>After</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Before</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patches you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchTargetType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>Specifies the vendors of the patches you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InstallationImpact</maml:name> <maml:description> <maml:para>Specifies the installation impact of the patches you want to retrieve. The valid values are HostdRestart, Reboot, MaintenanceMode, MaintenanceModeHostdRestart, MaintenanceModeInstall, MaintenanceModeUpdate, and FaultToleranceCompatibiliy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchInstallationImpact[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BundleType</maml:name> <maml:description> <maml:para>Specifies the bundle type of the patches you want to retrieve. The valid values are Patch, Rollup, Update, Extension, and Upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchBundleType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the categories of the patches you want to retrieve. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >UpdateCategory[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Patch</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>Specifies phrases that are contained in the Name, Description, Id, and Vendor properties of the patches you want to retrieve. Use commas to separate multiple phrases.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patches you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to retrieve. The valid values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchSeverity[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Product</maml:name> <maml:description> <maml:para>Specifies the names of software products for which you want to retrieve patches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>After</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Before</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patches you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchTargetType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Vendor</maml:name> <maml:description> <maml:para>Specifies the vendors of the patches you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>InstallationImpact</maml:name> <maml:description> <maml:para>Specifies the installation impact of the patches you want to retrieve. The valid values are HostdRestart, Reboot, MaintenanceMode, MaintenanceModeHostdRestart, MaintenanceModeInstall, MaintenanceModeUpdate, and FaultToleranceCompatibiliy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchInstallationImpact[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BundleType</maml:name> <maml:description> <maml:para>Specifies the bundle type of the patches you want to retrieve. The valid values are Patch, Rollup, Update, Extension, and Upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchBundleType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the categories of the patches you want to retrieve. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >UpdateCategory[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>SearchPhrase</maml:name> <maml:description> <maml:para>Specifies phrases that are contained in the Name, Description, Id, and Vendor properties of the patches you want to retrieve. Use commas to separate multiple phrases.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patches you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies baselines to which the patches you want to retrieve belong.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Severity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to retrieve. The valid values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchSeverity[]</command:parameterValue> <dev:type> <maml:name>PatchSeverity[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Product</maml:name> <maml:description> <maml:para>Specifies the names of software products for which you want to retrieve patches.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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>After</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>Before</maml:name> <maml:description> <maml:para>Indicates that you want to retrieve only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patches you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchTargetType[]</command:parameterValue> <dev:type> <maml:name>PatchTargetType[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Vendor</maml:name> <maml:description> <maml:para>Specifies the vendors of the patches you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>InstallationImpact</maml:name> <maml:description> <maml:para>Specifies the installation impact of the patches you want to retrieve. The valid values are HostdRestart, Reboot, MaintenanceMode, MaintenanceModeHostdRestart, MaintenanceModeInstall, MaintenanceModeUpdate, and FaultToleranceCompatibiliy.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchInstallationImpact[]</command:parameterValue> <dev:type> <maml:name>PatchInstallationImpact[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BundleType</maml:name> <maml:description> <maml:para>Specifies the bundle type of the patches you want to retrieve. The valid values are Patch, Rollup, Update, Extension, and Upgrade.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchBundleType[]</command:parameterValue> <dev:type> <maml:name>PatchBundleType[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the categories of the patches you want to retrieve. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpdateCategory[]</command:parameterValue> <dev:type> <maml:name>UpdateCategory[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.Patch[]</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Patch -SearchPhrase "ESX40-MMODE" -Severity critical -Product "esx 4.0.*" -After 10.11.2007</dev:code> <dev:remarks> <maml:para>Retrieves the critical esx 4.0.* patches released after 10.11.2007, that contain "ESX40-MMODE" in their properties.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Id 2| Get-Patch</dev:code> <dev:remarks> <maml:para>Retrieves all Patch objects included in the baseline with ID 2.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Patch -Severity critical -InstallationImpact Reboot</dev:code> <dev:remarks> <maml:para>Retrieves the critical host patches whose installation reboots the host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Get-Patch.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Sync-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Get-PatchBaseline</command:name> <maml:description> <maml:para>This cmdlet retrieves patch baselines.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PatchBaseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet retrieves all patch baselines or those specified by the provided cmdlet parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PatchBaseline</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patch baselines you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >BaselineTargetType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Patch</maml:name> <maml:description> <maml:para>Specifies a patch that belongs to the patch baseline you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Patch</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BaselineContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the patch baselines you want to retrieve. The valid values are Both, Dynamic, and Static.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >BaselineContentType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Extension</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve only Extension patch baselines.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names of the patch baselines you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patch baselines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PatchBaseline</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "2" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patch baselines you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >BaselineTargetType</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>BaselineContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the patch baselines you want to retrieve. The valid values are Both, Dynamic, and Static.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >BaselineContentType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Extension</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve only Extension patch baselines.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names of the patch baselines you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patch baselines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Int32[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects to which the baselines you want to retrieve are attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Inherit</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines inherited by the parent inventory entities.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Recurse</maml:name> <maml:description> <maml:para>If set, retrieves the patch baselines attached to the child entities. This parameter can be specified only if the -Entity parameter is set, too.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the target type of the patch baselines you want to retrieve. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineTargetType</command:parameterValue> <dev:type> <maml:name>BaselineTargetType</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Patch</maml:name> <maml:description> <maml:para>Specifies a patch that belongs to the patch baseline you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Patch</command:parameterValue> <dev:type> <maml:name>Patch</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BaselineContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the patch baselines you want to retrieve. The valid values are Both, Dynamic, and Static.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">BaselineContentType[]</command:parameterValue> <dev:type> <maml:name>BaselineContentType[]</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>Extension</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve only Extension patch baselines.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the names of the patch baselines you want to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the IDs of the patch baselines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects to which the baselines you want to retrieve are attached to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</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>Inherit</maml:name> <maml:description> <maml:para>Specifies that you want to retrieve the baselines inherited by the parent inventory entities.</maml:para> </maml:description> <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>Recurse</maml:name> <maml:description> <maml:para>If set, retrieves the patch baselines attached to the child entities. This parameter can be specified only if the -Entity parameter is set, too.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.PatchBaseline[]</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VMHost | Get-PatchBaseline</dev:code> <dev:remarks> <maml:para>Retrieves all patch baselines assigned to the VMHost host.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-PatchBaseline -Entity VMHost -Inherit -Recurse</dev:code> <dev:remarks> <maml:para>Retrieves all patch baselines assigned to the VMHost host and its parent inventory object.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$patch = Get-Patch -Id 1 Get-PatchBaseline -Patch $patch</dev:code> <dev:remarks> <maml:para>Retrieves the patch baselines that contain the patch with ID 1.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-PatchBaseline -Id 1,2,3</dev:code> <dev:remarks> <maml:para>Retrieves the patch baselines with IDs 1, 2, and 3.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Get-PatchBaseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>New-PatchBaseline</command:name> <maml:description> <maml:para>This cmdlet creates a new patch baseline.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>New</command:verb> <command:noun>PatchBaseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet creates a new patch baseline. Patch baselines can be applied to either hosts or virtual machines. Depending on the patch criteria you select, patch baselines can be either dynamic or static (fixed). You can specify explicitly the patches you want to include in the baseline through the IncludePatch parameter. Also, you can use the SearchPath* parameters to filter the patches you want to include by their properties, product, vendor, severity, and release date. Note that patches that have been excluded through the ExcludePatch parameter will not be included even if they correspond to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PatchBaseline</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the object target type of the new patch baseline. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >BaselineTargetType</command:parameterValue> </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 description of the patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Static</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is static. Static (fixed) baselines consist of a specific set of patches that do not change as patch availability changes. Do not use this parameter if the -Dynamic parameter is set.</maml:para> </maml:description> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncludePatch</maml:name> <maml:description> <maml:para>For static baselines, specifies the patches you want to include in the baseline. These patches will be added in the CurrentPatches property of the returned baseline object. For dynamic baselines, specifies patches you want to add to the baseline in addition to the patches specified by the search criteria parameters. The patches supplied through the IncludePatch parameter are stored in the InclPatches property of the baseline. These patches are also added in the baseline's CurrentPatches property that contains the patches specified by the search criteria parameters and the patches provided by the IncludePatch parameter. Patches specified by the ExcludePatch parameter are not included in the CurrentPatches property of a baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Extension</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is of Extension type. Do not use this parameter if the -Dynamic parameter is set. Extension baselines can be only static (fixed) and are used to perform installation of extensions. An extension is any additional software that can be installed on the host or patched if the additional software already exists on the host.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-PatchBaseline</maml:name> <command:parameter required = "false" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >VIServer</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>TargetType</maml:name> <maml:description> <maml:para>Specifies the object target type of the new patch baseline. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >BaselineTargetType</command:parameterValue> </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 description of the patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Dynamic</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is dynamic. Dynamic baselines consist of a set of patches that meet certain criteria. The contents of a dynamic baseline varies as the available patches change. You can also exclude or add specific patches. Do not use this parameter if the -Static parameter is set.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncludePatch</maml:name> <maml:description> <maml:para>For static baselines, specifies the patches you want to include in the baseline. These patches will be added in the CurrentPatches property of the returned baseline object. For dynamic baselines, specifies patches you want to add to the baseline in addition to the patches specified by the search criteria parameters. The patches supplied through the IncludePatch parameter are stored in the InclPatches property of the baseline. These patches are also added in the baseline's CurrentPatches property that contains the patches specified by the search criteria parameters and the patches provided by the IncludePatch parameter. Patches specified by the ExcludePatch parameter are not included in the CurrentPatches property of a baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the software patches you want to exclude from the dynamic baseline. Once excluded, a patch cannot be included even if it corresponds to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchStartDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchEndDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SearchPatchProduct</maml:name> <maml:description> <maml:para>Specifies software products of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchSeverity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to include in the new baseline. The available values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchSeverity[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SearchPatchVendor</maml:name> <maml:description> <maml:para>Specifies the software vendor of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SearchPatchCategory</maml:name> <maml:description> <maml:para>Specifies the categories of the patches you want to include in the new baseline. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >UpdateCategory[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VIServer</command:parameterValue> <dev:type> <maml:name>VIServer</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a name for the new patch baseline.</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>TargetType</maml:name> <maml:description> <maml:para>Specifies the object target type of the new patch baseline. The valid value is Host. This parameter is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BaselineTargetType</command:parameterValue> <dev:type> <maml:name>BaselineTargetType</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 description of the patch baseline.</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>Static</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is static. Static (fixed) baselines consist of a specific set of patches that do not change as patch availability changes. Do not use this parameter if the -Dynamic parameter is set.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludePatch</maml:name> <maml:description> <maml:para>For static baselines, specifies the patches you want to include in the baseline. These patches will be added in the CurrentPatches property of the returned baseline object. For dynamic baselines, specifies patches you want to add to the baseline in addition to the patches specified by the search criteria parameters. The patches supplied through the IncludePatch parameter are stored in the InclPatches property of the baseline. These patches are also added in the baseline's CurrentPatches property that contains the patches specified by the search criteria parameters and the patches provided by the IncludePatch parameter. Patches specified by the ExcludePatch parameter are not included in the CurrentPatches property of a baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</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>Extension</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is of Extension type. Do not use this parameter if the -Dynamic parameter is set. Extension baselines can be only static (fixed) and are used to perform installation of extensions. An extension is any additional software that can be installed on the host or patched if the additional software already exists on the host.</maml:para> </maml:description> <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>Dynamic</maml:name> <maml:description> <maml:para>Specifies if the new patch baseline is dynamic. Dynamic baselines consist of a set of patches that meet certain criteria. The contents of a dynamic baseline varies as the available patches change. You can also exclude or add specific patches. Do not use this parameter if the -Static parameter is set.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the software patches you want to exclude from the dynamic baseline. Once excluded, a patch cannot be included even if it corresponds to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</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>SearchPatchStartDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>SearchPatchEndDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SearchPatchProduct</maml:name> <maml:description> <maml:para>Specifies software products of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchPatchSeverity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to include in the new baseline. The available values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchSeverity[]</command:parameterValue> <dev:type> <maml:name>PatchSeverity[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SearchPatchVendor</maml:name> <maml:description> <maml:para>Specifies the software vendor of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SearchPatchCategory</maml:name> <maml:description> <maml:para>Specifies the categories of the patches you want to include in the new baseline. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpdateCategory[]</command:parameterValue> <dev:type> <maml:name>UpdateCategory[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.PatchBaseline</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$patch = Get-Patch -SearchPhrase "nexus" -Severity critical -Product "embeddedESX 4.0.0" -After 10.11.2009 New-PatchBaseline -Name Baseline -IncludePatch $patch -TargetType Host</dev:code> <dev:remarks> <maml:para>Creates a new patch baseline named "Baseline" that includes patches with the specified parameters.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$patches = Get-Patch -SearchPhrase "ESX40-MMODE" New-PatchBaseline -Name Baseline -Description "This is my first baseline" -Static -IncludePatch $patches -TargetType Host</dev:code> <dev:remarks> <maml:para>Creates a static baseline for host patches, which contain the word "ESX40-MMODE" in their properties.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$patches = Get-Patch -SearchPhrase "ESX40-MMODE" -Severity critical -Product "esx 4.0.*" -After 10.11.2007 New-PatchBaseline -Name Baseline -Description "Contains all esx 4.0 critical patches after 10.06.2007" -Static -IncludePatch $patches -TargetType Host</dev:code> <dev:remarks> <maml:para>Creates a static baseline for critical host patches, that have "ESX40-MMODE" in their names, and product name starting with "esx 4.0."</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>New-PatchBaseline -Dynamic -Name Baseline -TargetType Host -SearchPatchVendor *VMware*</dev:code> <dev:remarks> <maml:para>Creates a dynamic patch baseline containing host patches from vendors whose names contains "VMware".</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/New-PatchBaseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Remove-Baseline</command:name> <maml:description> <maml:para>This cmdlet removes baselines.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>Baseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet deletes the specified baselines from their servers. Before the removal, the baselines are detached from all entities they have been attached to.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Baseline</maml:name> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Baseline -Name *2008* | Remove-Baseline</dev:code> <dev:remarks> <maml:para>Removes all baselines that contain 2008 in their names.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-Baseline -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Removes all baselines stored in the $baseline variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Remove-Baseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntityBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-EntityBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Remove-EntityBaseline</command:name> <maml:description> <maml:para>This cmdlet detaches baselines from the specified inventory objects.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>EntityBaseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet detaches baselines from the specified inventory objects. To detach inherited baselines, you must detach them from the parent inventory object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-EntityBaseline</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and vApp objects from which you want to detach the baselines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to detach from the specified objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="1"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and vApp objects from which you want to detach the baselines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baselines you want to detach from the specified objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-VM -Name VM | Remove-EntityBaseline -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Detaches the baselines in the $baseline variable from the VM virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Remove-EntityBaseline -Entity VM -Baseline $baseline</dev:code> <dev:remarks> <maml:para>Detaches the baselines in the $baseline variable from the VM virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Remove-EntityBaseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-EntityBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-Baseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Set-PatchBaseline</command:name> <maml:description> <maml:para>This cmdlet modifies the properties of a patch baseline.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Set</command:verb> <command:noun>PatchBaseline</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet modifies the properties of a patch baseline. You can specify explicitly the patches you want to include in the baseline through the IncludePatch parameter. Also, you can use the SearchPatch* parameters to filter the patches you want to include by their properties, product, vendor, severity, and release date. Note that patches that have been excluded through the ExcludePatch parameter will not be included even if they correspond to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PatchBaseline</maml:name> <command:parameter required = "true" variableLength = "false" globbing = "false" pipelineInput = "true (ByValue)" position = "1" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the patch baseline you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >PatchBaseline</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </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 description of the patch baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>IncludePatch</maml:name> <maml:description> <maml:para>For static baselines, specifies the patches you want to include in the baseline. These patches will be added in the CurrentPatches property of the returned baseline object. For dynamic baselines, specifies patches you want to add to the baseline in addition to the patches specified by the search criteria parameters. The patches supplied through the IncludePatch parameter are stored in the InclPatches property of the baseline. These patches are also added in the baseline's CurrentPatches property that contains the patches specified by the search criteria parameters and the patches provided by the IncludePatch parameter. Patches specified by the ExcludePatch parameter are not included in the CurrentPatches property of a baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the software patches you want to exclude from the dynamic baseline. Once excluded, a patch cannot be included even if it corresponds to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchStartDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchEndDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SearchPatchProduct</maml:name> <maml:description> <maml:para>Specifies software products of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchSeverity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to include in the new baseline. The available values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >PatchSeverity[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>SearchPatchVendor</maml:name> <maml:description> <maml:para>Specifies the software vendor of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >String[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>SearchPatchCategory</maml:name> <maml:description> <maml:para>Specifies the category of the patches you want to include in the new baseline. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >UpdateCategory[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the patch baseline you want to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PatchBaseline</command:parameterValue> <dev:type> <maml:name>PatchBaseline</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>Name</maml:name> <maml:description> <maml:para>Specifies a new name for the patch baseline.</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 description of the patch baseline.</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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludePatch</maml:name> <maml:description> <maml:para>For static baselines, specifies the patches you want to include in the baseline. These patches will be added in the CurrentPatches property of the returned baseline object. For dynamic baselines, specifies patches you want to add to the baseline in addition to the patches specified by the search criteria parameters. The patches supplied through the IncludePatch parameter are stored in the InclPatches property of the baseline. These patches are also added in the baseline's CurrentPatches property that contains the patches specified by the search criteria parameters and the patches provided by the IncludePatch parameter. Patches specified by the ExcludePatch parameter are not included in the CurrentPatches property of a baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the software patches you want to exclude from the dynamic baseline. Once excluded, a patch cannot be included even if it corresponds to the filter defined by the SearchPatch* parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</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>SearchPatchStartDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released after the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</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>SearchPatchEndDate</maml:name> <maml:description> <maml:para>Indicates that you want to include only patches released before the date specified by this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SearchPatchProduct</maml:name> <maml:description> <maml:para>Specifies software products of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchPatchSeverity</maml:name> <maml:description> <maml:para>Specifies the severity of the patches you want to include in the new baseline. The available values are NotApplicable, Low, Moderate, Important, Critical, HostGeneral, and HostSecurity.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PatchSeverity[]</command:parameterValue> <dev:type> <maml:name>PatchSeverity[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>SearchPatchVendor</maml:name> <maml:description> <maml:para>Specifies the software vendor of the patches you want to include in the new baseline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">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="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SearchPatchCategory</maml:name> <maml:description> <maml:para>Specifies the category of the patches you want to include in the new baseline. The valid values are SecurityFix, BugFix, Enhancement, and Other.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpdateCategory[]</command:parameterValue> <dev:type> <maml:name>UpdateCategory[]</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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.PatchBaseline</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-PatchBaseline -Name "Test Baseline" | Set-PatchBaseline -Name "Old Test Baseline"</dev:code> <dev:remarks> <maml:para>Retrieves a baseline and and changes its name.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-PatchBaseline -Name Baseline | Set-PatchBaseline SearchPatchEndDate 1.1.2002"</dev:code> <dev:remarks> <maml:para>Retrieves a baseline and sets its SearchPatchEndDate property.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$patches = Get-Patch -Id 1,2,3 $baseline = Get-PatchBaseline -Name Baseline Set-PatchBaseline -Baseline $baseline -IncludePatch $patches</dev:code> <dev:remarks> <maml:para>Updates the patches included in the baseline.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$baseline = Get-PatchBaseline -Name Baseline Set-PatchBaseline -Baseline $baseline -SearchPatchVendor *micro*"</dev:code> <dev:remarks> <maml:para>Sets the baseline SearchPatchVendor property using wildcards.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Set-PatchBaseline.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PatchBaseline</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Sync-Patch</command:name> <maml:description> <maml:para>This cmdlet downloads new patches into the Update Manager repository.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>Patch</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet downloads new patches into the Update Manager patch repository from the enabled patch download sources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Sync-Patch</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</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>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VumAutomation.Types.Patch[] or VMware.VimAutomation.Types.Task</maml:name> <maml:uri /> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Sync-Patch</dev:code> <dev:remarks> <maml:para>Downloads all new patches from the preconfigured metadata download URL address (www.vmware.com).</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>$task = Sync-Patch -RunAsync</dev:code> <dev:remarks> <maml:para>Initializes download of new patches and returns a Task object. To manage the Task object, use the vSphere PowerCLI cmdlets Get-Task, Wait-Task, and Stop-Task.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Sync-Patch.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Patch</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Test-Compliance</command:name> <maml:description> <maml:para>This cmdlet scans inventory objects for baselines attached to them.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Test</command:verb> <command:noun>Compliance</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet scans inventory objects for baselines attached to them. The following object types are supported - Template, VirtualMachine, VMHost, Cluster, Datacenter, and Folder. If the inventory objects are of different types, the cmdlet starts a separate task for each object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-Compliance</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "2" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects you want to scan for baselines attached to them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >InventoryItem[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "false" position = "1" > <maml:name>UpdateType</maml:name> <maml:description> <maml:para>Specifies the type of the patches and upgrades you want to scan. The valid values are HostPatch, HostUpgrade, HostThirdParty, VmHardwareUpgrade, VmPatch, VmToolsUpgrade, and VaUpgrade. The VmPatch value is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >UpdateType[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="2"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects you want to scan for baselines attached to them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">InventoryItem[]</command:parameterValue> <dev:type> <maml:name>InventoryItem[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UpdateType</maml:name> <maml:description> <maml:para>Specifies the type of the patches and upgrades you want to scan. The valid values are HostPatch, HostUpgrade, HostThirdParty, VmHardwareUpgrade, VmPatch, VmToolsUpgrade, and VaUpgrade. The VmPatch value is deprecated and will be removed in a following release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">UpdateType[]</command:parameterValue> <dev:type> <maml:name>UpdateType[]</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>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> <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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task[] or null</maml:name> <maml:uri /> <maml:description> <maml:para>If RunAsync is set, the return value is a Task object that represents the scanning task on the vSphere server. If RunAsync is not set, no value is returned.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Test-Compliance -Entity VM -RunAsync</dev:code> <dev:remarks> <maml:para>Scans the VM virtual machine. Since the -RunAsync parameter is set, the cmdlet runs asynchronously and a Task object is returned.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name VM | Test-Compliance</dev:code> <dev:remarks> <maml:para>Scans the VM virtual machine for baselines attached to it.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name MyHost | Test-Compliance -UpdateType HostPatch</dev:code> <dev:remarks> <maml:para>Scans virtual machine host for patches running asynchronously.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Get-Inventory -Name MyVM | Test-Compliance -UpdateType VmHardwareUpgrade, VmToolsUpgrade</dev:code> <dev:remarks> <maml:para>Scan the MyVM virtual machine for upgrades.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Test-Compliance.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Compliance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-Entity</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </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"> <command:details> <command:name>Update-Entity</command:name> <maml:description> <maml:para>This cmdlet remediates an inventory object against the specified baselines.</maml:para> </maml:description> <maml:copyright> <maml:para /> <!--Add copy right info here.--> </maml:copyright> <command:verb>Update</command:verb> <command:noun>Entity</command:noun> <!--Add Dev version info here.--> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>This cmdlet remediates an inventory object against the specified baselines. If RunAsync is set, returns a task that can be used to monitor the remediation progress. You can remediate Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, and VApp objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-Entity</maml:name> <command:parameter required = "false" variableLength = "true" globbing = "true" pipelineInput = "false" position = "named" > <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >VIServer[]</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "false" globbing = "true" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies a Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, or VApp object to remediate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >InventoryItem</command:parameterValue> </command:parameter> <command:parameter required = "true" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baseline you want to use for the remediation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Baseline[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" > <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the patches you want to exclude from the remediation process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "true" >Patch[]</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GuestCreateSnapshot</maml:name> <maml:description> <maml:para>Indicates that you want to create a snapshot before initializing remediation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GuestKeepSnapshotHours</maml:name> <maml:description> <maml:para>Specifies how long (in hours) you want to keep the snapshot. If not set, the snapshots are never deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GuestTakeMemoryDump</maml:name> <maml:description> <maml:para>Indicates that you want the guest to take a memory dump while creating a snapshot.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GuestSnapshotName</maml:name> <maml:description> <maml:para>Specifies a name for the snapshot you want to create before initializing remediation. This parameter is valid only if the GuestCreateSnapshot parameter is set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>GuestSnapshotDescription</maml:name> <maml:description> <maml:para>Specifies a description for the snapshot you want to create before initializing remediation. This parameter is valid only if the GuestCreateSnapshot parameter is set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostRetryDelaySeconds</maml:name> <maml:description> <maml:para>Specifies how long (in seconds) to wait for the host to enter a maintenance mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostNumberOfRetries</maml:name> <maml:description> <maml:para>Specifies how many times to retry to set the host into a maintenance mode.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostFailureAction</maml:name> <maml:description> <maml:para>Specifies an action in case the host cannot be placed in a maintenance mode. This might happen due to running virtual machines that cannot be automatically migrated to another host. The valid values are FailTask, Retry, PowerOffVMsAndRetry, and SuspendVMsAndRetry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >HostRemediationFailureAction</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostPreRemediationPowerAction</maml:name> <maml:description> <maml:para>Specifies an action before trying to enter the host into a maintenance mode. The valid values are PowerOffVMs, SuspendVMs, and DoNotChangeVMsPowerState.</maml:para> </maml:description> <command:parameterValue required="true" variableLength = "false" >HostPreRemediationPowerAction</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostDisableMediaDevices</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable any media devices that might prevent the specified hosts from entering maintenance mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostIgnoreThirdPartyDrivers</maml:name> <maml:description> <maml:para>Indicates that you want to ignore installed third-party software that is incompatible with the upgrade.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>HostEnablePXEbootHostPatching</maml:name> <maml:description> <maml:para>Indicates that you want to enable PXE booted ESXi hosts patching.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ClusterDisableDistributedPowerManagement</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable Distributed Power Management (DPM) for the specified clusters. After the remediation, DPM is automatically re-enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ClusterDisableHighAvailability</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable High Availability (HA) for the specified clusters. After the remediation, HA is automatically re-enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ClusterDisableFaultTolerance</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable Fault Tolerance (FT) for the specified clusters. After the remediation, FT is automatically re-enabled.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>ClusterEnableParallelRemediation</maml:name> <maml:description> <maml:para>Indicates that you want to enable parallel remediation for the specified clusters.</maml:para> </maml:description> <command:parameterValue required="false" variableLength = "false" >Boolean</command:parameterValue> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> </command:parameter> <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" > <maml:name>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="false" position="named"> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">VIServer[]</command:parameterValue> <dev:type> <maml:name>VIServer[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="true (ByValue)" position="named"> <maml:name>Entity</maml:name> <maml:description> <maml:para>Specifies a Template, VirtualMachine, VMHost, Cluster, Datacenter, Folder, or VApp object to remediate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">InventoryItem</command:parameterValue> <dev:type> <maml:name>InventoryItem</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>Baseline</maml:name> <maml:description> <maml:para>Specifies the baseline you want to use for the remediation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Baseline[]</command:parameterValue> <dev:type> <maml:name>Baseline[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>ExcludePatch</maml:name> <maml:description> <maml:para>Specifies the patches you want to exclude from the remediation process.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Patch[]</command:parameterValue> <dev:type> <maml:name>Patch[]</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>GuestCreateSnapshot</maml:name> <maml:description> <maml:para>Indicates that you want to create a snapshot before initializing remediation.</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>GuestKeepSnapshotHours</maml:name> <maml:description> <maml:para>Specifies how long (in hours) you want to keep the snapshot. If not set, the snapshots are never deleted.</maml:para> </maml:description> <command:parameterValue required="true" 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>GuestTakeMemoryDump</maml:name> <maml:description> <maml:para>Indicates that you want the guest to take a memory dump while creating a snapshot.</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>GuestSnapshotName</maml:name> <maml:description> <maml:para>Specifies a name for the snapshot you want to create before initializing remediation. This parameter is valid only if the GuestCreateSnapshot parameter is 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GuestSnapshotDescription</maml:name> <maml:description> <maml:para>Specifies a description for the snapshot you want to create before initializing remediation. This parameter is valid only if the GuestCreateSnapshot parameter is 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>HostRetryDelaySeconds</maml:name> <maml:description> <maml:para>Specifies how long (in seconds) to wait for the host to enter a maintenance mode.</maml:para> </maml:description> <command:parameterValue required="true" 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>HostNumberOfRetries</maml:name> <maml:description> <maml:para>Specifies how many times to retry to set the host into a maintenance mode.</maml:para> </maml:description> <command:parameterValue required="true" 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>HostFailureAction</maml:name> <maml:description> <maml:para>Specifies an action in case the host cannot be placed in a maintenance mode. This might happen due to running virtual machines that cannot be automatically migrated to another host. The valid values are FailTask, Retry, PowerOffVMsAndRetry, and SuspendVMsAndRetry.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HostRemediationFailureAction</command:parameterValue> <dev:type> <maml:name>HostRemediationFailureAction</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>HostPreRemediationPowerAction</maml:name> <maml:description> <maml:para>Specifies an action before trying to enter the host into a maintenance mode. The valid values are PowerOffVMs, SuspendVMs, and DoNotChangeVMsPowerState.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">HostPreRemediationPowerAction</command:parameterValue> <dev:type> <maml:name>HostPreRemediationPowerAction</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>HostDisableMediaDevices</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable any media devices that might prevent the specified hosts from entering maintenance mode.</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>HostIgnoreThirdPartyDrivers</maml:name> <maml:description> <maml:para>Indicates that you want to ignore installed third-party software that is incompatible with the upgrade.</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>HostEnablePXEbootHostPatching</maml:name> <maml:description> <maml:para>Indicates that you want to enable PXE booted ESXi hosts patching.</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>ClusterDisableDistributedPowerManagement</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable Distributed Power Management (DPM) for the specified clusters. After the remediation, DPM is automatically re-enabled.</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>ClusterDisableHighAvailability</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable High Availability (HA) for the specified clusters. After the remediation, HA is automatically re-enabled.</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>ClusterDisableFaultTolerance</maml:name> <maml:description> <maml:para>Indicates that you want to temporarily disable Fault Tolerance (FT) for the specified clusters. After the remediation, FT is automatically re-enabled.</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>ClusterEnableParallelRemediation</maml:name> <maml:description> <maml:para>Indicates that you want to enable parallel remediation for the specified clusters.</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>RunAsync</maml:name> <maml:description> <maml:para>Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run "help About_RunAsync" in the vSphere PowerCLI console.</maml:para> </maml:description> <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>WhatIf</maml:name> <maml:description> <maml:para>Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.</maml:para> </maml:description> <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>Confirm</maml:name> <maml:description> <maml:para>Indicates that the cmdlet asks for confirmation before running.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>VMware.VimAutomation.Types.InventoryItem object</maml:name> <maml:uri/> <maml:description> <maml:para></maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>VMware.VimAutomation.Types.Task[] or null</maml:name> <maml:uri /> <maml:description> <maml:para>If RunAsync is set, the return value is a Task object representing the remediation task on the vSphere server. If RunAsync is not set, no value is returned.</maml:para> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title> -------------- Example 1 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-Entity -Baseline $baseline -Entity $vmhost -RunAsync -Confirm $false</dev:code> <dev:remarks> <maml:para>Remediates a host in asynchronous mode.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 2 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-Entity -Baseline $vmHardwareUpgradeBaseline -Entity $vm -GuestCreateSnapshot:$true</dev:code> <dev:remarks> <maml:para>Upgrades a virtual machine with the latest virtual hardware. If the upgrade fails, the command creates a snapshot of the target virtual machine.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 3 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-Entity -Baseline $baseline -Entity $cluster -ClusterDisableDistributedPowerManagement:$true -ClusterDisableFaultTolerance:$true -ClusterDisableHighAvailability:$true</dev:code> <dev:remarks> <maml:para>Remediates a cluster with DPM, HA, and FT that are enabled and need to be disabled during the remediation process.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 4 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-Entity -Baseline $baseline -Entity $cluster -ClusterEnableParallelRemediation:$true</dev:code> <dev:remarks> <maml:para>Remediates a cluster in parallel mode. All hosts in the cluster are remediated simultaneously and that saves time.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title> -------------- Example 5 -------------- </maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> C:\PS> </maml:introduction> <dev:code>Update-Entity -Baseline $baseline -Entity $vmhost -HostIgnoreThirdPartyDrivers:$true</dev:code> <dev:remarks> <maml:para>Remediates a host with preinstalled third-party drivers, which prevent host from upgrade.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para> </maml:para> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://www.vmware.com/support/developer/PowerCLI/PowerCLI65R1/html/Update-Entity.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-Compliance</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |