MongoDB User

4 min

Resumo

Adiciona ou remove um usuário de um banco de dados MongoDB.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valores padrão	Comentários
create_for_localhost_exception	path		Este parâmetro só é útil para lidar com o tratamento especial em torno da exceção localhost. Se login_user for definido, a exceção localhost não estará ativa e este parâmetro não terá efeito. Se este arquivo NÃO estiver presente (e login_user não estiver definido), toque neste arquivo após adicionar o usuário com sucesso. Se este arquivo estiver presente (e login_user não estiver definido), pule esta tarefa.
database	string		O nome do banco de dados para adicionar/remover o usuário. aliases: db
name	string		O nome do usuário a ser adicionado ou removido. aliases: user
password	string		A senha a ser usada pelo usuário. aliases: pass
replica_set	string		Conjunto de réplicas para conexão (conecta-se automaticamente ao primário para gravações).
roles	list		Os valores válidos das funções de usuário do banco de dados podem ser uma ou mais das seguintes strings: 'read', 'readWrite', 'dbAdmin', 'userAdmin', 'clusterAdmin', 'readAnyDatabase', 'readWriteAnyDatabase', 'userAdminAnyDatabase', ' dbAdminAnyDatabase'Ou o seguinte dicionário '{db: DATABASE_NAME, role: ROLE_NAME}'. Se for uma string, mongodb 2.4+ é necessário. Se for um dicionário, é necessário o mongo 2.6+.
state	string	Escolhas: absent present (padrão)	O estado do usuário do banco de dados.
update_password	string	Escolhas: always (padrão) on_create	always sempre atualizará as senhas e fará com que o módulo retorne alterado. on_create só definirá a senha para usuários recém-criados. Isso deve ser sempre para usar a exceção localhost ao adicionar o primeiro usuário administrador

Extende fragmentos da documentação do módulo MongoDB Login options e MongoDB SSL options.

Exemplos

- name: Crie o usuário do banco de dados 'burgers' com o nome 'bob' e a senha '12345'.
  mongodb_user:
    database: burgers
    name: bob
    password: 12345
    state: present

- name: Crie um usuário de banco de dados via SSL (MongoDB deve ser compilado com a opção SSL e configurado corretamente)
  mongodb_user:
    database: burgers
    name: bob
    password: 12345
    state: present
    ssl: True

- name: Exclua o usuário do banco de dados 'burgers' com o nome 'bob'.
  mongodb_user:
    database: burgers
    name: bob
    state: absent

- name: Defina mais usuários com vários perfis específicos (se não definido, nenhum perfil será atribuído e o usuário será adicionado via estilo anterior ao mongo 2.2)
  mongodb_user:
    database: burgers
    name: ben
    password: 12345
    roles: read
    state: present

- name: Define perfis
  mongodb_user:
    database: burgers
    name: jim
    password: 12345
    roles: readWrite,dbAdmin,userAdmin
    state: present

- name: Define perfil
  mongodb_user:
    database: burgers
    name: joe
    password: 12345
    roles: readWriteAnyDatabase
    state: present

- name: Adicionar um usuário ao banco de dados em um conjunto de réplicas, o servidor primário é localizado automaticamente e gravado
  mongodb_user:
    database: burgers
    name: bob
    replica_set: belcher
    password: 12345
    roles: readWriteAnyDatabase
    state: present

# Adiciona um usuário 'oplog_reader' com acesso somente leitura ao banco de dados 'local' no replica_set 'belcher'. Isso é útil para acesso a oplog (MONGO_OPLOG_URL).
# observe que as credenciais devem ser adicionadas ao banco de dados 'admin' porque o banco de dados 'local' não está sincronizado e não pode receber as credenciais do usuário
# Para fazer o login com esse usuário, a string de conexão deve ser MONGO_OPLOG_URL = "mongodb://oplog_reader:oplog_reader_password@server1,server2/local?AuthSource=admin"
# Esta sintaxe requer mongodb 2.6+
- name: Perfis como um dicionário
  mongodb_user:
    login_user: root
    login_password: root_password
    database: admin
    user: oplog_reader
    password: oplog_reader_password
    state: present
    replica_set: belcher
    roles:
      - db: local
        role: read

- name: Adicionar um usuário com autenticação de membro X.509
  mongodb_user:
    login_host: "mongodb-host.test"
    login_port: 27001
    login_database: "$external"
    database: "admin"
    name: "admin"
    password: "test"
    roles:
    - dbAdminAnyDatabase
    ssl: true
    ssl_ca_certs: "/tmp/ca.crt"
    ssl_certfile: "/tmp/tls.key" #certificado e chave em um arquivo
    state: present
    auth_mechanism: "MONGODB-X509"
    connection_options:
     - "tlsAllowInvalidHostnames=true"

Valores retornados

Chave	Tipo	Retornado quando	Descrição
user	string	sucesso	O nome do usuário a ser adicionado ou removido.