Class: Ansible::Ruby::Modules::Influxdb_database

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb

Overview

Manage InfluxDB databases

Instance Method Summary collapse

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

#database_name ⇒ String

Returns Name of the database that will be created/destroyed.

Returns:

  • (String) —

    Name of the database that will be created/destroyed



27
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 27

attribute :database_name

#hostname ⇒ String

Returns The hostname or IP address on which InfluxDB server is listening.

Returns:

  • (String) —

    The hostname or IP address on which InfluxDB server is listening



11
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 11

attribute :hostname

#password ⇒ String?

Returns Password that will be used to authenticate against InfluxDB server.

Returns:

  • (String, nil) —

    Password that will be used to authenticate against InfluxDB server



19
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 19

attribute :password

#port ⇒ Integer?

Returns The port on which InfluxDB server is listening.

Returns:

  • (Integer, nil) —

    The port on which InfluxDB server is listening



23
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 23

attribute :port

#state ⇒ :present, ...

Returns Determines if the database should be created or destroyed.

Returns:

  • (:present, :absent, nil) —

    Determines if the database should be created or destroyed



31
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 31

attribute :state

#username ⇒ String?

Returns Username that will be used to authenticate against InfluxDB server.

Returns:

  • (String, nil) —

    Username that will be used to authenticate against InfluxDB server



15
 
# File 'lib/ansible/ruby/modules/generated/extras/database/influxdb/influxdb_database.rb', line 15

attribute :username