Maintainers Wanted
This project is looking for maintainers.
For now only pull requests of external contributors are being reviewed, accepted and welcomed. No more bug fixes or new features will be implemented.
If you are interested in contributing to this project please mention it in your PRs or add a comment in this issue
Ansible Collection - scicore.guacamole
Ansible modules to administer apache guacamole connections and users using the API
Installation
ansible-galaxy collection install scicore.guacamole
Now you can use the modules guacamole_connection and guacamole_user. Adapt the examples below to your needs.
You can find more examples in the ci-tests-playbook
Example playbook:
- name: Add a guacamole connection and user
hosts: localhost
tasks:
- name: Add a new RDP connection
scicore.guacamole.guacamole_connection:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
connection_name: test_connection
protocol: rdp
hostname: 192.168.33.43
port: 3389
username: rdp_user
password: rdp_pass
register: _connection_info
- debug:
var: _connection_info
- name: Add a new guacamole user
scicore.guacamole.guacamole_user:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
username: play_user_2
password: aaaaaaaa
full_name: "John"
email: "aaaaa@hotmail.com"
organization: "scicore"
allowed_connections:
- test_connection
register: _user_info
- debug:
var: _user_info
Output of "ansible-doc scicore.guacamole.guacamole_connection"
> SCICORE.GUACAMOLE.GUACAMOLE_CONNECTION (~/.ansible/collections/ansible_collections/scicore/guacamole/plugins/modules/guacamole_connection.py)
Add or remove guacamole connections. You can create rdp, vnc,
ssh or telnet connections
OPTIONS (= is mandatory):
= auth_password
Guacamole admin user password to login to the API
type: str
= auth_username
Guacamole admin user to login to the API
type: str
= base_url
Url to access the guacamole API
(Aliases: url)
type: str
= connection_name
Name of the new connection to create
(Aliases: name)
type: str
- group_name
Group name (parentIdentifier) where to create the connection
(Aliases: parentIdentifier)[Default: ROOT]
type: str
- hostname
Hostname or ip of the server to connect
[Default: (null)]
type: str
= max_connections
Max simultaneous connections allowed for this connection
type: int
- max_connections_per_user
Max simultaneous connections allowed per guacamole user for
this connection
[Default: (null)]
type: int
- password
Password for the connection
[Default: (null)]
type: str
- port
Port to connect
[Default: (null)]
type: int
= protocol
Protocol to use for the new connection
(Choices: rdp, vnc, ssh, telnet)
type: str
- rdp_color_depth
Color depth in bits
(Choices: 8, 16, 24, 32)[Default: (null)]
type: int
- rdp_console Sets session as admin
default: null
type: bool
- rdp_domain
Domain for the connection
[Default: (null)]
- rdp_enable_drive
Enable network drive mapping
[Default: (null)]
type: bool
- rdp_drive_name
Network drive name
[Default: (null)]
type: str
- rdp_drive_path
Path to network drive
[Default: (null)]
type: str
- rdp_enable_full_window_drag
Display whole windows when they are being dragged
[Default: (null)]
type: bool
- rdp_ignore_server_certs
Ignore rdp server certs
[Default: (null)]
type: bool
- rdp_resize_method
Resize method to use when the client display changes
(Choices: display-update, reconnect)[Default: (null)]
type: str
- rdp_security
The security mode to use for the RDP connection
(Choices: any, nla, nla-ext, tls, rdp)[Default: (null)]
type: str
- rdp_server_layout
Keyboard layout
(Choices: en-us-qwerty, en-gb-qwerty, de-ch-qwertz, de-de-
qwertz, fr-be-azerty, fr-fr-azerty, fr-ch-qwertz, hu-hu-
qwertz, it-it-qwerty, ja-jp-qwerty, pt-br-qwerty, es-es-
qwerty, es-latam-qwerty, sv-se-qwerty, tr-tr-qwerty,
failsafe)[Default: (null)]
type: str
- rdp_width
Display width
[Default: (null)]
type: int
- rdp_height
Display height
[Default: (null)]
type: int
- recording_include_keys
include keyboard events for connection
[Default: (null)]
type: bool
- recording_name
recording name for connection
[Default: (null)]
type: str
- recording_path
recording path for connection
[Default: (null)]
type: str
- sftp_default_upload_directory
File browser default upload directory
[Default: (null)]
type: str
- sftp_enable
Should we enable sftp transfers for this connection?
[Default: (null)]
type: bool
- sftp_hostname
Hostname or ip for sftp
[Default: (null)]
type: str
- sftp_passphrase
Password for the sftp private key used for authentication
[Default: (null)]
type: str
- sftp_password
Password for sftp
[Default: (null)]
type: str
- sftp_port
Port to use for sftp
[Default: (null)]
type: int
- sftp_private_key
Private key for sftp authentication
[Default: (null)]
type: str
- sftp_root_directory
File browser root directory
[Default: (null)]
type: str
- sftp_server_alive_interval
sftp keep alive interval
[Default: (null)]
type: int
- sftp_username
Username for sftp
[Default: (null)]
type: str
- ssh_passphrase
Passphrase for the SSH private key
[Default: (null)]
type: str
- ssh_private_key
Private key for the SSH connection
[Default: (null)]
type: str
- state
Create or delete the connection?
(Choices: present, absent)[Default: present]
type: str
- username
Username for the connection
[Default: (null)]
type: str
- validate_certs
Validate ssl certs?
[Default: True]
type: bool
AUTHOR: Pablo Escobar Lopez (@pescobar)
METADATA:
metadata_version: '1.1'
status:
- preview
supported_by: community
VERSION_ADDED_COLLECTION: scicore.guacamole
EXAMPLES:
- name: Create a new rdp connection
scicore.guacamole.guacamole_connection:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
connection_name: test_name_3
protocol: rdp
hostname: 192.168.33.44
port: 3389
username: rdp_user
password: rdp_pass
- name: Create a new vnc connection with sftp enabled
scicore.guacamole.guacamole_connection:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
connection_name: test_vnc
protocol: vnc
hostname: 192.168.33.44
port: 5900
username: vnc_user
password: vnc_pass
sftp_enable: true
sftp_port: 22
sftp_hostname: 192.168.11.11
sftp_server_alive_interval: 10
sftp_username: sftp_user
sftp_password: adsfadfasfdasf
- name: Delete a connection
scicore.guacamole.guacamole_connection:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
connection_name: test_CC
state: absent
RETURN VALUES:
- connection_info
Information about the created or updated connection
returned: always
type: dict
- message
Some extra info about what the module did
returned: always
type: strOutput of "ansible-doc scicore.guacamole.guacamole_user"
> SCICORE.GUACAMOLE.GUACAMOLE_USER (~/ansible/collections/ansible_collections/scicore/guacamole/plugins/modules/guacamole_user.py)
Create or delete a guacamole user
OPTIONS (= is mandatory):
- allow_access_after
Hour to allow access. Format --:--
[Default: (null)]
type: str
- allowed_connections
List of connections where this user can connect
[Default: (null)]
elements: str
type: list
= auth_password
Guacamole admin user password to login to the API
type: str
= auth_username
Guacamole admin user to login to the API
type: str
= base_url
Url to access the guacamole API
type: str
- disable_account_after
Date to disable the account in format "YYYY-MM-DD" e.g. "2020-10-23"
[Default: (null)]
type: str
- disabled
Disable the account?
[Default: (null)]
type: bool
- do_not_allow_access_after
Hour to disallow access. Format --:--
[Default: (null)]
type: str
- email
Email of the user
[Default: (null)]
type: str
- enable_account_after
Date to enable the account in format "YYYY-MM-DD" e.g. "2020-10-23"
[Default: (null)]
type: str
- expired
Is this account expired?
[Default: (null)]
type: bool
- full_name
Full name of the user
[Default: (null)]
type: str
- organization
Organization of the user
[Default: (null)]
type: str
- organizational_role
Role of the user in his/her organization
[Default: (null)]
type: str
- password
Password for the new user
[Default: (null)]
type: str
- state
Create or delete the user?
(Choices: present, absent)[Default: present]
type: str
- timezone
User timezone
[Default: (null)]
type: str
= username
Name of the new user to create
type: str
- validate_certs
Validate ssl certs?
[Default: True]
type: bool
AUTHOR: Pablo Escobar Lopez (@pescobar)
METADATA:
metadata_version: '1.1'
status:
- preview
supported_by: community
VERSION_ADDED_COLLECTION: scicore.guacamole
EXAMPLES:
- name: Create a new guacamole user
scicore.guacamole.guacamole_user:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
username: test_user_3
password: user_pass
allowed_connections:
- connection_1
- connection_2
full_name: John Foo
email: john@email.com
organization: company_bar
- name: Delete a guacamole user
scicore.guacamole.guacamole_user:
base_url: http://localhost/guacamole
validate_certs: false
auth_username: guacadmin
auth_password: guacadmin
username: test_user_3
state: absent
RETURN VALUES:
- message
Message about what the module did
returned: always
type: str
- user_info
Information about the created or updated user
returned: always
type: dictOutput of "ansible-doc scicore.guacamole.guacamole_connections_group"
> SCICORE.GUACAMOLE.GUACAMOLE_CONNECTIONS_GROUP (~/.ansible/collections/ansible_collections/scicore/guacamole/plugins/modules/guacamole_connections_group.py)
Add or remove guacamole connections groups.
OPTIONS (= is mandatory):
= auth_password
Guacamole admin user password to login to the API
type: str
= auth_username
Guacamole admin user to login to the API
type: str
= base_url
Url to access the guacamole API
(Aliases: url)
type: str
- enable_session_affinity
Enable session affinity for this group
[Default: (null)]
type: bool
- force_deletion
Force deletion of the group even if it has child connections
[Default: False]
type: bool
= group_name
Group name to create
type: str
- group_type
Choose the group type
(Choices: ORGANIZATIONAL, BALANCING)[Default: ORGANIZATIONAL]
type: str
- max_connections
Max connections in this group
[Default: (null)]
type: int
- max_connections_per_user
Max connections per user in this group
[Default: (null)]
type: int
- parent_group
Parent group in case this is a sub-group
(Aliases: parentIdentifier)[Default: ROOT]
type: str
- state
Create or delete the connections group?
(Choices: present, absent)[Default: present]
type: str
- validate_certs
Validate ssl certs?
[Default: True]
type: bool
AUTHOR: Pablo Escobar Lopez (@pescobar)
METADATA:
metadata_version: '1.1'
status:
- preview
supported_by: community
VERSION_ADDED_COLLECTION: scicore.guacamole
EXAMPLES:
- name: Create a new connections group "group_3"
scicore.guacamole.guacamole_connections_group:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
group_name: group_3
- name: Delete connections group "group_4"
scicore.guacamole.guacamole_connections_group:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
group_name: group_4
state: absent
- name: Force deletion of connections group "group_5 which has child connections"
scicore.guacamole.guacamole_connections_group:
base_url: http://localhost/guacamole
auth_username: guacadmin
auth_password: guacadmin
group_name: group_4
state: absent
force_deletion: true
RETURN VALUES:
- connections_group_info
Information about the created or updated connections group
returned: always
type: dict
- message
Some extra info about what the module did
returned: always
type: str