Invoke-CMRemoteControl
Invoke-CMRemoteControl
Enables remote control on computers.
Syntax
Parameter Set: InvokeDeviceByIdMandatory
Invoke-CMRemoteControl -DeviceId <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InvokeDeviceByNameMandatory
Invoke-CMRemoteControl -DeviceName <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InvokeDeviceByValueMandatory
Invoke-CMRemoteControl -Device <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InvokeSiteStatusByNameMandatory
Invoke-CMRemoteControl -SiteSystemServerName <String[]> [-SiteCode <String[]> ] [-SiteSystemRole <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: InvokeSiteStatusByValueMandatory
Invoke-CMRemoteControl -SiteStatus <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Invoke-CMRemoteControl cmdlet enables remote control on the computers that you want to use in a remote control session. You can enable remote control on computers by specifying the ID or name of the computers, the site systems, or the site status.
Use remote control in Microsoft System Center 2012 SP1 Configuration Manager to remotely administer, provide assistance, or view any client computer in the hierarchy. You can use remote control to troubleshoot hardware and software configuration problems on client computers and to provide help desk support when access to the computer of a user is required. System Center 2012 Configuration Manager supports the remote control of workgroup computers and computers that are joined to an Active Directory domain.
Parameters
-Device<IResultObject>
Specifies a CMDevice object. To obtain a CMDevice object, use the Get-CMDevice cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceId<String[]>
Specifies an array of device IDs.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DeviceName<String[]>
Specifies an array of device names.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteCode<String[]>
Specifies an array of site codes of Configuration Manager sites that host the site system roles.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteStatus<IResultObject>
Specifies a CMSiteStatusMessage object. To obtain a CMSiteStatusMessage object, use the Get-CMSiteStatusMessage cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteSystemRole<String[]>
Specifies an array of Configuration Manager roles that the site system performs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteSystemServerName<String[]>
Specifies an array of fully qualified domain names (FQDN) of the servers that host the site system roles.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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: Enable remote control on a computer
This command enables remote control on the computer named CMCEN-DIST02.
PS C:\> Invoke-CMRemoteControl -DeviceName "CMCEN-DIST02"