community / community.mongodb / 1.7.3 / module / mongodb_shard_zone Manage Shard Zones. | "added in version" 1.3.0 of community.mongodb" Authors: Rhys Campbell (@rhysmeister)community.mongodb.mongodb_shard_zone (1.7.3) — module
Install with ansible-galaxy collection install community.mongodb:==1.7.3
collections: - name: community.mongodb version: 1.7.3
Manage Shard Zones.
Add and remove shard zones.
- name: Add a shard zone for NYC community.mongodb.mongodb_shard_zone: name: "NYC" namespace: "records.users" ranges: - [{ zipcode: "10001" }, { zipcode: "10281" }] - [{ zipcode: "11201" }, { zipcode: "11240" }] state: "present"
- name: Remove all zone ranges community.mongodb.mongodb_shard_zone: name: "NYC" namespace: "records.users" state: "absent"
- name: Remove a specific zone range community.mongodb.mongodb_shard_zone: name: "NYC" namespace: "records.users" ranges: - [{ zipcode: "11201" }, { zipcode: "11240" }] state: "absent"
ssl: aliases: - tls default: false description: - Whether to use an SSL connection when connecting to the database. required: false type: bool name: description: - The name of the zone. required: true type: str state: choices: - present - absent default: present description: - The state of the zone. required: false type: str ranges: description: - The ranges assigned to the Zone. elements: list type: list namespace: description: - The namespace the zone is assigned to - Should be given in the form database.collection. type: str atlas_auth: default: false description: - Authentication path intended for MongoDB Atlas Instances type: bool login_host: default: localhost description: - The host running MongoDB instance to login to. required: false type: str login_port: default: 27017 description: - The MongoDB server port to login to. required: false type: int login_user: description: - The MongoDB user to login with. - Required when I(login_password) is specified. required: false type: str ssl_crlfile: description: - The ssl_crlfile option takes a path to a CRL file. required: false type: str ssl_keyfile: description: - Private key for the client certificate. required: false type: str ssl_ca_certs: aliases: - tlsCAFile description: - The ssl_ca_certs option takes a path to a CA file. required: false type: str ssl_certfile: aliases: - tlsCertificateKeyFile description: - Present a client certificate using the ssl_certfile option. required: false type: str ssl_cert_reqs: aliases: - tlsAllowInvalidCertificates choices: - CERT_NONE - CERT_OPTIONAL - CERT_REQUIRED default: CERT_REQUIRED description: - Specifies whether a certificate is required from the other side of the connection, and whether it will be validated if provided. required: false type: str auth_mechanism: choices: - SCRAM-SHA-256 - SCRAM-SHA-1 - MONGODB-X509 - GSSAPI - PLAIN description: - Authentication type. required: false type: str login_database: default: admin description: - The database where login credentials are stored. required: false type: str login_password: description: - The password used to authenticate with. - Required when I(login_user) is specified. required: false type: str mongos_process: default: mongos description: - Provide a custom name for the mongos process. - Most users can ignore this setting. required: false type: str connection_options: description: - Additional connection options. - Supply as a list of dicts or strings containing key value pairs seperated with '='. elements: raw required: false type: list ssl_pem_passphrase: aliases: - tlsCertificateKeyFilePassword description: - Passphrase to decrypt encrypted private keys. required: false type: str strict_compatibility: default: true description: - Enforce strict requirements for pymongo and MongoDB software versions type: bool
changed: description: True when a change has happened returned: success type: bool failed: description: If something went wrong returned: failed type: bool msg: description: A short description of what happened. returned: failure type: str