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

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

Overview

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

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

#client_cert ⇒ Object?

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

Returns:

  • (Object, nil) —

    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



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

attribute :client_cert

#client_key ⇒ Object?

Returns PEM formatted file that contains your private key to be used for SSL client,authentication. If client_cert contains both the certificate and key, this option is not required.

Returns:

  • (Object, nil) —

    PEM formatted file that contains your private key to be used for SSL client,authentication. If client_cert contains both the certificate and key, this option is not required



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

attribute :client_key

#grafana_api_key ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :grafana_api_key

#message ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :message

#org_id ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :org_id

#overwrite ⇒ :yes, ...

Returns Override existing dashboard when state is present.

Returns:

  • (:yes, :no, nil) —

    Override existing dashboard when state is present.



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

attribute :overwrite

#path ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :path

#slug ⇒ Object?

Returns Deprecated since Grafana 5. Use grafana dashboard uid instead.,slug of the dashboard. It’s the friendly url name of the dashboard.,When C(state) is C(present), this parameter can override the slug in the meta section of the json file.,If you want to import a json dashboard exported directly from the interface (not from the api), you have to specify the slug parameter because there is no meta section in the exported json.

Returns:

  • (Object, nil) —

    Deprecated since Grafana 5. Use grafana dashboard uid instead.,slug of the dashboard. It’s the friendly url name of the dashboard.,When C(state) is C(present), this parameter can override the slug in the meta section of the json file.,If you want to import a json dashboard exported directly from the interface (not from the api), you have to specify the slug parameter because there is no meta section in the exported json.



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

attribute :slug

#state ⇒ :absent, ...

Returns State of the dashboard.

Returns:

  • (:absent, :export, :present) —

    State of the dashboard.



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

attribute :state

#uid ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :uid

#url ⇒ Object

Returns The Grafana URL.

Returns:

  • (Object) —

    The Grafana URL.



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

attribute :url

#url_password ⇒ String?

Returns The Grafana API password.

Returns:

  • (String, nil) —

    The Grafana API password.



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

attribute :url_password

#url_username ⇒ String?

Returns The Grafana API user.

Returns:

  • (String, nil) —

    The Grafana API user.



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

attribute :url_username

#use_proxy ⇒ :yes, ...

Returns Boolean of whether or not to use proxy.

Returns:

  • (:yes, :no, nil) —

    Boolean of whether or not to use proxy.



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

attribute :use_proxy

#validate_certs ⇒ :yes, ...

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



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

attribute :validate_certs