@ -28,12 +28,12 @@ When set, this changes the password on the target Anvil! sub-cluster. This is th
.TP
When not set, the Striker dashboard this command is run on will have it's passwords updated.
.TP
\fB\-\-new-password\fR <secret>
\fB\-\-new\-password\fR <secret>
This is the new password to set. See '\fB\-\-password-file\fR' below for an alternate way to pass in the password.
.TP
If not set, you will be prompted to enter the new password.
.TP
\fB\-\-password-file\fR </path/to/file>
\fB\-\-password\-file\fR </path/to/file>
This is an alternative way to pass the new password to this program. If set, the file is read in and the file contents are used. Be sure to use one line only in the file.
@ -21,7 +21,7 @@ When logging, record sensitive data, like passwords.
Set the log level to 1, 2 or 3 respectively. Be aware that level 3 generates a significant amount of log data.
.SS"Commands:"
.TP
\fB\-\-job-uuid\fR <name>
\fB\-\-job\-uuid\fR <name>
The program is normally run as a job, with data on how to configure the host defined in the job. This switch allows the running of a specific job. If this is not set, the program will search for a job that has not yet been picked up by another process. If found, that job UUID is used automatically.
When logging, record sensitive data, like passwords.
.TP
\-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.
.SS"Commands:"
.TP
\fB\-\-job-uuid\fR <UUID>
\fB\-\-job\-uuid\fR <UUID>
The program is normally run as a job, with data on how to configure the host defined in the job. This switch allows the running of a specific job. If this is not set, the program will search for a job that has not yet been picked up by another process. If found, that job UUID is used automatically.
@ -17,7 +17,7 @@ When called without any switches, the list of currect mail servers, alert recipi
\-?, \-h, \fB\-\-help\fR
Show this man page.
.TP
\fB\-\-log-secure\fR
\fB\-\-log\-secure\fR
When logging, record sensitive data, like passwords.
.TP
\-v, \-vv, \-vvv
@ -35,19 +35,19 @@ NOTE: All fields are required when editing an existing mail server or recipient!
\fB\-\-delete\fR
This deletes an existing mail server or alert recipient.
.TP
\fB\-\-alert-overrides\fR
\fB\-\-alert\-overrides\fR
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.
.TP
\fB\-\-alert-override-uuid\fR <uuid>
\fB\-\-alert\-override\-uuid\fR <uuid>
This is required for \fB\-\-edit\fR and \fB\-\-delete\fR. It is the existing alert-override override being worked on.
.TP
\fB\-\-alert-override-recipient-uuid\fR <uuid>
\fB\-\-alert\-override\-recipient\-uuid\fR <uuid>
This is the recipients -> recipient_uuid who we are creating the override for.
.TP
\fB\-\-alert-override-host-uuid\fR
\fB\-\-alert\-override\-host\-uuid\fR
This is the hosts -> host_uuid of the machine that you are creating the alert
.TP
\fB\-\-alert-override-alert-level\fR <1, 2, 3 or 4>
\fB\-\-alert\-override\-alert\-level\fR <1, 2, 3 or 4>
This is the desired override alert level.
Valid values are:
@ -73,41 +73,41 @@ Valid values are:
4 or "info"
.TP
\fB\-\-mail-servers\fR
\fB\-\-mail\-servers\fR
This is used to manage mail servers. Specifically, this control the mail server that we send alert emails to. The options used with this are;
.TP
\fB\-\-mail-server-uuid\fR <uuid>
\fB\-\-mail\-server\-uuid\fR <uuid>
This is required for \fB\-\-edit\fR and \fB\-\-delete\fR. It is the existing mail server being worked on.
.TP
\fB\-\-mail-server-address\fR <URL or IP>
\fB\-\-mail\-server\-address\fR <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
.TP
\fB\-\-mail-server-port\fR
\fB\-\-mail\-server\-port\fR
This is the TCP port used when connecting to the target mail server.
Example: 587
.TP
\fB\-\-mail-server-username\fR
\fB\-\-mail\-server\-username\fR
This is the mail server user name (usually an email address) used when authenticating against the mail server.
Example: admin@example.com
.TP
\fB\-\-mail-server-password\fR
\fB\-\-mail\-server\-password\fR
This is the password used along with \fB\-\-mail-server-username\fR when authenticating against the mail server. Not all mail servers require a password, so this is optional.
.TP
\fB\-\-mail-server-security\fR <none, starttls or tls-ssl>
\fB\-\-mail\-server\-security\fR <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'.
.TP
\fB\-\-mail-server-authentication\fR <none, plain-text, or encrypted>
\fB\-\-mail\-server\-authentication\fR <none, plain-text, or encrypted>
This is how passwords are passed to the mail server.
Valid values are: 'none', 'plain-text', or 'encrypted'
.TP
\fB\-\-mail-server-helo-domain\fR
\fB\-\-mail\-server\-helo\-domain\fR
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.
This is used to manage alert recipients. Specifically, this control the mail server that we send alert emails to. The options used with this are;
.TP
\fB\-\-recipient-uuid\fR
\fB\-\-recipient\-uuid\fR
This is required for \fB\-\-edit\fR and \fB\-\-delete\fR. It is the existing alert recipient is being worked on.
.TP
\fB\-\-recipient-name\fR
\fB\-\-recipient\-name\fR
This is the name of the person receiving the alerts. This is used in the email header.
Example: Austin Powers
.TP
\fB\-\-recipient-email\fR
\fB\-\-recipient\-email\fR
This is the email address for the alert recipient.
Example: notaspy@example.com
.TP
\fB\-\-recipient-language\fR <en_CA>
\fB\-\-recipient\-language\fR <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.
.TP
\fB\-\-recipient-level\fR <1, 2, 3 or 4>
\fB\-\-recipient\-level\fR <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.
@ -26,7 +26,7 @@ This will delete the \fB\-\-file\fR </path/to/file> from the entire Anvil! clust
.TP
This action is permanent!
.TP
\fB\-\-job-uuid\fR <name>
\fB\-\-job\-uuid\fR <name>
The program is normally run as a job, with data on how to configure the host defined in the job. This switch allows the running of a specific job. If this is not set, the program will search for a job that has not yet been picked up by another process. If found, that job UUID is used automatically.
digimer
1 year ago