Chapter 22. Registering the system by using RHEL system roles

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create the vault:

      $ ansible-vault create ~/vault.yml
      New Vault password: <password>
      Confirm New Vault password: <vault_password>

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, enter the sensitive data in the <key>: <value> format:

      activationKey: <activation_key>
      organizationID: <organizationID>
      username: <username>
      password: <password>

      Copy to Clipboard Toggle word wrap
   3. Save the changes, and close the editor. Ansible encrypts the data in the vault.

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

   • To register by using an activation key and organization ID (recommended), use the following playbook:

     ---
     - name: Managing systems with the rhc RHEL system role
       hosts: managed-node-01.example.com
       vars_files:
         - ~/vault.yml
       tasks:
         - name: Registering system by using activation key and organization ID
           ansible.builtin.include_role:
             name: redhat.rhel_system_roles.rhc
           vars:
             rhc_auth:
               activation_keys:
                 keys:
                   - "{{ activationKey }}"
             rhc_organization: "{{ organizationID }}"

     Copy to Clipboard Toggle word wrap

     The settings specified in the example playbook include the following:

     rhc_auth: activation_keys

     The key activation_keys specifies that you want to register by using the activation keys.

     For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc.README.md file on the control node.

   • To register by using a username and password, use the following playbook:

     ---
     - name: Managing systems with the rhc RHEL system role
       hosts: managed-node-01.example.com
       vars_files:
         - ~/vault.yml
       tasks:
         - name: Registering system with username and password
           ansible.builtin.include_role:
             name: redhat.rhel_system_roles.rhc
           vars:
             rhc_auth:
               login:
                 username: "{{ username }}"
                 password: "{{ password }}"

     Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   +

   rhc_auth: login

   The key login specifies that you want to register by using the username and password.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

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

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create the vault:

      $ ansible-vault create ~/vault.yml
      New Vault password: <password>
      Confirm New Vault password: <vault_password>

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, enter the sensitive data in the <key>: <value> format:

      activationKey: <activation_key>
      organizationID: <organizationID>

      Copy to Clipboard Toggle word wrap
   3. Save the changes, and close the editor. Ansible encrypts the data in the vault.

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     vars_files:
       - ~/vault.yml
     tasks:
       - name: Register to the custom registration server and CDN
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_auth:
             activation_keys:
               keys:
                 - "{{ activationKey }}"
           rhc_organization: "{{ organizationID }}"
           rhc_server:
             hostname: example.com
               port: 443
               prefix: /rhsm
           rhc_baseurl: http://example.com/pulp/content

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   hostname: example.com

   A fully qualified domain name (FQDN) of the Satellite server for system registration and package management.

   port: 443

   Defines the network port used for communication with the Satellite server.

   prefix: /rhsm

   Specifies the URL path prefix for accessing resources on the Satellite server.

   rhc_baseurl: http://example.com/pulp/content

   Defines the prefix for content URLs. In a Satellite environment, the baseurl must be set to the same server where the system is registered. Refer to the hostname value to ensure the correct server is used.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc.README.md file on the control node.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

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

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

Procedure

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     tasks:
       - name: Disable Insights connection
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_insights:
             state: absent

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   rhc_insights absent|present

   Enables or disables system registration with Red Hat Insights for proactive analytics and recommendations.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

2. Validate the playbook syntax:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

Procedure

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     tasks:
       - name: Enable repository
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_repositories:
             - name: "RepositoryName"
               state: enabled

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   name: RepositoryName

   Name of the repository that should be enabled.

   state: enabled|disabled

   Optional, enables or disables the repository. Default is enabled.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

2. Validate the playbook syntax:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

Procedure

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     tasks:
       - name: Lock the system to a particular release
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_release: "8.6"

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   rhc_release: version

   The version of RHEL to set for the system, so the available content will be limited to that version.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

2. Validate the playbook syntax:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create the vault:

      $ ansible-vault create ~/vault.yml
      New Vault password: <password>
      Confirm New Vault password: <vault_password>

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, enter the sensitive data in the <key>: <value> format:

      username: <username>
      password: <password>
      proxy_username: <proxyusernme>
      proxy_password: <proxypassword>

      Copy to Clipboard Toggle word wrap
   3. Save the changes, and close the editor. Ansible encrypts the data in the vault.

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     vars_files:
       - ~/vault.yml
     tasks:
     - name: Register to the Red Hat Customer Portal by using proxy
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
       vars:
         rhc_auth:
           login:
             username: "{{ username }}"
             password: "{{ password }}"
         rhc_proxy:
           hostname: proxy.example.com
           port: 3128
           username: "{{ proxy_username }}"
           password: "{{ proxy_password }}"

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   hostname: proxy.example.com

   A fully qualified domain name (FQDN) of the proxy server.

   port: 3128

   Defines the network port used for communication with the proxy server.

   username: proxy_username

   Specifies the username for authentication. This is required only if the proxy server requires authentication.

   password: proxy_password

   Specifies the password for authentication. This is required only if the proxy server requires authentication.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

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

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create the vault:

      $ ansible-vault create ~/vault.yml
      New Vault password: <password>
      Confirm New Vault password: <vault_password>

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, enter the sensitive data in the <key>: <value> format:

      username: <username>
      password: <password>

      Copy to Clipboard Toggle word wrap
   3. Save the changes, and close the editor. Ansible encrypts the data in the vault.

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     vars_files:
       - ~/vault.yml
     tasks:
       - name: Enable Red Hat Insights autoupdates
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_auth:
             login:
               username: "{{ username }}"
               password: "{{ password }}"
           rhc_insights:
             autoupdate: true
             state: present

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   autoupdate: true|false

   Enables or disables the automatic collection rule updates for Red Hat Insights.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

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

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

Procedure

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     tasks:
       - name: Disable remediation
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_insights:
             remediation: absent
             state: present

   Copy to Clipboard Toggle word wrap

2. Validate the playbook syntax:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

Procedure

1. Store your sensitive variables in an encrypted file:

   1. Create the vault:

      $ ansible-vault create ~/vault.yml
      New Vault password: <password>
      Confirm New Vault password: <vault_password>

      Copy to Clipboard Toggle word wrap

   2. After the ansible-vault create command opens an editor, enter the sensitive data in the <key>: <value> format:

      username: <username>
      password: <password>

      Copy to Clipboard Toggle word wrap
   3. Save the changes, and close the editor. Ansible encrypts the data in the vault.

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     vars_files:
       - ~/vault.yml
     tasks:
       - name: Creating tags
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_auth:
             login:
               username: "{{ username }}"
               password: "{{ password }}"
           rhc_insights:
             tags:
               group: group-name-value
               location: location-name-value
               description:
                 - RHEL8
                 - SAP
               sample_key: value
             state: present

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   group: group-name-value

   Specifies the system group for organizing and managing registered hosts.

   location: location-name-value

   Defines the location associated with the registered system.

   description

   Provides a brief summary or identifier for the registered system.

   state: present|absent

   Indicates the current status of the registered system.

   Note

   The content inside the tags is a YAML structure representing the tags desired by the administrator for the configured systems. The example provided here is for illustrative purposes only and is not exhaustive. Administrators can customize the YAML structure to include any additional keys and values as needed.

3. Validate the playbook syntax:

   $ ansible-playbook --syntax-check --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

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

4. Run the playbook:

   $ ansible-playbook --ask-vault-pass ~/playbook.yml

   Copy to Clipboard Toggle word wrap

Procedure

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

   ---
   - name: Managing systems with the rhc RHEL system role
     hosts: managed-node-01.example.com
     tasks:
       - name: Unregister the system
         ansible.builtin.include_role:
           name: redhat.rhel_system_roles.rhc
         vars:
           rhc_state: absent

   Copy to Clipboard Toggle word wrap

   The settings specified in the example playbook include the following:

   rhc_state: absent

   Specifies the system should be unregistered from the registration server, RHSM, or Satellite.

   For details about all variables used in the playbook, see the /usr/share/ansible/roles/rhel-system-roles.rhc/README.md file on the control node.

2. Validate the playbook syntax:

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

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap