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

Enables you to assign a certificate to a Microsoft Communications Server 2010 server or server role.

Syntax

Set-CsCertificate -Reference <CertificateReference> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-NetportId <String>] [-Report <String>] [-Type <String[]>] [-WhatIf [<SwitchParameter>]]

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

Parameters

Parameter Required Type Description

Reference

Optional

CertificateReference object

Object reference to a certificate configured for use with Communications Server. For example, this command returns an object reference (the variable $x) that represents a certificate with the thumbprint B142918E463981A76503828BB1278391B716280987B:$x = Get-CsCertificate | Where-Object {$_.Thumbprint –eq "B142918E463981A76503828BB1278391B716280987B".

Type

Optional

String

Specifies the server or server role the certificate will be assigned to. Valid types include (but are not limited to):

Default

WebServicesInternal

WebServicesExternal

ProvisionService

PICWebService

Internal

AccessEdgeExternal

DataEdgeExternal

BandwidthPolicyToken

MediaRelayEdgeToken

For example, this syntax assigns a certificate to the ProvisionServer server role: -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.

Thumbprint

Optional

String

Unique identifier for the certificate. A certificate thumbprint looks similar to this: B142918E463981A76503828BB1278391B716280987B.

Report

Optional

String

Enables you to record (in an XML file) detailed information about the procedures carried out by Set-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.

The Set-CsCertificate cmdlet enables administrators to assign a certificate to a server or server role. Note that you can only assign certificates that have already been configured for use with Communications Server. To identify certificates available for assignment, use the Get-CsCertificate cmdlet.

Return Types

Set-CsCertificate does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object.

Examples

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

Copy Code 
Set-CsCertificate -Type PICWebService -Thumbprint "B142918E463981A76503828BB1278391B716280987B"

The command shown in Example 1 assigns the certificate with the Thumbprint B142918E463981A76503828BB1278391B716280987B to the PICWebService role on the local computer.

-------------------------- Example 2 ------------------------

Copy Code 
Set-CsCertificate -Type Default, WebServicesInternal, WebServicesExternal -Thumbprint "B142918E463981A76503828BB1278391B716280987B"

The preceding command assigns the assigns the certificate with the Thumbprint B142918E463981A76503828BB1278391B716280987B to three different roles on the local computer: Default, WebServicesInternal, and WebServicesExternal.