Class: Ansible::Ruby::Modules::Statusio_maintenance

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

Overview

Creates a maintenance window for status.io Deletes a maintenance window for status.io

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

#all_infrastructure_affected ⇒ :yes, ...

Returns If it affects all components and containers.

Returns:

  • (:yes, :no, nil) —

    If it affects all components and containers



48
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 48

attribute :all_infrastructure_affected

#api_id ⇒ String

Returns Your unique API ID from status.io.

Returns:

  • (String) —

    Your unique API ID from status.io



25
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 25

attribute :api_id

#api_key ⇒ String

Returns Your unique API Key from status.io.

Returns:

  • (String) —

    Your unique API Key from status.io



29
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 29

attribute :api_key

#automation ⇒ :yes, ...

Returns Automatically start and end the maintenance window.

Returns:

  • (:yes, :no, nil) —

    Automatically start and end the maintenance window



52
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 52

attribute :automation

#components ⇒ Array<String>, ...

Returns The given name of your component (server name).

Returns:

  • (Array<String>, String, nil) —

    The given name of your component (server name)



41
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 41

attribute :components

#containers ⇒ Object?

Returns The given name of your container (data center).

Returns:

  • (Object, nil) —

    The given name of your container (data center)



45
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 45

attribute :containers

#desc ⇒ String?

Returns Message describing the maintenance window.

Returns:

  • (String, nil) —

    Message describing the maintenance window



17
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 17

attribute :desc

#maintenance_id ⇒ String?

Returns The maintenance id number when deleting a maintenance window.

Returns:

  • (String, nil) —

    The maintenance id number when deleting a maintenance window



72
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 72

attribute :maintenance_id

#maintenance_notify_1_hr ⇒ :yes, ...

Returns Notify subscribers 1 hour before maintenance start time.

Returns:

  • (:yes, :no, nil) —

    Notify subscribers 1 hour before maintenance start time



68
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 68

attribute :maintenance_notify_1_hr

#maintenance_notify_24_hr ⇒ :yes, ...

Returns Notify subscribers 24 hours before maintenance start time.

Returns:

  • (:yes, :no, nil) —

    Notify subscribers 24 hours before maintenance start time



64
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 64

attribute :maintenance_notify_24_hr

#maintenance_notify_72_hr ⇒ :yes, ...

Returns Notify subscribers 72 hours before maintenance start time.

Returns:

  • (:yes, :no, nil) —

    Notify subscribers 72 hours before maintenance start time



60
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 60

attribute :maintenance_notify_72_hr

#maintenance_notify_now ⇒ :yes, ...

Returns Notify subscribers now.

Returns:

  • (:yes, :no, nil) —

    Notify subscribers now



56
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 56

attribute :maintenance_notify_now

#minutes ⇒ Integer?

Returns The length of time in UTC that the maintenance will run (starting from playbook runtime).

Returns:

  • (Integer, nil) —

    The length of time in UTC that the maintenance will run (starting from playbook runtime)



76
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 76

attribute :minutes

#start_date ⇒ String?

Returns Date maintenance is expected to start (Month/Day/Year) (UTC),End Date is worked out from start_date + minutes.

Returns:

  • (String, nil) —

    Date maintenance is expected to start (Month/Day/Year) (UTC),End Date is worked out from start_date + minutes



80
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 80

attribute :start_date

#start_time ⇒ Integer?

Returns Time maintenance is expected to start (Hour:Minutes) (UTC),End Time is worked out from start_time + minutes.

Returns:

  • (Integer, nil) —

    Time maintenance is expected to start (Hour:Minutes) (UTC),End Time is worked out from start_time + minutes



84
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 84

attribute :start_time

#state ⇒ :present, ...

Returns Desired state of the package.

Returns:

  • (:present, :absent, nil) —

    Desired state of the package.



21
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 21

attribute :state

#statuspage ⇒ String

Returns Your unique StatusPage ID from status.io.

Returns:

  • (String) —

    Your unique StatusPage ID from status.io



33
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 33

attribute :statuspage

#title ⇒ String?

Returns A descriptive title for the maintenance window.

Returns:

  • (String, nil) —

    A descriptive title for the maintenance window



13
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 13

attribute :title

#url ⇒ String?

Returns Status.io API URL. A private apiary can be used instead.

Returns:

  • (String, nil) —

    Status.io API URL. A private apiary can be used instead.



37
 
# File 'lib/ansible/ruby/modules/generated/monitoring/statusio_maintenance.rb', line 37

attribute :url