Ansible Role: serdigital64.security.sec_openssh_server¶
Purpose¶
Manage provisioning of OpenSSH server.
Supported features in the current version:
- Deploy application. Packages are defined in the variable
sec_openssh_server_profiles
.
The sec_openssh_server Ansible-Role is part of the A:Platform64 project and is available in the security Ansible-Collection.
Usage¶
The following example is an Ansible Playbook that includes all the supported features:
use this link if viewing the doc on github
---
- name: "Security / OpenSSH / Server / Usage example"
hosts: "localhost"
gather_facts: true
tasks:
- name: "Example: Install OpenSSH server and xAuth"
vars:
sec_openssh_server:
resolve_prereq: true
deploy: true
sec_openssh_server_options:
xauth: true
ansible.builtin.include_role:
name: "serdigital64.security.sec_openssh_server"
...
The playbook can be run by executing:
# Set ANSIBLE_COLLECTIONS_PATHS to the default install location. Change as needed.
ANSIBLE_COLLECTIONS_PATHS="${HOME}/.ansible/collections"
ansible-playbook "${ANSIBLE_COLLECTIONS_PATHS}/ansible_collections/serdigital64/security/playbooks/sec_openssh_server.yml"
Role Parameters¶
Actions¶
- Use action-parameters to control what tasks are enabled for the role to execute.
- Parameters should be declared as task level vars as they are intented to be dynamic.
sec_openssh_server:
resolve_prereq:
deploy:
Parameter | Required? | Type | Default | Purpose / Value |
---|---|---|---|---|
sec_openssh_server.resolve_prereq | no | boolean | false | Enable automatic resolution of prequisites |
sec_openssh_server.deploy | no | boolean | false | Enable installation of application package |
End State¶
- Use end-state parameters to define the target state after role execution.
- Parameters should be declared in host_vars or group_vars as they are intended to be permanent.
sec_openssh_server_application:
name:
type:
version:
installed:
sec_openssh_server_options:
xauth:
Parameter | Required? | Type | Default | Purpose / Value |
---|---|---|---|---|
sec_openssh_server_application | no | dictionary | Set application package end state | |
sec_openssh_server_application.name | no | string | "openssh_server" | Select application package name |
sec_openssh_server_application.type | no | string | "distro" | Select application package type |
sec_openssh_server_application.version | no | string | "latest" | Select application package version |
sec_openssh_server_application.installed | no | boolean | true | Set application package end state |
sec_openssh_server_options | no | dictionary | Select optional components | |
sec_openssh_server_options.xauth | no | boolean | false | Enable XAuth support |
Deployment¶
OS Compatibility¶
The operating system compatibility list is defined in the variable: sec_openssh_server_platforms
Dependencies¶
- Ansible Collections:
- serdigital64.backup
- bkp_archive
- serdigital64.system
- sys_package
- sys_repository
- serdigital64.backup
Prerequisites¶
The Ansible engine must be already installed and configured for privileged access and remote execution.
In addition the following prerequisites can be automatically solved when running the playbook by setting the role action: resolve_prereq: true
- Package manager for the target application is installed and enabled.
Installation Procedure¶
Manually install Ansible Collections from the Ansible Galaxy repository:
ansible-galaxy collection install --upgrade serdigital64.security
Automatic installation is also available by deploying A:Platform64
Contributing¶
Help on implementing new features and maintaining the code base is welcomed.
Please see the guidelines for further details.