community.general.znode module – Create, delete, retrieve, and update znodes using ZooKeeper
Note
This module is part of the community.general collection (version 9.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.znode
.
Synopsis
Create, delete, retrieve, and update znodes using ZooKeeper.
Requirements
The below requirements are needed on the host that executes this module.
kazoo >= 2.1
Parameters
Parameter |
Comments |
---|---|
The authentication credential value. Depends on The format for |
|
Authentication scheme. Choices:
|
|
A list of ZooKeeper servers (format ‘[server]:[port]’). |
|
The path of the znode. |
|
An operation to perform. Mutually exclusive with state. Choices:
|
|
Recursively delete node and all its children. Choices:
|
|
The state to enforce. Mutually exclusive with op. Choices:
|
|
The amount of time to wait for a node to appear. Default: |
|
Using TLS/SSL or not. Choices:
|
|
The value assigned to the znode. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Creating or updating a znode with a given value
community.general.znode:
hosts: 'localhost:2181'
name: /mypath
value: myvalue
state: present
- name: Getting the value and stat structure for a znode
community.general.znode:
hosts: 'localhost:2181'
name: /mypath
op: get
- name: Getting the value and stat structure for a znode using digest authentication
community.general.znode:
hosts: 'localhost:2181'
auth_credential: 'user1:s3cr3t'
name: /secretmypath
op: get
- name: Listing a particular znode's children
community.general.znode:
hosts: 'localhost:2181'
name: /zookeeper
op: list
- name: Waiting 20 seconds for a znode to appear at path /mypath
community.general.znode:
hosts: 'localhost:2181'
name: /mypath
op: wait
timeout: 20
- name: Deleting a znode at path /mypath
community.general.znode:
hosts: 'localhost:2181'
name: /mypath
state: absent
- name: Creating or updating a znode with a given value on a remote Zookeeper
community.general.znode:
hosts: 'my-zookeeper-node:2181'
name: /mypath
value: myvalue
state: present
delegate_to: 127.0.0.1