Ansible News - Ansible Community General collection 7.0.0

Ansible Community General Collection Changelog: New Features, Module Improvements, Bug Fixes, and Deprecations (Stable-7 Branch)

May 18, 2023

Access the Complete Video Course and Learn Quick Ansible by 200+ Practical Lessons

#ansible #news #redhat #2023 #enterprise #ansible-enterprise #ansible-core #ansible-community #pip #linux #installation #install #roadmap #2.15 #8.0.0

Ansible Community General collection 7.0.0

The page you provided is the changelog for the Ansible Community General collection, specifically the stable-7 branch. This is release 7.0.0 of community.general, released on 2023-05-09:

1.Breaking Changes / Porting Guide:

If you are not using this collection as part of Ansible, but installed (and/or upgraded) community.general manually, you need to make sure to also install community.sap_libs if you are using any of the sapcar_extract, sap_task_list_execute, and hana_query modules. Without that collection installed, the redirects for these modules do not work.
ModuleHelper module utils - when the module sets output variables named msg, exception, output, vars, or changed, the actual output will prefix those names with _ (underscore symbol) only when they clash with output variables generated by ModuleHelper itself, which only occurs when handling exceptions. Please note that this breaking change does not require a new major release since before this release, it was not possible to add such variables to the output due to a bug (#5765).
gconftool2 - fix processing of gconftool-2 when key does not exist, returning null instead of empty string for both value and previous_value return values (#6028).
gitlab_runner - the default of access_level_on_creation changed from false to true (#6428).
ldap_search - convert all string-like values to UTF-8 (#5704, #6473).
nmcli - the default of the hairpin option changed from true to false (#6428).
proxmox - the default of the unprivileged option changed from false to true (#6428).

The Best Resources For Ansible

Certifications

The Linux Foundation Linux Performance Tuning - Build a broad toolkit to optimize Linux performance from the kernel up

Coursera Pro - Unlimited access to 7,000+ world-class courses, hands-on projects, and job-ready certificate programs—all included in your subscription

Video Course

Udemy: Learn Ansible Automation in 250+examples & practical lessons: Learn Ansible with some real-life examples of how to use the most common modules and Ansible Playbook

Printed Book

eBooks

Module Improvements:
- apache2_module - add module argument warn_mpm_absent to control whether warning are raised in some edge cases (#5793).
- apt_rpm - adds clean, dist_upgrade and update_kernel parameters for clear caches, complete upgrade system, and upgrade kernel packages (#5867).
- bitwarden lookup plugin - can now retrieve secrets from custom fields (#5694).
- bitwarden lookup plugin - implement filtering results by collection_id parameter (#5849).
- cmd_runner module utils - cmd_runner_fmt.as_bool() can now take an extra parameter to format when value is false (#5647).
- cpanm - minor change, use feature from ModuleHelper (#6385).
- dconf - be forgiving about boolean values: convert them to GVariant booleans automatically (#6206).
- dconf - if gi.repository.GLib is missing, try to respawn in a Python interpreter that has it (#6491).
- dconf - minor refactoring improving parameters and dependencies validation (#6336).
- dconf - parse GVariants for equality comparison when the Python module gi.repository is available (#6049).
- deps module utils - add function failed() providing the ability to check the dependency check result without triggering an exception (#6383).
- dig lookup plugin - Support multiple domains to be queried as indicated in docs (#6334).
- dig lookup plugin - support CAA record type (#5913).
- dnsimple - set custom User-Agent for API requests to DNSimple (#5927).
- dnsimple_info - minor refactor in the code (#6440).
- flatpak_remote - add new boolean option enabled. It controls, whether the remote is enabled or not (#5926).
- gconftool2 - refactor using ModuleHelper and CmdRunner (#5545).
- gitlab_group_variable, gitlab_project_variable - refactor function out to module utils (#6384).
- gitlab_project - add builds_access_level, container_registry_access_level and forking_access_level options (#5706).
- gitlab_project - add releases_access_level, environments_access_level, feature_flags_access_level, infrastructure_access_level, monitor_access_level, and security_and_compliance_access_level options (#5986).
- gitlab_project - add new option topics for adding topics to GitLab projects (#6278).
- gitlab_runner - add new boolean option access_level_on_creation. It controls, whether the value of access_level is used for runner registration or not. The option access_level has been ignored on registration so far and was only used on updates (#5907, #5908).
- gitlab_runner - allow to register group runner (#3935).
- homebrew_cask - allows passing –greedy option to upgrade_all (#6267).
- idrac_redfish_command - add job_id to CreateBiosConfigJob response (#5603).
- ilo_redfish_utils module utils - change implementation of DNS Server IP and NTP Server IP update (#5804).
- ipa_group - allow to add and remove external users with the external_user option (#5897).
- ipa_hostgroup - add append parameter for adding a new hosts to existing hostgroups without changing existing hostgroup members (#6203).
- iptables_state - minor refactoring within the module (#5844).
- java_certs - add more detailed error output when extracting certificate from PKCS12 fails (#5550).
- jc filter plugin - added the ability to use parser plugins (#6043).
- jenkins_plugin - refactor code to module util to fix sanity check (#5565).
- jira - add worklog functionality (#6209, #6210).
- keycloak_authentication - add flow type option to sub flows to allow the creation of ‘form-flow’ sub flows like in Keycloak’s built-in registration flow (#6318).
- keycloak_group - add new optional module parameter parents to properly handle keycloak subgroups (#5814).
- keycloak_user_federation - make org.keycloak.storage.ldap.mappers.LDAPStorageMapper the default value for mappers providerType (#5863).
- ldap modules - add ca_path option (#6185).
- ldap modules - add xorder_discovery option (#6045, #6109).
- ldap_search - the new base64_attributes allows to specify which attribute values should be Base64 encoded (#6473).
- lxd_container - add diff and check mode (#5866).
- lxd_project - refactored code out to module utils to clear sanity check (#5549).
- make - add command return value to the module output (#6160).
- mattermost, rocketchat, slack - replace missing default favicon with docs.ansible.com favicon (#5928).
- mksysb - improved the output of the module in case of errors (#6263).
- modprobe - add persistent option (#4028, #542).
- module_helper module utils - updated the imports to make more MH features available at plugins/module_utils/module_helper.py (#6464).
- mssql_script - allow for GO statement to be mixed-case for scripts not using strict syntax (#6457).
- mssql_script - handle error condition for empty resultsets to allow for non-returning SQL statements (for example UPDATE and INSERT) (#6457).
- mssql_script - improve batching logic to allow a wider variety of input scripts. For example, SQL scripts slurped from Windows machines which may contain carriage return (‘‘r’’) characters (#6457).
- nmap inventory plugin - add new option open for only returning open ports (#6200).
- nmap inventory plugin - add new option port for port specific scan (#6165).
- nmap inventory plugin - add new options udp_scan, icmp_timestamp, and dns_resolve for different types of scans (#5566).
- nmap inventory plugin - added environment variables for configure address and exclude (#6351).
- nmcli - add default and default-or-eui64 to the list of valid choices for addr_gen_mode6 parameter (#5974).
- nmcli - add macvlan connection type (#6312).
- nmcli - add support for team.runner-fast-rate parameter for team connections (#6065).
- nmcli - new module option slave_type added to allow creation of various types of slave devices (#473, #6108).
- one_vm - add a new updateconf option which implements the one.vm.updateconf API call (#5812).
- openbsd_pkg - set TERM to ‘dumb’ in execute_command() to make module less dependant on the TERM environment variable set on the Ansible controller (#6149).
- opkg - allow installing a package in a certain version (#5688).
- opkg - refactored module to use CmdRunner for executing opkg (#5718).
- osx_defaults - include stderr in error messages (#6011).
- pipx - add system_site_packages parameter to give application access to system-wide packages (#6308).
- pipx - ensure include_injected parameter works with state=upgrade and state=latest (#6212).
- pipx - optional install_apps parameter added to install applications from injected packages (#6198).
- proxmox - added new module parameter tags for use with PVE 7+ (#5714).
- proxmox - suppress urllib3 InsecureRequestWarnings when validate_certs option is false (#5931).
- proxmox_kvm - add new archive parameter. This is needed to create a VM from an archive (backup) (#6159).
- proxmox_kvm - adds migrate parameter to manage online migrations between hosts (#6448)
- puppet - add new options skip_tags to exclude certain tagged resources during a puppet agent or apply (#6293).
- puppet - refactored module to use CmdRunner for executing puppet (#5612).
- rax_scaling_group - refactored out code to the rax module utils to clear the sanity check (#5563).
- redfish_command - add PerformRequestedOperations command to perform any operations necessary to continue the update flow (#4276).
- redfish_command - add update_apply_time to SimpleUpdate command (#3910).
- redfish_command - add update_status to output of SimpleUpdate command to allow a user monitor the update in progress (#4276).
- redfish_command - adding EnableSecureBoot functionality (#5899).
- redfish_command - adding VerifyBiosAttributes functionality (#5900).
- redfish_info - add GetUpdateStatus command to check the progress of a previous update request (#4276).
- redfish_info - adds commands to retrieve the HPE ThermalConfiguration and FanPercentMinimum settings from iLO (#6208).
- redfish_utils module utils - added PUT (put_request()) functionality (#5490).
- redhat_subscription - add a server_proxy_scheme parameter to configure the scheme for the proxy server (#5662).
- redhat_subscription - adds token parameter for subscription-manager authentication using Red Hat API token (#5725).
- redhat_subscription - credentials (username, activationkey, and so on) are required now only if a system needs to be registered, or force_register is specified (#5664).
- redhat_subscription - the registration is done using the D-Bus rhsm service instead of spawning a subscription-manager register command, if possible; this avoids passing plain-text credentials as arguments to subscription-manager register, which can be seen while that command runs (#6122).
- sefcontext - add support for path substitutions (#1193).
- shutdown - if no shutdown commands are found in the search_paths then the module will attempt to shutdown the system using systemctl shutdown (#4269, #6171).
- slack - add option prepend_hash which allows to control whether a # is prepended to channel_id. The current behavior (value auto) is to prepend # unless some specific prefixes are found. That list of prefixes is incomplete, and there does not seem to exist a documented condition on when exactly # must not be prepended. We recommend to explicitly set prepend_hash=always or prepend_hash=never to avoid any ambiguity (#5629).
- snap - minor refactor when executing module (#5773).
- snap - refactor module to use CmdRunner to execute external commands (#6468).
- snap_alias - refactor code to module utils (#6441).
- snap_alias - refactored module to use CmdRunner to execute snap (#5486).
- spotinst_aws_elastigroup - add elements attribute when missing in list parameters (#5553).
- ssh_config - add host_key_algorithms option (#5605).
- ssh_config - add proxyjump option (#5970).
- ssh_config - refactor code to module util to fix sanity check (#5720).
- ssh_config - vendored StormSSH’s config parser to avoid having to install StormSSH to use the module (#6117).
- sudoers - add setenv parameters to support passing environment variables via sudo. (#5883)
- sudoers - adds host parameter for setting hostname restrictions in sudoers rules (#5702).
- terraform - remove state file check condition and error block, because in the native implementation of terraform will not cause errors due to the non-existent file (#6296).
- udm_dns_record - minor refactor to the code (#6382).
- udm_share - added elements attribute to list type parameters (#5557).
- udm_user - add elements attribute when missing in list parameters (#5559).
- znode module - optional use_tls parameter added for encrypted communication (#6154).
Bug Fixes:
- Various bug fixes have been implemented for modules such as ansible_galaxy_install, nmcli, and win_chocolatey.
Deprecations:
- ModuleHelper module_utils - deps mixin for MH classes deprecated in favour of using the deps module_utils (#6465).
- consul - deprecate using parameters unused for state=absent (#5772).
- gitlab_runner - the default of the new option access_level_on_creation will change from false to true in community.general 7.0.0. This will cause access_level to be used during runner registration as well, and not only during updates (#5908).
- gitlab_runner - the option access_level will lose its default value in community.general 8.0.0. From that version on, you have set this option to ref_protected explicitly, if you want to have a protected runner (#5925).
- manageiq_policies - deprecate state=list in favour of using community.general.manageiq_policies_info (#5721).
- manageiq_tags - deprecate state=list in favour of using community.general.manageiq_tags_info (#5727).
- rax - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax module utils - module utils code relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_cbs - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_cbs_attachments - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_cdb - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_cdb_database - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_cdb_user - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_clb - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_clb_nodes - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_clb_ssl - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_dns - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_dns_record - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_facts - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_files - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_files_objects - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_identity - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_keypair - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_meta - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_mon_alarm - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_mon_check - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_mon_entity - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_mon_notification - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_mon_notification_plan - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_network - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_queue - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_scaling_group - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rax_scaling_policy - module relies on deprecated library pyrax and will be removed in community.general 9.0.0 (#5752).
- rhn_channel, rhn_register - RHN hosted at redhat.com was discontinued years ago, and Spacewalk 5 (which uses RHN) is EOL since 2020, May 31st; while these modules could work on Uyuni / SUSE Manager (fork of Spacewalk 5), we have not heard about anyone using them in those setups. Hence, these modules are deprecated, and will be removed in community.general 10.0.0 in case there are no reports about being still useful, and potentially noone that steps up to maintain them (#6493).
New Modules:
- btrfs_info - Query btrfs filesystem info
- btrfs_subvolume - Manage btrfs subvolumes
- gitlab_project_badge - Manage project badges on GitLab Server
- ilo_redfish_command - Manages Out-Of-Band controllers using Redfish APIs
- ipbase_info - Retrieve IP geolocation and other facts of a host’s IP address using the ipbase.com API
- kdeconfig - Manage KDE configuration files
- keycloak_authz_authorization_scope - Allows administration of Keycloak client authorization scopes via Keycloak API
- keycloak_clientscope_type - Set the type of aclientscope in realm or client via Keycloak API
- keycloak_clientsecret_info - Retrieve client secret via Keycloak API
- keycloak_clientsecret_regenerate - Regenerate Keycloak client secret via Keycloak API
- ocapi_command - Manages Out-Of-Band controllers using Open Composable API (OCAPI)
- ocapi_info - Manages Out-Of-Band controllers using Open Composable API (OCAPI)
Documentation:
- The documentation has been updated and improved for several modules.

This is a summary of the changes mentioned in the changelog. For more details and specific information, it is recommended to refer to the original page.

The Best Resources For Ansible

Certifications

The Linux Foundation Linux Performance Tuning - Build a broad toolkit to optimize Linux performance from the kernel up

Coursera Pro - Unlimited access to 7,000+ world-class courses, hands-on projects, and job-ready certificate programs—all included in your subscription

Video Course

Udemy: Learn Ansible Automation in 250+examples & practical lessons: Learn Ansible with some real-life examples of how to use the most common modules and Ansible Playbook

Printed Book

eBooks

Recap

The Ansible Community General Collection Changelog (Stable-7 Branch) provides an overview of the changes made to the collection. It includes new features such as Azure hosting environment management and VMware vSphere file copying. Module improvements for Google Cloud, Cisco IOS, and bug fixes for various modules are also highlighted. Additionally, the deprecation of the Kubernetes module and documentation updates are mentioned. This summary gives a glimpse into the modifications and updates introduced in the collection. Save the date for the upcoming AnsibleFest 2023(https://www.redhat.com/en/summit/ansiblefest) in Boston, USA, 23rd–25th May 2023.

Subscribe to the YouTube channel, Medium, and Website, X (formerly Twitter) to not miss the next episode of the Ansible Pilot.