Class: Ansible::Ruby::Modules::Mongodb_user

Inherits:

Base

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

Defined in:

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

Instance Method Summary

• #database ⇒ String

  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 ⇒ String^?

  The password used to authenticate with.

• #login_port ⇒ Integer^?

  The port to connect to.

• #login_user ⇒ String^?

  The username used to authenticate with.

• #name ⇒ String

  The name of the user to add or remove.

• #password ⇒ String^?

  The password to use for the user.

• #replica_set ⇒ String^?

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

• #roles ⇒ String^?

  The database user roles valid values could either be one or more of the following strings: ‘read’, ‘readWrite’, ‘dbAdmin’, ‘userAdmin’, ‘clusterAdmin’, ‘readAnyDatabase’, ‘readWriteAnyDatabase’, ‘userAdminAnyDatabase’, ‘dbAdminAnyDatabase’,Or the following dictionary ‘{ db: DATABASE_NAME, role: ROLE_NAME }’.,This param requires pymongo 2.5+.

• #ssl ⇒ Boolean^?

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

• #state ⇒ :present, ...

  The database user state.

• #update_password ⇒ :always, ...

  C(always) will update passwords if they differ.

Methods inherited from Base

#to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#database ⇒ String

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

Returns:

• (String) —

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

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

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_user.rb', line 26

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_user.rb', line 18

attribute :login_host

#login_password ⇒ String^?

Returns The password used to authenticate with.

Returns:

• (String, nil) —

  The password used to authenticate with

# File 'lib/ansible/ruby/modules/generated/extras/database/misc/mongodb_user.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_user.rb', line 22

attribute :login_port

#login_user ⇒ String^?

Returns The username used to authenticate with.

Returns:

• (String, nil) —

  The username used to authenticate with

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

attribute :login_user

#name ⇒ String

Returns The name of the user to add or remove.

Returns:

• (String) —

  The name of the user to add or remove

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

attribute :name

#password ⇒ String^?

Returns The password to use for the user.

Returns:

• (String, nil) —

  The password to use for the user

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

attribute :password

#replica_set ⇒ String^?

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

Returns:

• (String, nil) —

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

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

attribute :replica_set

#roles ⇒ String^?

Returns The database user roles valid values could either be one or more of the following strings: ‘read’, ‘readWrite’, ‘dbAdmin’, ‘userAdmin’, ‘clusterAdmin’, ‘readAnyDatabase’, ‘readWriteAnyDatabase’, ‘userAdminAnyDatabase’, ‘dbAdminAnyDatabase’,Or the following dictionary ‘{ db: DATABASE_NAME, role: ROLE_NAME }’.,This param requires pymongo 2.5+. If it is a string, mongodb 2.4+ is also required. If it is a dictionary, mongo 2.6+ is required.

Returns:

• (String, nil) —

  The database user roles valid values could either be one or more of the following strings: ‘read’, ‘readWrite’, ‘dbAdmin’, ‘userAdmin’, ‘clusterAdmin’, ‘readAnyDatabase’, ‘readWriteAnyDatabase’, ‘userAdminAnyDatabase’, ‘dbAdminAnyDatabase’,Or the following dictionary ‘{ db: DATABASE_NAME, role: ROLE_NAME }’.,This param requires pymongo 2.5+. If it is a string, mongodb 2.4+ is also required. If it is a dictionary, mongo 2.6+ is required.

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

attribute :roles

#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_user.rb', line 45

attribute :ssl

#state ⇒ :present, ...

Returns The database user state.

Returns:

• (:present, :absent, nil) —

  The database user state

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

attribute :state

#update_password ⇒ :always, ...

Returns C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

Returns:

• (:always, :on_create, nil) —

  C(always) will update passwords if they differ. C(on_create) will only set the password for newly created users.

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

attribute :update_password