@ -17,81 +17,62 @@ DOCUMENTATION = '''
module : influxdb_user
module : influxdb_user
short_description : Manage InfluxDB users
short_description : Manage InfluxDB users
description :
description :
- Manage InfluxDB users
- Manage InfluxDB users
version_added : 2.5
version_added : 2.5
author : " Vitaliy Zhhuta (@zhhuta) "
author : " Vitaliy Zhhuta (@zhhuta) "
requirements :
requirements :
- " python >= 2.6 "
- " python >= 2.6 "
- " influxdb >= 0.9 "
- " influxdb >= 0.9 "
options :
options :
hostname :
user_name :
description :
description :
- The hostname or IP address on which InfluxDB server is listening
- Name of the user .
default : localhost
required : True
required : false
user_password :
user_name :
description :
description :
- Password to be set for the user .
- User that we want to create
required : false
default : None
admin :
required : True
description :
user_password :
- Whether the user should be in the admin role or not .
description :
default : no
- Password that we want to set for user
choices : [ yes , no ]
default : None
state :
required : false
description :
admin :
- State of the user .
description :
choices : [ present , absent ]
- specify if user should be admin
default : present
default : False
extends_documentation_fragment : influxdb
required : false
port :
description :
- The port on which InfluxDB server is listening
default : 8086
required : false
state :
description :
- Determines if the database should be created or destroyed
choices : [ ' present ' , ' absent ' ]
default : present
required : false
username :
description :
- user to auth with influxdb
default : root
required : false
password :
description :
- password to auth username with influxdb
default : root
required : false
'''
'''
EXAMPLES = '''
EXAMPLES = '''
# Example influxdb_user command from Ansible Playbooks
- name : Create a user on localhost using default login credentials
- name : Create User
influxdb_user :
influxdb_user :
user_name : " {{ influxdb_user_name}} "
user_name : john
user_password : " {{ influxdb_user_password}} "
user_password : s3cr3t
state : present
- name : Destroy User
- name : Create a user on localhost using custom login credentials
influxdb_user :
influxdb_user :
user_name : " {{ influxdb_user_name}} "
user_name : john
username : " {{ influxdb_password}} "
user_password : s3cr3t
password : " {{ influxdb_user_password }}"
login_username : " {{ influxdb_username }} "
state : absent
login_password : " {{ influxdb_password }} "
- name : Create user on dest host
- name : Create an admin user on a remote host using custom login credentials
influxdb_user :
influxdb_user :
hostname : " {{ influxdb_ip_address}} "
user_name : john
username : " {{ influxdb_username}} "
user_password : s3cr3t
password : " {{ influxdb_password}} "
admin : yes
user_name : " {{ influxdb_user_name}} "
hostname : " {{ influxdb_hostname }} "
user_password : " {{ influxdb_user_password}} "
login_username : " {{ influxdb_username }} "
admin : true
login_password : " {{ influxdb_password }} "
state : present
- name : Destroy a user using custom login credentials
influxdb_user :
user_name : john
login_username : " {{ influxdb_username }} "
login_password : " {{ influxdb_password }} "
state : absent
'''
'''
RETURN = '''
RETURN = '''