Import-CsCertificate
Imports a certificate for use with Skype for Business Server. If a certificate is not acquired by using the Request-CsCertificate cmdlet, then that certificate must be imported before it can be assigned to a Skype for Business Server server role. This cmdlet was introduced in Lync Server 2010.
Syntax
Import-CsCertificate
-Path <String>
[-Password <String>]
[-PrivateKeyExportable <Boolean>]
[-Force]
[-Report <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Import-CsCertificate
[-Identity] <XdsIdentity>
-Path <String>
-Type <CertType[]>
[-Confirm]
[-EffectiveDate <DateTime>]
[-Force]
[-Password <String>]
[-Report <String>]
[-Roll]
[-WhatIf]
[<CommonParameters>] Import-CsCertificate
-Path <String>
[-Confirm]
[-EffectiveDate <DateTime>]
[-Force]
[-Password <String>]
[-PrivateKeyExportable <Boolean>]
[-Report <String>]
[-Roll]
[-WhatIf]
[<CommonParameters>] Description
Skype for Business Server uses certificates as a way for servers and server roles to verify their identities; for example, an Edge Server uses certificates to verify that the computer it is communicating with really is a Front End Server and vice versa. In order to fully implement Skype for Business Server you will need to have the appropriate certificates assigned to the appropriate server roles.
In order for certificates to be assigned to a Skype for Business Server role those certificates must be made known to Skype for Business Server. The Request-CsCertificate cmdlet enables you to make both online and offline requests for new certificates. If an online request is made, the certificate will automatically be downloaded and saved in the local certificate store; equally important, it will be immediately available for use by Skype for Business Server. If an offline request is made, a certificate file will be sent to you. At that point, you can use the Import-CsCertificate cmdlet to import the certificate, a process that makes the certificate available for assignment to a Skype for Business Server server role.
Examples
-------------------------- EXAMPLE 1 --------------------------
Import-CsCertificate -Path "C:\Certificates\WebServer.pfx" -PrivateKeyExportable $TrueThe command shown in Example 1 imports the certificate C:\Certificates\WebServer.pfx. After the command completes, the certificate will be available to be assigned to a server role.
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-EffectiveDate
Date and time when the certificate can first be used. For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings:
-EffectiveTime "7/31/2012 8:00 AM"
| Type: | DateTime |
| Aliases: | EffectiveTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
When set to Global, enables the certificate to function at the global scope. Global certificates will automatically be copied and distributed to the appropriate computers.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Password
Password associated with the certificate file.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Path
Full path to the certificate file to be imported.
For example: -Path "C:\Certificates\WebServer.cer".
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-PrivateKeyExportable
When set to True, ensures that the private key portion of the certificate can be read by the Network Service account.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Report
Enables you to specify a file path for the log file created when the cmdlet runs.
For example: -Report "C:\Logs\Certificates.html"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Roll
Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Type
Type of certificate being requested. Certificate types include, but are not limited to, the following:
AccessEdgeExternal
AudioVideoAuthentication
DataEdgeExternal
Default
External
Internal
iPadAPNService
iPhoneAPNService
LogRetentionService
MPNService
OAuthTokenIssuer
PICWebService
ProvisionService
SMPDNSWebService
TenantAdmin
UpgradeEngineService
WebServicesExternal
WebServicesInternal
WsFedTokenTransfer
XMPPServer
| Type: | CertType[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None. Import-CsCertificate does not accept pipelined input.
None. The Import-CsCertificate cmdlet does not accept pipelined input.
Outputs
None.