Contact Expert v7.2 for Skype for Business Server
PowerShell Commands
Purpose of this document
This article lists the PowerShell Cmdlets to use in order to perform a specific service or task. Cmdlets are used for administrative procedures, like modifying more components at the same time by a batch update. For example, modification of database connection or firewall rules.
List of commands
| Cmdlet | Description |
|---|---|
Add-CEFirewallRules |
It creates Windows firewall rules required by CE components installed on the current host |
Add-CEContactManagementShare |
It creates a network share to temporarily store contact list files for export/import purposes. It is not important for a non-HA CE but essential in a HA setup. |
Add-CEMediaReplayShare |
It creates a network share to temporarily cache media files for replay purposes. It is not important for a non-HA CE but essential in a HA setup. |
Add-CESMSGateway |
|
Check-CEHealth |
It checks CE related processes and network connectivity to databases, telephony platforms etc. |
Check-CELicense |
It checks CE related licenses |
Get-CEBackupDetails |
It collects backup information from CE related components |
Get-CECASAccessMode |
It checks whether Client Access Server (CAS) running on the current host can be accessed only internally or exposed to the publicity |
Get-CECloudBasedScriptingProperties |
Displays the cloud based scripting properties – e.g. URLs – in effect at the moment. |
Get-CEDomainProperties |
It displays information about the CE domain to which components located on the current host belong |
Get-CEEmailThresholds |
CE might apply several thresholds when downloading incoming emails from mail servers. This cmdlet displays the thresholds used |
Get-CEFirewallRules |
It lists Windows firewall rules associated with CE components located on the current host |
Get-CELogDetails |
Almost each CE process creates log entries. This cmdlet collects log information from CE related components |
Get-CESfbConnectorProperties |
Several parameters are available to customize CE core connectivity to Microsoft SfB. This cmdlet lists the current values of these parameters |
Get-CESfbRecorderProperties |
Several parameters are available to customize CE recorder connectivity to Microsoft SfB. This cmdlet lists the current values of these parameters |
Get-CEReportDatabaseProperties |
It lists the current values of those parameters which are used by CE while connecting to the report database |
Get-CESecurityLevel |
It displays security related information about CE data transmission |
Get-CEServiceEndpoint |
CE uses an internal registry to discover different CE related components. This cmdlet displays information about this registry |
Get-CESMSGateway |
|
Get-CESnapInInfo |
It displays details about the CE PowerShell SnapIn |
Get-CEStartupMethod |
It displays details about CE startup method |
Get-CESystemDatabaseProperties |
It lists the current values of those parameters which are used by CE while connecting to the system database |
Get-CEVoicePlatform |
It displays the voice platform type used in the background |
Get-CEWebAccessDetails |
It describes how to access CE web services (e.g. through which FQDN) |
List-CESMSGateways |
|
Remove-CEContactManagementShare |
It deletes the network share used to store contact list files for export/import purposes |
Remove-CECloudBasedScriptingProperties |
Removes cloud base scripting parameters from the system, clearing the settings. |
Remove-CEFirewallRules |
It removes Windows firewall rules belonging to CE components located on the current host |
Remove-CELogFiles |
It deletes CE related log files |
Remove-CESfbConnectorProperties |
It removes SfB specific connector settings from registry |
Remove-CESfbRecorderProperties |
It removes SfB specific recorder settings from registry |
Remove-CEMediaReplayShare |
It deletes the network share used to cache media files for recording purposes |
Remove-CESMSGateway |
|
Set-CEBackupDetails |
It updates backup properties. This cmdlet can change only the backup directory currently |
Set-CECASAccessMode |
It updates Client Access Server (CAS) access mode. CAS can be access either from the private corporate network or publicly from the Internet |
Set-CECloudBasedScriptingProperties |
Updates the cloud based scripting properties – various URLs – in the system. |
Set-CEDomainProperties |
It assigns each component running on the current host to the specified CE domain |
Set-CEEmailExtract |
When a CE system is upgraded to v5.10+ from a version before 5.10, email content needs to be extracted from the existing messages for the Email Search function to work. This cmdlet needs to be executed once per CE system. |
Set-CEEmailThresholds |
It updates the thresholds used by the email media |
Set-CELogDetails |
It updates log properties. This cmdlet can change the log directory, maximum log file size and the maximum number of log files to keep |
Set-CESfbConnectorProperties |
It updates the parameters used by the SfB connector to connect to the Microsoft SfB platform. |
Set-CESfbRecorderProperties |
It updates the parameters used by the CE SfB recorder |
Set-CEReportDatabaseProperties |
It updates the parameters used by CE components to connect to the report database |
Set-CESecurityLevel |
It updates the security attributes used by CE components to communicate |
Set-CEServiceEndpoint |
It updates the service registry properties |
Set-CESMSGateway |
|
Set-CEStartupMethod |
It changes CE startup type |
Set-CESystemDatabaseProperties |
It updates the parameters used by CE components to connect to the system database |
Set-CEVoicePlatform |
It sets the type of the voice platform used in the background |
Set-CEWebAccessDetails |
It updates networking parameters (e.g. FQDN) through which CE offers web access |
Test-CEPhoneNormalization |
It tests CE phone normalization rules. It accepts a phone number as input and applies the pre-configured normalization rules |
Upgrade-CEDatabaseTimezoneRecords |
It synchronizes the timezone records and daylight saving records in the system database to the Windows records. |
Upgrade-CESfbConfiguration |
It upgrades the Skype For Business parameters used by CE components from XML format to JSON format, and related database structure as well. It needs to be run only once for every ACESystem database after upgrading from CE 5.6 or earlier versions. |