[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes a certificate previously marked as being available for use by Microsoft Communications Server 2010.

Syntax

Remove-CsCertificate [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-NetportId <String>] [-Report <String>] [-Type <String[]>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Type

Optional

String

Enables you to specify the type of certificate to be removed. Certificate types include (but are not limited to):

Default

WebServicesInternal

WebServicesExternal

ProvisionService

PICWebService

Internal

AccessEdgeExternal

DataEdgeExternal

MediaRelayEdgeToken

BandwidthPolicyToken

For example, this syntax removes all the ProvisionService certificates found on the local computer: -Type ProvisionService.

NetportId

Optional

String

Reserved for future use. This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Communications Server.

Report

Optional

String

Enables you to record (in an XML file) detailed information about the procedures carried out by Remove-CsCertificate. The parameter value should be the full path to the XML file; for example: -Report C:\Logs\Certificates.xml. If the specified file already exists it will automatically be overwritten with the new information.

Force

Optional

Switch Parameter

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

Communications Server 2010 uses certificates as a way for servers and server roles to verify their identities; for example, Edge Servers use certificates to verify that the computer they are communicating with really is a Front End Server and vice versa. In order to fully implement Communications Server you will need to have the appropriate certificates assigned to the appropriate server roles.

Remove-CsCertificate provides a way for you to remove certificates currently in use by Communications Server. Remove-CsCertificate does not actually delete the certificate itself; instead, it simply marks the certificate as no longer being available for use by Communications Server. (For example, the certificate will no longer appear when you run the Get-CsCertificate cmdlet.) To once again use the certificate with Communications Server, you will need to import the certificate file using Import-CsCertificate.

Note that certificates cannot be removed if they are currently in use by a server or server role. To delete a certificate, you must first use Set-CsCertificate to assign a different certificate to the appropriate server or server role.

Return Types

Remove-CsCertificate deletes instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object.

Examples

-------------------------- Example 1 ------------------------

Copy Code 
Remove-CsCertificate -Type PICWebService

The command shown in Example 1 deletes all the PICWebService certificates that are not currently being used by Communications Server.