Synopsis

Manage Shard Tags..

Add and remove shard tags.

Requirements

The below requirements are needed on the host that executes this module.

• pymongo

Parameters

name (True, str, None)

The name of the tag.

shard (True, str, None)

The name of the shard to assign or remove the tag from.

state (False, str, present)

The state of the zone.

mongos_process (False, str, mongos)

Provide a custom name for the mongos process.

Most users can ignore this setting.

login_user (False, str, None)

The MongoDB user to login with.

Required when login_password is specified.

login_password (False, str, None)

The password used to authenticate with.

Required when login_user is specified.

login_database (False, str, admin)

The database where login credentials are stored.

login_host (False, str, localhost)

The host running MongoDB instance to login to.

login_port (False, int, 27017)

The MongoDB server port to login to.

strict_compatibility (optional, bool, True)

Enforce strict requirements for pymongo and MongoDB software versions

ssl (False, bool, False)

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

ssl_cert_reqs (False, str, CERT_REQUIRED)

Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided.

ssl_ca_certs (False, str, None)

The ssl_ca_certs option takes a path to a CA file.

ssl_crlfile (False, str, None)

The ssl_crlfile option takes a path to a CRL file.

ssl_certfile (False, str, None)

Present a client certificate using the ssl_certfile option.

ssl_keyfile (False, str, None)

Private key for the client certificate.

ssl_pem_passphrase (False, str, None)

Passphrase to decrypt encrypted private keys.

auth_mechanism (False, str, None)

Authentication type.

connection_options (False, list, None)

Additional connection options.

Supply as a list of dicts or strings containing key value pairs seperated with '='.

Notes

Examples

- name: Add the NYC tag to a shard called rs0
  community.mongodb.mongodb_shard_tag:
    name: "NYC"
    shard: "rs0"
    state: "present"

- name: Remove the NYC tag from rs0
  community.mongodb.mongodb_shard_tag:
    name: "NYC"
    shard: "rs0"
    state: "absent"

Return Values

changed (success, bool, )

True when a change has happened

msg (failure, str, )

A short description of what happened.

failed (failed, bool, )

If something went wrong

Status