notification_templates#
usage: awx notification_templates [-h] action ...
positional arguments:
action
list
create
get
modify
delete
options:
-h, --help show this help message and exit
awx notification_templates: the following arguments are required: action
notification_templates list#
usage: awx notification_templates list [-h] [--all] [--order_by ORDER_BY] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v]
[--type {notification_template}] [--created CREATED] [--modified MODIFIED] [--name TEXT] [--description TEXT]
[--organization ID] [--notification_type {awssns,email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}]
[--notification_configuration JSON/YAML] [--messages JSON/YAML]
options:
-h, --help show this help message and exit
--all fetch all pages of content from the API when returning results (instead of just the first page)
--order_by ORDER_BY order results by given field name, prefix the field name with a dash (-) to sort in reverse eg --order_by='-name',multiple sorting fields may
be specified by separating the field names with a comma (,)
--type {notification_template}
only list notification_templates with the specified type
--created CREATED only list notification_templates with the specified created
--modified MODIFIED only list notification_templates with the specified modified
--name TEXT only list notification_templates with the specified name
--description TEXT only list notification_templates with the specified description
--organization ID only list notification_templates with the specified organization
--notification_type {awssns,email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}
only list notification_templates with the specified notification_type
--notification_configuration JSON/YAML
only list notification_templates with the specified notification_configuration
--messages JSON/YAML only list notification_templates with the specified messages
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
notification_templates create#
usage: awx notification_templates create [-h] --name TEXT [--description TEXT] --organization ID --notification_type
{awssns,email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook} [--notification_configuration JSON/YAML]
[--messages JSON/YAML]
required arguments:
--name TEXT Name of this notification template.
--organization ID the ID of the associated organization
--notification_type {awssns,email,grafana,irc,mattermost,pagerduty,rocketchat,slack,twilio,webhook}
options:
-h, --help show this help message and exit
--description TEXT Optional description of this notification template.
--notification_configuration JSON/YAML
a JSON or YAML string. You can optionally specify a file path e.g., @path/to/file.yml
--messages JSON/YAML Optional custom messages for notification template. You can optionally specify a file path e.g., @path/to/file.yml
awx notification_templates create: the following arguments are required: --name, --organization, --notification_type
notification_templates get#
usage: awx notification_templates get [-h] [-f {json,yaml,jq,human}] [--filter TEXT] [--conf.color BOOLEAN] [-v] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
input/output formatting:
-f {json,yaml,jq,human}, --conf.format {json,yaml,jq,human}
specify a format for the input and output
--filter TEXT specify an output filter (only valid with jq or human format)
--conf.color BOOLEAN Display colorized output. Defaults to True
-v, --verbose print debug-level logs, including requests made
awx notification_templates get: the following arguments are required: id
notification_templates modify#
usage: awx notification_templates modify [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx notification_templates modify: the following arguments are required: id
notification_templates delete#
usage: awx notification_templates delete [-h] id
positional arguments:
id the ID (or unique name) of the resource
options:
-h, --help show this help message and exit
awx notification_templates delete: the following arguments are required: id