Articles in this section

See more

How to manage Exclaimer Cloud Signatures for Exchange settings using PowerShell

Avatar
Exclaimer Support
  • Updated
Follow

Relevant Product: Exclaimer Cloud - Signatures for Exchange

Scenario

There can be a number of reasons why you would want to manage your Exclaimer Cloud Signatures for Exchange settings.

For example, since the initial installation of Exclaimer Cloud - Signatures for Exchange you notice that your requirements have changed. You now want to:

  • Change which users' emails are routed to Exclaimer Cloud, or 

  • Generate a new API key from the Exclaimer Cloud portal and update it, 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

This section consists of steps to help you:

Generating a new API key 

To generate a new API from the Exclaimer Cloud Portal:

  1. Log into the Exclaimer Cloud portal, launch your subscription, then click the options list from the top-right of your screen and select  Settings.

  2. The Settings window is displayed, select the Exchange On-Premises tab then click Edit:
  3. The Exchange On-Premises window is displayed:


  4. Click New Key, to create a new API Key:
  5. The Add API Key window is displayed.

  6. Enter a descriptive name for the new API Key:


  7. Click OK to create the key, else click Cancel to close the window without creating the new key.

    The new API Key is displayed in the API Keys list.

Updating Exclaimer Cloud Signatures for Exchange API Key

To update Exclaimer Cloud Signatures for Exchange API Key using Powershell:

Please see the Updating Exclaimer Cloud Signatures for Exchange settings section.

Viewing the Exclaimer Cloud Signatures for Exchange current settings

To view the Exclaimer Cloud Signatures for Exchange current settings using PowerShell:

  1. Open Windows PowerShell.

  2. Get the current list of accepted groups:

    Get-ExclaimerServiceAcceptedGroups

  3. Get the current API key:

    Get-ExclaimerServiceApiKey

  4. Get the service URI:

    Get-ExclaimerServiceUri

  5. Get the current list of accepted senders:

    Get-ExclaimerServiceAcceptedSenders

Updating Exclaimer Cloud Signatures for Exchange settings:

To update Exclaimer Cloud Signatures for Exchange 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.
  1. Open Windows PowerShell.

  2. Update the list of accepted senders:

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

  3. Clear the list of accepted senders:

    Set-ExclaimerServiceAcceptedSenders -ClearList

  4. Set the list of accepted groups:

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

  5. Clear the list of accepted groups:

    Set-ExclaimerServiceAcceptedGroups -ClearList

  6. Set the API key:

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

  7. Set the service URI:

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

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

Related articles