24.6. Configuring OpenSSH clients by using the ssh RHEL system role

Procedure

1. Create a playbook file, for example, ~/playbook.yml, with the following content:

   ---
   - name: SSH client configuration
     hosts: managed-node-01.example.com
     tasks:
       - name: Configure ssh clients
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.ssh
         vars:
           ssh_user: root
           ssh:
             Compression: true
             GSSAPIAuthentication: no
             ControlMaster: auto
             ControlPath: ~/.ssh/.cm%C
             Host:
               - Condition: example
                 Hostname: server.example.com
                 User: user1
           ssh_ForwardX11: no

   The settings specified in the example playbook include the following:

   ssh_user: root

   Configures the root user’s SSH client preferences on the managed nodes with certain configuration specifics.

   Compression: true

   Compression is enabled.

   ControlMaster: auto

   ControlMaster multiplexing is set to auto.

   Host

   Creates alias example for connecting to the server.example.com host as a user called user1.

   ssh_ForwardX11: no

   X11 forwarding is disabled.

   For details about the role variables and the OpenSSH configuration options used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.ssh/README.md file and the ssh_config(5) manual page on the control node.

2. Validate the playbook syntax:

   $ ansible-playbook --syntax-check ~/playbook.yml

   Note that this command only validates the syntax and does not protect against a wrong but valid configuration.

3. Run the playbook:

   $ ansible-playbook ~/playbook.yml