Class: Ansible::Ruby::Modules::Mongodb_parameter

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb

Overview

Change an administrative parameter on a MongoDB server.

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

#database ⇒ Object

Returns The name of the database to add/remove the user from.

Returns:

  • (Object) —

    The name of the database to add/remove the user from



32
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 32

attribute :database

#login_database ⇒ Object?

Returns The database where login credentials are stored.

Returns:

  • (Object, nil) —

    The database where login credentials are stored



26
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 26

attribute :login_database

#login_host ⇒ String?

Returns The host running the database.

Returns:

  • (String, nil) —

    The host running the database



18
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 18

attribute :login_host

#login_password ⇒ Object?

Returns The password used to authenticate with.

Returns:

  • (Object, nil) —

    The password used to authenticate with



15
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 15

attribute :login_password

#login_port ⇒ Integer?

Returns The port to connect to.

Returns:

  • (Integer, nil) —

    The port to connect to



22
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 22

attribute :login_port

#login_user ⇒ Object?

Returns The username used to authenticate with.

Returns:

  • (Object, nil) —

    The username used to authenticate with



12
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 12

attribute :login_user

#param ⇒ String

Returns MongoDB administrative parameter to modify.

Returns:

  • (String) —

    MongoDB administrative parameter to modify



40
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 40

attribute :param

#param_type ⇒ String?

Returns Define the parameter value (str, int).

Returns:

  • (String, nil) —

    Define the parameter value (str, int)



48
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 48

attribute :param_type

#replica_set ⇒ Object?

Returns Replica set to connect to (automatically connects to primary for writes).

Returns:

  • (Object, nil) —

    Replica set to connect to (automatically connects to primary for writes)



29
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 29

attribute :replica_set

#ssl ⇒ :yes, ...

Returns Whether to use an SSL connection when connecting to the database.

Returns:

  • (:yes, :no, nil) —

    Whether to use an SSL connection when connecting to the database



36
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 36

attribute :ssl

#value ⇒ Integer

Returns MongoDB administrative parameter value to set.

Returns:

  • (Integer) —

    MongoDB administrative parameter value to set



44
 
# File 'lib/ansible/ruby/modules/generated/database/mongodb/mongodb_parameter.rb', line 44

attribute :value