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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Statusio_maintenance

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

• #all_infrastructure_affected ⇒ :yes, ...

  If it affects all components and containers.

• #api_id ⇒ String

  Your unique API ID from status.io.

• #api_key ⇒ String

  Your unique API Key from status.io.

• #automation ⇒ :yes, ...

  Automatically start and end the maintenance window.

• #components ⇒ Array<String>, ...

  The given name of your component (server name).

• #containers ⇒ Object^?

  The given name of your container (data center).

• #desc ⇒ String^?

  Message describing the maintenance window.

• #maintenance_id ⇒ String^?

  The maintenance id number when deleting a maintenance window.

• #maintenance_notify_1_hr ⇒ :yes, ...

  Notify subscribers 1 hour before maintenance start time.

• #maintenance_notify_24_hr ⇒ :yes, ...

  Notify subscribers 24 hours before maintenance start time.

• #maintenance_notify_72_hr ⇒ :yes, ...

  Notify subscribers 72 hours before maintenance start time.

• #maintenance_notify_now ⇒ :yes, ...

  Notify subscribers now.

• #minutes ⇒ Integer^?

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

• #start_date ⇒ String^?

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

• #start_time ⇒ Integer^?

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

• #state ⇒ :present, ...

  Desired state of the package.

• #statuspage ⇒ String

  Your unique StatusPage ID from status.io.

• #title ⇒ String^?

  A descriptive title for the maintenance window.

• #url ⇒ String^?

  Status.io API URL.

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, ...

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

attribute :all_infrastructure_affected

#api_id ⇒ String

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

attribute :api_id

#api_key ⇒ String

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

attribute :api_key

#automation ⇒ :yes, ...

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

attribute :automation

#components ⇒ Array<String>, ...

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

attribute :components

#containers ⇒ Object^?

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

attribute :containers

#desc ⇒ String^?

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

attribute :desc

#maintenance_id ⇒ String^?

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

attribute :maintenance_id

#maintenance_notify_1_hr ⇒ :yes, ...

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

attribute :maintenance_notify_1_hr

#maintenance_notify_24_hr ⇒ :yes, ...

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

attribute :maintenance_notify_24_hr

#maintenance_notify_72_hr ⇒ :yes, ...

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

attribute :maintenance_notify_72_hr

#maintenance_notify_now ⇒ :yes, ...

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

attribute :maintenance_notify_now

#minutes ⇒ Integer^?

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

attribute :minutes

#start_date ⇒ String^?

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

attribute :start_date

#start_time ⇒ Integer^?

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

attribute :start_time

#state ⇒ :present, ...

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

attribute :state

#statuspage ⇒ String

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

attribute :statuspage

#title ⇒ String^?

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

attribute :title

#url ⇒ String^?

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

attribute :url