Class: Ansible::Ruby::Modules::Grafana_datasource

Inherits:

Base

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

Defined in:

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

Overview

Create/update/delete Grafana datasources via API.

Instance Method Summary

• #access ⇒ :direct, ...

  The access mode for this datasource.

• #basic_auth_password ⇒ String^?

  The datasource basic auth password, when C(basic auth) is C(yes).

• #basic_auth_user ⇒ String^?

  The datasource basic auth user.,Setting this option with basic_auth_password will enable basic auth.

• #database ⇒ String^?

  Name of the database for the datasource.,This options is required when the C(ds_type) is C(influxdb), C(elasticsearch) (index name), C(mysql) or C(postgres).

• #ds_type ⇒ :graphite, ...

  The type of the datasource.

• #es_version ⇒ 2, ...

  Elasticsearch version (for C(ds_type = elasticsearch) only),Version 56 is for elasticsearch 5.6+ where tou can specify the C(max_concurrent_shard_requests) option.

• #grafana_api_key ⇒ Object^?

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

• #grafana_password ⇒ String^?

  The Grafana API password.

• #grafana_url ⇒ String

  The Grafana URL.

• #grafana_user ⇒ String^?

  The Grafana API user.

• #interval ⇒ :"", ...

  For elasticsearch C(ds_type), this is the index pattern used.

• #is_default ⇒ :yes, ...

  Make this datasource the default one.

• #max_concurrent_shard_requests ⇒ Integer^?

  Starting with elasticsearch 5.6, you can specify the max concurrent shard per requests.

• #name ⇒ String

  The name of the datasource.

• #org_id ⇒ Integer^?

  Grafana Organisation ID in which the datasource should be created.,Not used when C(grafana_api_key) is set, because the C(grafana_api_key) only belong to one organisation.

• #password ⇒ Object^?

  The datasource password.

• #sslmode ⇒ :disable, ...

  SSL mode for C(postgres) datasoure type.

• #state ⇒ :absent, ...

  Status of the datasource.

• #time_field ⇒ String^?

  Name of the time field in elasticsearch ds.,For example C(@timestamp).

• #time_interval ⇒ String^?

  Minimum group by interval for C(influxdb) or C(elasticsearch) datasources.,for example C(>10s).

• #tls_ca_cert ⇒ String^?

  The TLS CA certificate for self signed certificates.,Only used when C(tls_client_cert) and C(tls_client_key) are set.

• #tls_client_cert ⇒ Object^?

  The client TLS certificate.,If C(tls_client_cert) and C(tls_client_key) are set, this will enable TLS authentication.,Starts with —– BEGIN CERTIFICATE —–.

• #tls_client_key ⇒ Object^?

  The client TLS private key,Starts with —– BEGIN RSA PRIVATE KEY —–.

• #tls_skip_verify ⇒ Symbol^?

  Skip the TLS datasource certificate verification.

• #trends ⇒ Symbol^?

  Use trends or not for zabbix datasource type.

• #tsdb_resolution ⇒ :millisecond, ...

  The opentsdb time resolution.

• #tsdb_version ⇒ 1, ...

  The opentsdb version.,Use C(1) for <=2.1, C(2) for ==2.2, C(3) for ==2.3.

• #url ⇒ String

  The URL of the datasource.

• #user ⇒ Object^?

  The datasource login user for influxdb datasources.

• #validate_certs ⇒ :yes, ...

  Whether to validate the Grafana certificate.

• #with_credentials ⇒ :yes, ...

  Whether credentials such as cookies or auth headers should be sent with cross-site requests.

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

#access ⇒ :direct, ...

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

attribute :access

#basic_auth_password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 57

attribute :basic_auth_password

#basic_auth_user ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 53

attribute :basic_auth_user

#database ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 43

attribute :database

#ds_type ⇒ :graphite, ...

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

attribute :ds_type

#es_version ⇒ 2, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 91

attribute :es_version

#grafana_api_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 40

attribute :grafana_api_key

#grafana_password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 36

attribute :grafana_password

#grafana_url ⇒ String

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

attribute :grafana_url

#grafana_user ⇒ String^?

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

attribute :grafana_user

#interval ⇒ :"", ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 107

attribute :interval

#is_default ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 79

attribute :is_default

#max_concurrent_shard_requests ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 95

attribute :max_concurrent_shard_requests

#name ⇒ String

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

attribute :name

#org_id ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 83

attribute :org_id

#password ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 50

attribute :password

#sslmode ⇒ :disable, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 119

attribute :sslmode

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 87

attribute :state

#time_field ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 99

attribute :time_field

#time_interval ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 103

attribute :time_interval

#tls_ca_cert ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 71

attribute :tls_ca_cert

#tls_client_cert ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 65

attribute :tls_client_cert

#tls_client_key ⇒ Object^?

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

attribute :tls_client_key

#tls_skip_verify ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 75

attribute :tls_skip_verify

#trends ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 123

attribute :trends

#tsdb_resolution ⇒ :millisecond, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 115

attribute :tsdb_resolution

#tsdb_version ⇒ 1, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 111

attribute :tsdb_version

#url ⇒ String

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

attribute :url

#user ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 47

attribute :user

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/monitoring/grafana_datasource.rb', line 127

attribute :validate_certs

#with_credentials ⇒ :yes, ...

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

attribute :with_credentials