Contact Us 1-800-596-4880

CLI for Hybrid Application Alerts

Use these commands to control alerts for apps that are deployed to your local Mule server and managed with Runtime Manager. For more information about how to use these commands, refer to the Runtime Manager documentation.

Command Description

Creates new alert for standalone runtime

Describes an alert

Lists all alerts for standalone runtimes in the environment

Modifies alert for standalone runtime

runtime-mgr:standalone-alert:create

> runtime-mgr:standalone-alert:create <name> [flags]

Creates a new alert for a standalone runtime with the ID passed in name. The alert name is limited to 256 characters.

In addition to the default flag --help, this command accepts the following flags:

Flag Description Example

--condition

Alert trigger condition

--condition cluster-up

--content <string>

Alert notification email body

--content Email Body

--email

Email address to send alert notification to
Can be used multiple times to specify up to 20 email addresses

--email user@mulesoft.com

--operator

Condition operator explaining values relation to threshold.

--operator gt

--period

Condition duration in minutes

--period 15

--recipient

Username to send alert notification to
Can be used multiple times to specify up to 20 platform user IDs

--recipient 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--resource

Alert resource ID. If not provided alert triggers for all resources. Depending on resourceType, the resource id can be of an application, server, server-group or cluster.

--resource 12343

--resourceType

Alert resource type

--resourceType server

--severity

Alert severity

--severity 3

--subject <string>

Alert notification email subject

--subject Email Subject

--threshold

Condition threshold number

--threshold 10

This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.

runtime-mgr:standalone-alert:describe

> runtime-mgr:standalone-alert:describe [flags] <alertId>

Describes the alert passed in alertId.

This command accepts the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.

This command also accepts the default flag --help.

runtime-mgr:standalone-alert:list

> runtime-mgr:standalone-alert:list [flags]

Lists all alerts for standalone Mules in the current environment.

This command accepts the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.

This command also accepts the default flag --help.

runtime-mgr:standalone-alert:modify

> runtime-mgr:standalone-alert:modify <alertId> [flags]

Modifies the alert passed in alertId.

In addition to the default flag --help, this command accepts the following flags:

Flag Description Example

--condition

Alert trigger condition

--condition server-load-average

--content <string>

Alert notification email body

--content Email Body

--email

Email address to send alert notification to
Can be used multiple times to specify up to 20 email addresses

--email user@mulesoft.com

--name

Alert name

--name testAlert

--operator

Condition operator explaining values relation to threshold.

--operator lt-

--period

Condition duration in minutes

--period 15

--recipient

Username to send alert notification to
Can be used multiple times to specify up to 20 platform user IDs

--recipient 1fec0a49-1551-4199-bfcc-cf0352d0f29d

--resource

Alert resource ID. If not provided alert triggers for all resources. Depending on resourceType, the resource id can be of an application, server, server-group or cluster.

--resource 12343

--resourceType

Alert resource type

--resourceType server

--severity

Alert severity

--severity 3

--subject <string>

Alert notification email subject

--subject Email Subject

--threshold

Condition threshold number

--threshold 10

This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter.