Class: Ansible::Ruby::Modules::Pagerduty_alert
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Pagerduty_alert
- Defined in:
- lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb
Overview
This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events
Instance Method Summary collapse
-
#api_key ⇒ String
The pagerduty API key (readonly access), generated on the pagerduty site.
-
#client ⇒ String?
The name of the monitoring client that is triggering this event.
-
#client_url ⇒ String?
The URL of the monitoring client that is triggering this event.
-
#desc ⇒ String?
For C(triggered) I(state) - Required.
-
#incident_key ⇒ String?
Identifies the incident to which this I(state) should be applied.,For C(triggered) I(state) - If there’s no open (i.e. unresolved) incident with this key, a new one will be created.
-
#integration_key ⇒ String
The GUID of one of your “Generic API” services.,This is the “integration key” listed on a “Integrations” tab of PagerDuty service.
-
#name ⇒ String?
PagerDuty unique subdomain.
-
#service_id ⇒ String
ID of PagerDuty service when incidents will be triggered, acknowledged or resolved.
-
#service_key ⇒ Object?
The GUID of one of your “Generic API” services.
-
#state ⇒ :triggered, ...
Type of event to be sent.
Methods inherited from Base
Methods inherited from Ansible::Ruby::Models::Base
attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates
Constructor Details
This class inherits a constructor from Ansible::Ruby::Models::Base
Instance Method Details
#api_key ⇒ String
Returns The pagerduty API key (readonly access), generated on the pagerduty site.
31 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 31 attribute :api_key |
#client ⇒ String?
Returns The name of the monitoring client that is triggering this event.
43 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 43 attribute :client |
#client_url ⇒ String?
Returns The URL of the monitoring client that is triggering this event.
47 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 47 attribute :client_url |
#desc ⇒ String?
Returns For C(triggered) I(state) - Required. Short description of the problem that led to this trigger. This field (or a truncated version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents tables in the PagerDuty UI. The maximum length is 1024 characters.,For C(acknowledged) or C(resolved) I(state) - Text that will appear in the incident’s log associated with this event.
35 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 35 attribute :desc |
#incident_key ⇒ String?
Returns Identifies the incident to which this I(state) should be applied.,For C(triggered) I(state) - If there’s no open (i.e. unresolved) incident with this key, a new one will be created. If there’s already an open incident with a matching key, this event will be appended to that incident’s log. The event key provides an easy way to “de-dup” problem reports.,For C(acknowledged) or C(resolved) I(state) - This should be the incident_key you received back when the incident was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
39 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 39 attribute :incident_key |
#integration_key ⇒ String
Returns The GUID of one of your “Generic API” services.,This is the “integration key” listed on a “Integrations” tab of PagerDuty service.
23 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 23 attribute :integration_key |
#name ⇒ String?
Returns PagerDuty unique subdomain. Obsolete. It is not used with PagerDuty REST v2 API.
12 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 12 attribute :name |
#service_id ⇒ String
Returns ID of PagerDuty service when incidents will be triggered, acknowledged or resolved.
16 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 16 attribute :service_id |
#service_key ⇒ Object?
Returns The GUID of one of your “Generic API” services. Obsolete. Please use I(integration_key).
20 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 20 attribute :service_key |
#state ⇒ :triggered, ...
Returns Type of event to be sent.
27 |
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty_alert.rb', line 27 attribute :state |