Class: Ansible::Ruby::Modules::Pagerduty

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb

Overview

This module will let you create PagerDuty maintenance windows

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#desc ⇒ String?

Returns Short description of maintenance window.

Returns:

  • (String, nil) —

    Short description of maintenance window.



47
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 47

attribute :desc

#hours ⇒ Integer?

Returns Length of maintenance window in hours.

Returns:

  • (Integer, nil) —

    Length of maintenance window in hours.



39
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 39

attribute :hours

#minutes ⇒ Integer?

Returns Maintenance window in minutes (this is added to the hours).

Returns:

  • (Integer, nil) —

    Maintenance window in minutes (this is added to the hours).



43
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 43

attribute :minutes

#name ⇒ String?

Returns PagerDuty unique subdomain. Obsolete. It is not used with PagerDuty REST v2 API.

Returns:

  • (String, nil) —

    PagerDuty unique subdomain. Obsolete. It is not used with PagerDuty REST v2 API.



16
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 16

attribute :name

#requester_id ⇒ Object?

Returns ID of user making the request. Only needed when creating a maintenance_window.

Returns:

  • (Object, nil) —

    ID of user making the request. Only needed when creating a maintenance_window.



28
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 28

attribute :requester_id

#service ⇒ String?

Returns A comma separated list of PagerDuty service IDs.

Returns:

  • (String, nil) —

    A comma separated list of PagerDuty service IDs.



31
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 31

attribute :service

#state ⇒ :running, ...

Returns Create a maintenance window or get a list of ongoing windows.

Returns:

  • (:running, :started, :ongoing, :absent) —

    Create a maintenance window or get a list of ongoing windows.



12
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 12

attribute :state

#token ⇒ String

Returns A pagerduty token, generated on the pagerduty site. It is used for authorization.

Returns:

  • (String) —

    A pagerduty token, generated on the pagerduty site. It is used for authorization.



24
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 24

attribute :token

#user ⇒ String?

Returns PagerDuty user ID. Obsolete. Please, use I(token) for authorization.

Returns:

  • (String, nil) —

    PagerDuty user ID. Obsolete. Please, use I(token) for authorization.



20
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 20

attribute :user

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

  • (:yes, :no, nil) —

    If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.



51
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 51

attribute :validate_certs

#window_id ⇒ String?

Returns ID of maintenance window. Only needed when absent a maintenance_window.

Returns:

  • (String, nil) —

    ID of maintenance window. Only needed when absent a maintenance_window.



35
 
# File 'lib/ansible/ruby/modules/generated/monitoring/pagerduty.rb', line 35

attribute :window_id