Cloud Connector cmdlet reference
Important
Cloud Connector Edition will retire July 31, 2021 along with Skype for Business Online. Once your organization has upgraded to Teams, learn how to connect your on-premises telephony network to Teams using Direct Routing.
The following table lists the Skype for Business Cloud Connector Edition cmdlets with a brief description and links to more information.
Note
You must run all the cmdlets on the Cloud Connector host machine, and you must run the PowerShell session as Administrator.
| Cmdlet name** | Description |
|---|---|
| Backup-CcCertificationAuthority Version 1.4.2 and later |
Backs up the certification authority service to a file and saves it to the CA folder under the site share directory. |
| Convert-CcIsoToVhdx | Creates a base virtual hard disk file (VHDX) using a customer supplied Windows Server 2012 R2 ISO file. The VHDX file will be used during the deployment ofCloud Connector. |
| Enter-CcUpdate | Prepares the Cloud Connector host server for the update process by putting it in maintenance mode. The appliance is "drained"; that is, all existing calls will complete, but new calls are rejected. |
| Exit-CcUpdate | Exits update maintenance mode on the Cloud Connector host server. |
| Export-CcConfiguration | Exports a Skype for Business Cloud Connector Edition configuration to a local file on the Skype for Business Cloud Connector Edition host server. |
| Export-CcConfigurationSampleFile | Exports a Cloud Connector sample configuration file (.ini) to the appliance directory of a Cloud Connector appliance. You can modify and rename the file to use for your deployment. |
| Export-CcRootCertificate Version 1.4.2 and later |
Exports the root CA certificate to a local file on the Cloud Connector host server. |
| Get-CcApplianceDirectory | Retrieves the working directory on the Cloud Connector host server. All deployment files are stored in this directory. |
| Get-CcApplianceLogDirectory | Shows the current directory where logs for a Cloud Connector appliance are stored. |
| Get-CcApplianceStatus Version 2.1 and later |
Provides diagnostic information for the Cloud Connector appliance. |
| Get-CcCredential | Returns the credential of the current Cloud Connector deployment. |
| Get-CcExternalCertificateFilePath | Returns the external certificate file path for the Cloud Connector deployment. The user prepares this certificate. |
| Get-CcSiteDirectory | Shows the current directory where site level configuration files are stored. The folder contains the base VHD and Cloud Connector installation files. This folder should be shared with all other appliances of a Cloud Connector site. |
| Get-CcSiteLogDirectory | Shows the current directory where the site level logs for Cloud Connector are stored. |
| Get-CcVersion Version 2.0 and later |
Returns the version on Cloud Connector instance. Get-CCVersion can only be used in the host machine of Cloud Connector. |
| Import-CcConfiguration Version 2.0 and later |
Imports the Skype for Business Cloud Connector Edition configuration from a local file to the Cloud Connector host server. |
| Install-CcAppliance | Installs the Cloud Connector appliance—including the AD, Central Management Store, Mediation Server, and Edge Server virtual machines—on the host server. |
| Publish-CcAppliance | Gets high availability information from the online tenant configuration and publishes it to the Cloud Connector appliance on the host server. |
| Register-CcAppliance | Registers appliance information to a PSTN site in an online tenant configuration. An appliance must be registered before it can be deployed and managed by the Cloud Connector management service. |
| Remove-CcCertificationAuthorityFile Version 1.4.2 and later |
Removes the certification authority service backup file "<SiteRootDirectory>\CA\SfB CCE Root.p12" in the CA folder under the site share directory for Cloud Connector. |
| Remove-CcLegacyServerCertificate Version 1.4.2 and later |
Removes legacy server certificates on the Central Management Store, Mediation Server, and Edge Server after you execute the Renew-CcCACertificate or Renew CcServerCertificate cmdlets. |
| Renew-CcCACertificate Version 1.4.2 only |
Reinstalls the Certification Authority Service AD Server to create a new root CA certificate. |
| Renew-CcServerCertificate Version 1.4.2 only |
Renews the certificates for Cloud Connector when they are near expiration or already expired. |
| Reset-CcCACertificate Version 1.4.2 and later |
Resets the certificate authority servers to install a new certificate authority certificate. |
| Restore-CcCredentials Version 2.1 and later |
Cleans up credentials and prompts you to re-enter all the credentials used for the current Cloud Connector deployment. |
| Search-CcLog | Searches the incoming and outgoing call logs in the Cloud Connector appliance log directory |
| Set-CcApplianceDirectory | Sets the working directory on the Cloud Connector host server. All deployment files are stored in this directory. |
| Set-CcCredential | Sets the credential of the current Cloud Connector deployment. |
| Set-CcExternalCertificateFilePath | Specifies the path where the certificate for the Mediation Server or Edge Server is stored |
| Set-CcSiteDirectory | Sets the directory where site level configuration files for Cloud Connector will be stored. The folder will contain the base VHD and Cloud Connector configuration files. |
| Start-CcDownload | Downloads the Cloud Connector bits and msi file synchronously. |
| Start-CcLogging | Generates the incoming and outgoing call log for a Cloud Connector appliance. |
| Stop-CcLogging | Stops generating the incoming and outgoing call log for a Cloud Connector appliance. |
| Switch-CcVersion | Disconnects the running appliance and switches to a newly deployed or backup appliance. |
| Uninstall-CcAppliance | Uninstalls the running Cloud Connector appliance from the host server. |
| Unregister-CcAppliance | Unregisters the current Cloud Connector appliance from a PSTN site in the online tenant configuration. |
| Update-CcCACertificate Version 2.0 and later |
Reinstalls the Certification Authority Service AD Server to create a new root CA certificate. |
| Update-CcServerCertificate Version 2.0 and later |
Renews the certificates for Cloud Connector when they are near expiration or already expired. |