Update-SCVMMManagedComputer
Update-SCVMMManagedComputer
Updates VMM agent software installed on a Windows-based managed computer.
Syntax
Parameter Set: Default
Update-SCVMMManagedComputer [-VMMManagedComputer] <VMMManagedComputer> -Credential <VMMCredential> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [ <CommonParameters>]
Detailed Description
The Update-SCVMMManagedComputer cmdlet updates Virtual Machine Manager (VMM) agent software installed on a Windows-based managed computer to the current version of the software.
If you upgrade your VMM management server to a later version of the VMM service, afterward you can use this command to update agent software on computers that are managed by that VMM management server.
Managed computers that you can update by using this cmdlet include:
-- Hyper-V hosts
-- Windows-based library servers
-- Windows-based P2V source computers
You can use the Update-SCVMMManagedComputer cmdlet to update the VMM agent software on domain-joined trusted hosts and non-trusted domain-joined hosts, but not on hosts located on a perimeter network.
Parameters
-Credential<VMMCredential>
Specifies a credential object or, for some cmdlets, a Run As account object that contains the user name and password of an account that has permission to perform this action.
For more information about the PSCredential object, type Get-Help Get-Credential. For more information about Run As accounts, type Get-Help New-SCRunAsAccount.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMManagedComputer<VMMManagedComputer>
Specifies a computer object that is managed by VMM.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Update all managed computers
The first command prompts you to provide credentials with appropriate permissions to perform this operation, and then stores the credentials in the $Credential variable.
The second command gets all computer objects that are currently managed by VMM, and then passes each object to the ForEach-Object cmdlet. That cmdlet uses the Update-SCVMMManagedComputer cmdlet to update the agent software on each managed computer. As this command is processed, $Credential provides your credentials to Update-SCVMMManagedComputer. This example assumes that no managed computers are located in a perimeter network.
For more information about the standard Windows PowerShell ForEach-Object cmdlet, type Get-Help ForEach-Object.
PS C:\> $Credential = Get-Credential
PS C:\> Get-SCVMMManagedComputer | ForEach-Object { Update-SCVMMManagedComputer -VMMManagedComputer $_ -Credential $Credential -RunAsynchronously }
Example 2: Update a specific host
The first command prompts you to provide credentials with appropriate permissions to perform this operation, and then stores the credentials in the $Credential variable.
The second command gets the managed host object named VMHost01, and then stores the object in the $VMMManagedHost variable.
The last command updates the agent software on VMHost01. As this command is processed, $Credential provides your credentials to Update-SCVMMManagedComputer.
PS C:\> $Credential = Get-Credential
PS C:\> $VMMManagedHost = Get-SCVMMManagedComputer -ComputerName "VMHost01.Contoso.com"
PS C:\> Update-SCVMMManagedComputer -VMMManagedComputer $VMMManagedHost -Credential $Credential