Class: Ansible::Ruby::Modules::Oneandone_monitoring_policy

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb

Overview

Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency on 1and1 >= 1.0

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

#add_ports ⇒ Array<Hash>, ...

Returns Ports to add to the monitoring policy.

Returns:

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

    Ports to add to the monitoring policy.



55
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 55

attribute :add_ports

#add_processes ⇒ Array<Hash>, ...

Returns Processes to add to the monitoring policy.

Returns:

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

    Processes to add to the monitoring policy.



59
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 59

attribute :add_processes

#add_servers ⇒ Array<String>, ...

Returns Servers to add to the monitoring policy.

Returns:

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

    Servers to add to the monitoring policy.



63
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 63

attribute :add_servers

#agent ⇒ Boolean

Returns Set true for using agent.

Returns:

  • (Boolean) —

    Set true for using agent.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 31

attribute :agent

#api_url ⇒ Object?

Returns Custom API URL. Overrides the ONEANDONE_API_URL environement variable.

Returns:

  • (Object, nil) —

    Custom API URL. Overrides the ONEANDONE_API_URL environement variable.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 20

attribute :api_url

#auth_token ⇒ String

Returns Authenticating API token provided by 1&1.

Returns:

  • (String) —

    Authenticating API token provided by 1&1.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 16

attribute :auth_token

#description ⇒ String?

Returns Monitoring policy description. maxLength=256.

Returns:

  • (String, nil) —

    Monitoring policy description. maxLength=256



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 39

attribute :description

#email ⇒ String

Returns User’s email. maxLength=128.

Returns:

  • (String) —

    User’s email. maxLength=128



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 35

attribute :email

#monitoring_policy ⇒ String

Returns The identifier (id or name) of the monitoring policy used with update state.

Returns:

  • (String) —

    The identifier (id or name) of the monitoring policy used with update state.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 27

attribute :monitoring_policy

#name ⇒ String

Returns Monitoring policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128.

Returns:

  • (String) —

    Monitoring policy name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 23

attribute :name

#ports ⇒ Array<Hash>, Hash

Returns Array of ports that will be monitoring.

Returns:

  • (Array<Hash>, Hash) —

    Array of ports that will be monitoring.



47
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 47

attribute :ports

#processes ⇒ Array<Hash>, Hash

Returns Array of processes that will be monitoring.

Returns:

  • (Array<Hash>, Hash) —

    Array of processes that will be monitoring.



51
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 51

attribute :processes

#remove_ports ⇒ Array<String>, ...

Returns Ports to remove from the monitoring policy.

Returns:

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

    Ports to remove from the monitoring policy.



67
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 67

attribute :remove_ports

#remove_processes ⇒ Array<String>, ...

Returns Processes to remove from the monitoring policy.

Returns:

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

    Processes to remove from the monitoring policy.



71
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 71

attribute :remove_processes

#remove_servers ⇒ Array<String>, ...

Returns Servers to remove from the monitoring policy.

Returns:

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

    Servers to remove from the monitoring policy.



75
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 75

attribute :remove_servers

#state ⇒ :present, ...

Returns Define a monitoring policy’s state to create, remove, update.

Returns:

  • (:present, :absent, :update, nil) —

    Define a monitoring policy’s state to create, remove, update.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 12

attribute :state

#thresholds ⇒ Array<Hash>, Hash

Returns Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when the value is exceeded.

Returns:

  • (Array<Hash>, Hash) —

    Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when the value is exceeded.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 43

attribute :thresholds

#update_ports ⇒ Array<Hash>, ...

Returns Ports to be updated on the monitoring policy.

Returns:

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

    Ports to be updated on the monitoring policy.



79
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 79

attribute :update_ports

#update_processes ⇒ Array<Hash>, ...

Returns Processes to be updated on the monitoring policy.

Returns:

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

    Processes to be updated on the monitoring policy.



83
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 83

attribute :update_processes

#wait ⇒ :yes, ...

Returns wait for the instance to be in state ‘running’ before returning.

Returns:

  • (:yes, :no, nil) —

    wait for the instance to be in state ‘running’ before returning



87
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 87

attribute :wait

#wait_interval ⇒ Integer?

Returns Defines the number of seconds to wait when using the _wait_for methods.

Returns:

  • (Integer, nil) —

    Defines the number of seconds to wait when using the _wait_for methods



95
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 95

attribute :wait_interval

#wait_timeout ⇒ Integer?

Returns how long before wait gives up, in seconds.

Returns:

  • (Integer, nil) —

    how long before wait gives up, in seconds



91
 
# File 'lib/ansible/ruby/modules/generated/cloud/oneandone/oneandone_monitoring_policy.rb', line 91

attribute :wait_timeout