Skip to main content

Hello, how can we help you today?

Or select a category below
Getting Started
Videos

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

  1. Exclaimer Knowledge Base
  2. Solutions
  3. Setup
Payal Arya
  • Updated

Scenario

You have installed the Exclaimer Exchange Transport Agent and want to view or change settings, such as changing which users' emails are routed to Exclaimer, viewing the current settings for troubleshooting or documentation purposes, and/or updating the settings on multiple Exchange servers at a time.

Resolution

Select an option below to view the related instructions:

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

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

  1. Open Windows PowerShell.

  2. Run the following command to get the current list of accepted groups:

    Get-ExclaimerServiceAcceptedGroups

  3. Run the following command to get the current API key:

    Get-ExclaimerServiceApiKey

  4. Run the following command to get the service URI:

    Get-ExclaimerServiceUri

  5. Run the following command to get the current list of accepted senders:

    Get-ExclaimerServiceAcceptedSenders
    NOTE: For information on the API Keys and Service Uri, see Exchange On-Premises.
Updating Exclaimer Exchange Transport Agent settings 

To update Exclaimer Exchange Transport Agent current settings using PowerShell:

CAUTION! Using these commands will replace your current settings. Ensure you include the original users or groups in addition to any new users or groups.
Restart the Exchange Transport Service for any changes to take effect.
  1. Open Windows PowerShell.

  2. Run the following command to update the list of accepted senders:

    Set-ExclaimerServiceAcceptedSenders -AcceptedSenders "first user's email address","second user's email address" 

  3. Run the following command to clear the list of accepted senders:

    Set-ExclaimerServiceAcceptedSenders -ClearList

  4. Run the following command to set the list of accepted groups:

    Set-ExclaimerServiceAcceptedGroups -AcceptedGroups "first group's display name","second group's display name"

  5. Run the following command to clear the list of accepted groups:

    Set-ExclaimerServiceAcceptedGroups -ClearList

  6. Run the following command to set the API key:

    Set-ExclaimerServiceApiKey -ApiKey "your api key from the cloud portal"

  7. Run the following command to 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
Troubleshooting

If you encounter the following error:

No "Manage-ExclaimerAgentConfiguration" Powershell module available

You may need to reinstall the module.

  1. Check that you can access the following file path: C:\Program Files\Exclaimer Ltd\Cloud Signatures for Exchange\Modules\Manage-ExclaimerAgentConfiguration
     
  2. Open Powershell.
     

  3. Run the following command:

    Import-Module -Name "C:\Program Files\Exclaimer Ltd\Cloud Signatures for Exchange\Modules\Manage-ExclaimerAgentConfiguration"
  4. If the problem persists, raise a Support ticket.