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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb

Overview

Change an administrative parameter on a MongoDB server.

Instance Method Summary

• #database ⇒ Object

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

• #login_database ⇒ Object^?

  The database where login credentials are stored.

• #login_host ⇒ String^?

  The host running the database.

• #login_password ⇒ Object^?

  The password used to authenticate with.

• #login_port ⇒ Integer^?

  The port to connect to.

• #login_user ⇒ Object^?

  The username used to authenticate with.

• #param ⇒ String

  MongoDB administrative parameter to modify.

• #param_type ⇒ String^?

  Define the parameter value (str, int).

• #replica_set ⇒ Object^?

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

• #ssl ⇒ Boolean^?

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

• #value ⇒ String

  MongoDB administrative parameter value to set.

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

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

attribute :database

#login_database ⇒ Object^?

Returns The database where login credentials are stored.

Returns:

• (Object, nil) —

  The database where login credentials are stored

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 25

attribute :login_database

#login_host ⇒ String^?

Returns The host running the database.

Returns:

• (String, nil) —

  The host running the database

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 17

attribute :login_host

#login_password ⇒ Object^?

Returns The password used to authenticate with.

Returns:

• (Object, nil) —

  The password used to authenticate with

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 14

attribute :login_password

#login_port ⇒ Integer^?

Returns The port to connect to.

Returns:

• (Integer, nil) —

  The port to connect to

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 21

attribute :login_port

#login_user ⇒ Object^?

Returns The username used to authenticate with.

Returns:

• (Object, nil) —

  The username used to authenticate with

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

attribute :login_user

#param ⇒ String

Returns MongoDB administrative parameter to modify.

Returns:

• (String) —

  MongoDB administrative parameter to modify

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 39

attribute :param

#param_type ⇒ String^?

Returns Define the parameter value (str, int).

Returns:

• (String, nil) —

  Define the parameter value (str, int)

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 47

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)

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 28

attribute :replica_set

#ssl ⇒ Boolean^?

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

Returns:

• (Boolean, nil) —

  Whether to use an SSL connection when connecting to the database

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 35

attribute :ssl

#value ⇒ String

Returns MongoDB administrative parameter value to set.

Returns:

• (String) —

  MongoDB administrative parameter value to set

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_parameter.rb', line 43

attribute :value