alert-rules

Manage users associated with alert rules.

alert-rules [OPTIONS] COMMAND [ARGS]...

add-user

Add a user to an alert rule.

alert-rules add-user [OPTIONS]

Options

--rule-id <rule_id>

Required Identification number of the alert rule.

-u, --username <username>

Required The username of the user to add to the alert rule.

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

bulk

Tools for executing bulk alert rule actions.

alert-rules bulk [OPTIONS] COMMAND [ARGS]...

add

Bulk add users to alert rules from a CSV file. CSV file format: rule_id,username

alert-rules bulk add [OPTIONS] CSV_FILE

Options

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

Arguments

CSV_FILE

Required argument

generate-template

Generate the CSV template needed for bulk adding/removing users.

alert-rules bulk generate-template [OPTIONS] {add|remove}

Options

-p, --path <path>

Write template file to specific file path/name.

Arguments

CMD

Required argument

remove

Bulk remove users from alert rules using a CSV file. CSV file format: {‘,’.join(ALERT_RULES_CSV_HEADERS)}

alert-rules bulk remove [OPTIONS] CSV_FILE

Options

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

Arguments

CSV_FILE

Required argument

list

Fetch existing alert rules.

alert-rules list [OPTIONS]

Options

-f, --format <format>

The output format of the result. Defaults to table format.

Options

TABLE | CSV | JSON | RAW-JSON

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

remove-user

Remove a user from an alert rule.

alert-rules remove-user [OPTIONS]

Options

--rule-id <rule_id>

Required Identification number of the alert rule.

-u, --username <username>

Required The username of the user to remove from the alert rule.

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

show

Print out detailed alert rule criteria.

alert-rules show [OPTIONS] RULE_ID

Options

-d, --debug

Turn on debug logging.

--totp <totp>

TOTP token for multi-factor authentication.

--profile <profile>

The name of the Code42 CLI profile to use when executing this command.

Arguments

RULE_ID

Required argument