How to manage settings for the Exclaimer Exchange Transport Agent using PowerShell – Exclaimer Cloud

Scenario

There can be a number of reasons why you would want to manage your Exclaimer Exchange Transport Agent settings.

For example, since the initial installation of Exclaimer Exchange Transport Agent, your requirements have changed. You now want to:

Change which users' emails are routed to Exclaimer Cloud, or
View the current settings for troubleshooting or documentation purposes, or
Update the settings on multiple Exchange servers at a time and so on.

Resolution

Please click on the required options listed below to go through the detailed description:

View Exclaimer Cloud - Exchange On-Premises current settings for troubleshooting or documentation purposes

To view the Exclaimer Cloud - Exchange On-Premises current settings using PowerShell:

Open Windows PowerShell.
Get the current list of accepted groups:

Get-ExclaimerServiceAcceptedGroups
Get the current API key:

Get-ExclaimerServiceApiKey
Get the service URI:

Get-ExclaimerServiceUri
Get the current list of accepted senders:

Get-ExclaimerServiceAcceptedSenders

NOTE: For information on the API Keys and Service Uri, please see Exchange On-Premises.

Update Exclaimer Exchange Transport Agent settings

To update Exclaimer Exchange Transport Agent current settings using PowerShell:

CAUTION! Using these commands will replace your current settings; please ensure you include the original users or groups in addition to any new users or groups.
You will need to restart the Exchange Transport Service for any changes to take effect.

Open Windows PowerShell.
Update the list of accepted senders:

Set-ExclaimerServiceAcceptedSenders -AcceptedSenders "<first user's email address>","<second user's email address>"
Clear the list of accepted senders:

Set-ExclaimerServiceAcceptedSenders -ClearList
Set the list of accepted groups:

Set-ExclaimerServiceAcceptedGroups -AcceptedGroups "<first group's display name>","<second group's display name>"
Clear the list of accepted groups:

Set-ExclaimerServiceAcceptedGroups -ClearList
Set the API key:

Set-ExclaimerServiceApiKey -ApiKey "<your api key from the cloud portal>"
Set the service URI:

Set-ExclaimerServiceUri -Uri "<your service uri from the cloud portal>"

NOTE: For information on the API Keys and Service Uri, please see Exchange On-Premises.

Additional information

These commands can also be run remotely to view or update the settings using the following command:

Invoke-Command -ComputerName <server name> {<command>}

For example:
Invoke-Command -ComputerName Server01 {Get-ExclaimerServiceUri}

Invoke-Command -ComputerName Server01,Server02,Server03 {Get-ExclaimerServiceUri}
To view cmdlet help:

Get-Help <command>

For example:
Get-Help Set-ExclaimerServiceAcceptedGroups