Removes an existing device from the collection of analog devices that can be managed using Microsoft Communications Server 2010. An analog device is a telephone (or fax machine) connected to the Public Switched Telephone Network.
Syntax
Remove-CsAnalogDevice [-Identity] <UserIdParameter> [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>] [-WhatIf] [-Confirm] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Active Directory distinguished name |
Unique identifier for the analog device to be removed. Analog devices are identified using the Active Directory distinguished name of the associated contact object. These devices, by default, use a GUID (globally unique identifier) as their common name; that means analog devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. Because of that you might find it easier to retrieve analog devices by using the Get-CsAnalogDevice cmdlet, then piping the returned objects to Remove-CsAnalogDevice. Note. By using the –DN parameter when calling New-CsAnalogDevice, administrators can give analog devices phones a more user-friendly common name (e.g., Building 14 Lobby as opposed to {ce84964a-c4da-4622-ad34-c54ff3ed361f}). |
|
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. |
Detailed Description
Analog devices include telephones, fax machines, modems, and TTY/TTD (Teletype/Telecommunication Devices for the Deaf) devices connected to the Public Switched Telephone Network (PSTN). Unlike devices that take advantage of Enterprise Voice (Microsoft’s implementation of Voice over IP), analog devices do not transmit information using digital packets; instead, information is transmitted using a continuous signal. This signal is commonly referred to as an analog signal; hence the term "analog devices."
Many organizations still are heavily invested in analog devices. In order to enable administrators to manage analog devices, Microsoft Communications Server lets you associate analog devices with Active Directory contact objects. After a device has been associated with a contact object you can then manage the analog device by assigning policies and dial plans to the contact.
Over time, you might need to delete a contact object associated with an analog device. For example, if you phase out all of your fax machines you will no longer need to have analog devices (and contact objects) associated with those machines. The Remove-CsAnalogDevice cmdlet provides a way for you to delete analog devices. When you run this cmdlet, the device will be deleted from the list of analog devices returned by Get-CsAnalogDevice. Equally important, the contact object associated with that device will be deleted from Active Directory.
Return Types
Remove-CsAnalogDevice deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsAnalogDevice -Identity "CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com"
|
|
Example 1 deletes the analog device that has the Identity CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} | Remove-CsAnalogDevice
|
|
The command shown in Example 2 deletes any analog devices that have been assigned the DisplayName "Building 14 Receptionist". To carry out this task, the command first calls Get-CsAnalogDevice along with the -Filter parameter; the filter value {DisplayName -eq "Building 14 Receptionist"} limits the returned objects to analog devices where the DisplayName property is equal to (-eq) "Building 14 Receptionist". The returned items are then piped to, and removed by, Remove-CsAnalogDevice.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsAnalogDevice -Filter {VoicePolicy -eq "RedmondVoicePolicy"} | Remove-CsAnalogDevice
|
|
The preceding command deletes all the analog devices that have been assigned the voice policy RedmondVoicePolicy. To do this, Get-CsAnalogDevice and the -Filter parameter are used to retrieve all the analog devices where the VoicePolicy property is equal to (-eq) RedmondVoicePolicy. The filtered collection is then piped to the Remove-CsAnalogDevice cmdlet, which deletes each item in that collection.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsAnalogDevice -Filter {AnalogFax -eq $True} | Remove-CsAnalogDevice
|
|
The command shown in Example 4 removes all the analog fax machines currently in use in the organization. To carry out this task, Get-CsAnalogDevice is first along with the –Filter parameter; the filter value {AnalogFax –eq $True} picks out only those devices where the AnalogFax property is equal to (-eq) True ($True). In turn, this filtered collection is piped to Remove-CsAnalogDevice, which removes each item in the collection.