Class: Ansible::Ruby::Modules::Grafana_dashboard

Inherits:

Base

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

Defined in:

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

Overview

Create, update, delete, export Grafana dashboards via API.

Instance Method Summary

• #client_cert ⇒ Object^?

  PEM formatted certificate chain file to be used for SSL client authentication.,This file can also include the key as well, and if the key is included, client_key is not required.

• #client_key ⇒ Object^?

  PEM formatted file that contains your private key to be used for SSL client,authentication.

• #grafana_api_key ⇒ Object^?

  The Grafana API key.,If set, I(grafana_user) and I(grafana_password) will be ignored.

• #message ⇒ Object^?

  Set a commit message for the version history.,Only used when C(state) is C(present).

• #org_id ⇒ Integer^?

  The Grafana Organisation ID where the dashboard will be imported / exported.,Not used when I(grafana_api_key) is set, because the grafana_api_key only belongs to one organisation..

• #overwrite ⇒ String^?

  Override existing dashboard when state is present.

• #path ⇒ Object^?

  The path to the json file containing the Grafana dashboard to import or export.

• #slug ⇒ Object^?

  Deprecated since Grafana 5.

• #state ⇒ :absent, ...

  State of the dashboard.

• #uid ⇒ Object^?

  Uid of the dasboard to export when C(state) is C(export) or C(absent).

• #url ⇒ Object

  The Grafana URL.

• #url_password ⇒ String^?

  The Grafana API password.

• #url_username ⇒ String^?

  The Grafana API user.

• #use_proxy ⇒ String^?

  Boolean of whether or not to use proxy.

• #validate_certs ⇒ String^?

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

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#client_cert ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_dashboard.rb', line 55

attribute :client_cert

#client_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_dashboard.rb', line 58

attribute :client_key

#grafana_api_key ⇒ Object^?

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

attribute :grafana_api_key

#message ⇒ Object^?

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

attribute :message

#org_id ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_dashboard.rb', line 27

attribute :org_id

#overwrite ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_dashboard.rb', line 44

attribute :overwrite

#path ⇒ Object^?

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

attribute :path

#slug ⇒ Object^?

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

attribute :slug

#state ⇒ :absent, ...

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

attribute :state

#uid ⇒ Object^?

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

attribute :uid

#url ⇒ Object

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

attribute :url

#url_password ⇒ String^?

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

attribute :url_password

#url_username ⇒ String^?

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

attribute :url_username

#use_proxy ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_dashboard.rb', line 61

attribute :use_proxy

#validate_certs ⇒ String^?

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

attribute :validate_certs