Prioritizing SMTP gateways

Use the smtpgw_prioritize command to set the priority of which SMTP gateway should be used to send emails.

smtpgw_prioritize order=<gw1[,gw2]...>  [ internal=<yes|no> ]

Parameters

Name Type Description Mandatory Default
order Object name List of all the SMTP gateways in order of their priority. Y N/A
internal Boolean Specified for the prioritization of XIV internal gateways. N no

Several email gateways can be defined to enable notification of events or the sending of SMS by email. By default, XIV attempts to send each email through the first gateway according to the order that is specified in this command. Only one gateway is used and subsequent gateways are only tried if the preceding ones in this priority list return an error.

These priorities are used only for email destinations and SMS gateways that did not specify their own SMTP gateways.

Example:

smtpgw_prioritize order=mailserver2,mailserver1

Output:

Command completed successfully

Access control

User Category Permission
Storage administrator Allowed
Application administrator Disallowed
Security administrator Disallowed
Read-only users Disallowed
Operations administrator Allowed
Host side accelerator client Disallowed

Return codes

  • GATEWAY_NAME_APPEARS_TWICE

    Gateway name appears twice in the list.

  • GATEWAY_NAME_DOES_NOT_EXIST

    Gateway name does not exist.

  • GATEWAY_NAME_MISSING_FROM_LIST

    Gateway name is missing from the list.