Class: Ansible::Ruby::Modules::Bigpanda

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/monitoring/bigpanda.rb

Overview

Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.

Instance Method Summary

• #component ⇒ String

  The name of the component being deployed.

• #description ⇒ Object^?

  Free text description of the deployment.

• #env ⇒ Object^?

  The environment name, typically ‘production’, ‘staging’, etc.

• #hosts ⇒ String^?

  Name of affected host name.

• #owner ⇒ Object^?

  The person responsible for the deployment.

• #state ⇒ :started, ...

  State of the deployment.

• #token ⇒ String

  API token.

• #url ⇒ String^?

  Base URL of the API server.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates for the target url will not be validated.

• #version ⇒ String

  The deployment version.

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

#component ⇒ String

Returns The name of the component being deployed. Ex: billing.

Returns:

• (String) —

  The name of the component being deployed. Ex: billing

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

attribute :component

#description ⇒ Object^?

Returns Free text description of the deployment.

Returns:

• (Object, nil) —

  Free text description of the deployment.

# File 'lib/ansible/ruby/modules/generated/monitoring/bigpanda.rb', line 38

attribute :description

#env ⇒ Object^?

Returns The environment name, typically ‘production’, ‘staging’, etc.

Returns:

• (Object, nil) —

  The environment name, typically ‘production’, ‘staging’, etc.

# File 'lib/ansible/ruby/modules/generated/monitoring/bigpanda.rb', line 32

attribute :env

#hosts ⇒ String^?

Returns Name of affected host name. Can be a list.

Returns:

• (String, nil) —

  Name of affected host name. Can be a list.

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

attribute :hosts

#owner ⇒ Object^?

Returns The person responsible for the deployment.

Returns:

• (Object, nil) —

  The person responsible for the deployment.

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

attribute :owner

#state ⇒ :started, ...

Returns State of the deployment.

Returns:

• (:started, :finished, :failed) —

  State of the deployment.

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

attribute :state

#token ⇒ String

Returns API token.

Returns:

• (String) —

  API token.

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

attribute :token

#url ⇒ String^?

Returns Base URL of the API server.

Returns:

• (String, nil) —

  Base URL of the API server.

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

attribute :url

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates for the target url 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 for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.

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

attribute :validate_certs

#version ⇒ String

Returns The deployment version.

Returns:

• (String) —

  The deployment version.

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

attribute :version