Anvil-manage-alerts

Alteeve Wiki :: Man Pages :: Anvil-manage-alerts

NAME

anvil-manage-alerts - This program manages alerts; Email servers, recipients, alert-override overrides, and generating test alerts.

SYNOPSIS

anvil-manage-alerts <command>

DESCRIPTION

The program allows you to add, edit and delete email servers, alert recipients, and alert-override overrides. You can also use it to generate a test alert. If run without any switches, the list of mail servers and recipients are returned.

When called without any switches, the list of current mail servers, alert recipients and alert-override overrides are shown, along with all known hosts.

OPTIONS

-?, -h, --help

Show this man page.

--log-secure

When logging, record sensitive data, like passwords.

-v, -vv, -vvv

Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data.

Commands:

--add

This is used to add a new mail server or alert recipient.

--edit

This is used to edit an existing mail server or alert recipient.

NOTE: All fields are required when editing an existing mail server or recipient!

--delete

This deletes an existing mail server or alert recipient.

--alert-overrides

This is where an alert recipient can have alert-override overrides. Typically this is used so that a given user can ignore alerts from a specific Anvil! node pair.

--alert-override-uuid <uuid>

This is required for --edit and --delete. It is the existing alert-override override being worked on.

--alert-override-recipient-uuid <uuid>

This is the recipients -> recipient_uuid who we are creating the override for.

--alert-override-host-uuid

This is the hosts -> host_uuid of the machine that you are creating the alert

--alert-override-alert-level <1, 2, 3 or 4>

This is the desired override alert level.

Valid values are:

0 = "ignore" all alerts

1 = "critical" alerts only

2 = "warning" and critical alerts

3 = "notice", warning and critical alerts

4 = "info"; All alerts. This generates almost constant alerts!

--level <1, critical, 2, warning, 3, notice, 4, or info>

When --test is used, this sets the level the test alert is to be sent at.

Valid values are:

1 or "critical"

2 or "warning"

3 or "notice"

4 or "info"

--mail-servers

This is used to manage mail servers. Specifically, this controls the mail server that we send alert emails to. The options used with this are;

--mail-server-uuid <uuid>

This is required for --edit and --delete. It is the existing mail server being worked on.

--mail-server-address <URL or IP>

This is the URL or IP address of the mail server we're logging into to send email.

Example: mail.example.com

--mail-server-port

This is the TCP port used when connecting to the target mail server.

Example: 587

--mail-server-username

This is the mail server user name (usually an email address) used when authenticating against the mail server.

Example: admin@example.com

--mail-server-password

This is the password used along with --mail-server-username when authenticating against the mail server. Not all mail servers require a password, so this is optional.

--mail-server-security <none, starttls or tls-ssl>

This is the security type used when authenticating against the mail server.

Valid values are: 'none', 'starttls' or 'tls-ssl'.

--mail-server-authentication <none, plain-text, or encrypted>

This is how passwords are passed to the mail server.

Valid values are: 'none', 'plain-text', or 'encrypted'

--mail-server-helo-domain

This is the 'HELO' domain name used when communicating with the mail server. This is the domain we're telling the mail server that the email is coming from. You can use your domain, or the domain of the host.

Example: example.com

See: https://www.ibm.com/docs/en/zos/2.2.0?topic=sc-helo-command-identify-domain-name-sending-host-smtp

--recipients

This is used to manage alert recipients. Specifically, this controls the mail server that we send alert emails to. The options used with this are;

--recipient-uuid

This is required for --edit and --delete. It is the existing alert recipient that is being worked on.

--recipient-name

This is the name of the person receiving the alerts. This is used in the email header.

Example: Austin Powers

--recipient-email

This is the email address for the alert recipient.

Example: notaspy@example.com

--recipient-language <en_CA>

In the future, languages will be added and this can be used to indicate what language the user will receive their alerts in. At the time of writing this man page, only 'en_CA' is supported.

--recipient-level <1, 2, 3 or 4>

This is the default alert level this recipient is interested in. It can be adjusted on a per-host basis via the 'alert-overrides' over-rides.

Valid values are:

1 = "critical" alerts only

Critical alerts are events that could lead to imminent service interruption or unexpected loss of redundancy.

These alerts will go to all recipients except for those ignoring the source system entirely.

Alerts at this level should trigger alarm systems for all administrators as well as management who may be impacted by service interruptions.

2 = "warning" and critical alerts

Warning alerts may require attention, such as intentional loss of redundancy caused by load shedding, hardware in pre-failure, loss of input power, temperature anomalies, etc.

Alerts at this level should trigger alarm systems for administrative staff.

3 = "notice", warning and critical alerts

Notice alerts are generally safe to ignore, but might provide early warnings of developing issues or insight into system behaviour.

Alerts at this level should not trigger alarm systems. Periodic review is sufficient.

4 = "info"; All alerts. This generates almost constant alerts!

Info alerts are almost always safe to ignore, but may be useful in testing and debugging.

--test

Tells the program to send a test alert at the desired --level. The requested level is required.

AUTHOR

Written by Madison Kelly, Alteeve staff and the Anvil! project contributors.

REPORTING BUGS

Report bugs to users@clusterlabs.org

 

Any questions, feedback, advice, complaints or meanderings are welcome.
Alteeve's Niche!	Enterprise Support: Alteeve Support	Community Support
© Alteeve's Niche! Inc. 1997-2024		Anvil! "Intelligent Availability®" Platform
legal stuff: All info is provided "As-Is". Do not use anything here unless you are willing and able to take responsibility for your own actions.