Disable-CsComputer
Topic Last Modified: 2012-03-23
Disables a service or server role that has been removed from a computer running Microsoft Lync Server 2010.
Syntax
Disable-CsComputer [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Report <String>] [-Scorch <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Removing a service or server role from a computer does not automatically update the Lync Server 2010 topology. Instead, that service or role must be disabled before the changes are fully updated in the topology. The Disable-CsComputer cmdlet provides a way for administrators to disable any services or server roles that have been removed from the local computer.
Unless you use the Scorch parameter, the Disable-CsComputer cmdlet does not uninstall the Lync Server 2010 software; instead, it simply stops the computer from functioning in its previously assigned role.
Who can run this cmdlet: You must be a local administrator and a member of the domain in order to run the Disable-CsComputer cmdlet locally.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Scorch |
Optional |
Switch Parameter |
Uninstalls all Lync Server 2010 services and server roles for the local computer. |
GlobalCatalog |
Optional |
String |
Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running Disable-CsComputer on a computer with an account in your domain. |
GlobalSettingsDomainController |
Optional |
String |
FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services (AD DS), then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. |
Report |
Optional |
String |
Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\DisableComputer.html" |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
None. Disable-CsComputer does not accept pipelined input.
Return Types
None. Instead, Disable-CsComputer disables instances of the Microsoft.Rtc.Management.Deploy.Internal.Machine object.
Example
-------------------------- Example 1 ------------------------
Disable-CsComputer
The command shown in Example 1 disables the local computer.
-------------------------- Example 2 ------------------------
Disable-CsComputer -Report C:\Logs\Disable.html
The command shown in Examples 2 also disables the local computer. In addition to disabling the computer, however, this command records information about the success (or failure) of that task in the file C:\Logs\Disable.html. This log file is generated by adding the Report parameter followed by the path to the log file where you want the information recorded.