Configuring sender details for email notifications

Understand how the hierarchical search works for the email notification sender details, and how you can configure sender details at the Space and Catalog level.

1. Log in to the management server from the command line as a member of a provider organization. For more information, see Logging in to a management server. You can use the same management server URL, username, and password in the login command that you use to log in to the API Manager user interface.
2. To update the sender address details for a Space, run the following commands.
   1. Run the apic space-settings:get command to read the current Space settings and output them to a json file. For example, :

      apic space-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space --format json

      Where:

      • my_mgt_server is your management server endpoint or URL.
      • my_provider_org is the name of your Provider Organization.
      • my_catalog is the name of your Catalog.
      • my_space is the name of your Space.
   2. Make a copy of the output file that you can then use to update the settings, for example:

      cp space-setting.json space-setting-update.json

   3. Edit the copied settings file to update the email_sender block. For example, :

      vi space-setting-update.json
      ...
        "email_sender": {
          "custom": true,
          "name": "NO REPLY: space sender name",
          "address": "space_sender_email@nomail.com"
        },
      ...

      Where:

      • custom must be changed from the default setting of false to true.
      • The name line must be added to the file, and the space sender name details completed.
      • The address line must be added to the file, and the space_sender_email@nomail.com address details completed.

      Note: Ignore other configuration details that are contained in this settings file.
   4. Run the space-settings:update command to update the Space settings with the new sender address details. For example, :

      apic space-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space space-setting-update.json

      Where space-setting-update.json is the name of your updated settings file.
3. To update the sender address details for a Catalog, run the following commands.
   1. Run the apic catalog-settings:get command to read the current Catalog settings and output them to a json file. For example,

      apic catalog-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --format json

      Where:

      • my_mgt_server is your management server endpoint or URL.
      • my_provider_org is the name of your Provider Organization.
      • my_catalog is the name of your Catalog.
   2. Make a copy of the output file that you can then use to update the settings, for example:

      cp catalog-setting.json catalog-setting-update.json

   3. Edit the copied settings file to update the email_sender block. For example:

      vi catalog-setting-update.json
      ...
        "email_sender": {
          "custom": true,
          "name": "NO REPLY: catalog sender name",
          "address": "catalog_sender_email@nomail.com"
        },
      ...

      Where:

      • custom must be changed from the default setting of false to true.
      • name line must be added to the file, and the catalog sender name details completed.
      • address line must be added to the file, and the catalog_sender_email@nomail.com address details completed.

      Note: Ignore other configuration details that are contained in this settings file.
   4. Run the catalog-settings:update command to update the Catalog settings with the new sender address details. For example:

      apic catalog-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog catalog-setting-update.json

      Where catalog-setting-update.json is the name of your updated settings file.