You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

theforeman.foreman.host_errata_info module – Fetch information about Host Errata

Note

This module is part of the theforeman.foreman collection (version 3.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.host_errata_info.

New in theforeman.foreman 2.1.0

Synopsis

• Fetch information about Host Errata

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Comments
content_view string	Calculate Applicable Errata based on a particular Content View. Required together with lifecycle_environment. If this is set, organization also needs to be set.
host string / required	Name of the host to fetch errata for.
lifecycle_environment string	Calculate Applicable Errata based on a particular Lifecycle Environment. Required together with content_view. If this is set, organization also needs to be set.
location string	Label of the Location to scope the search for.
organization string	Name of the Organization to scope the search for.
password string / required	Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
search string	Search query to use If None, all resources are returned.
server_url string / required	URL of the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
username string / required	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs boolean	Whether or not to verify the TLS certificates of the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_VALIDATE_CERTS will be used instead. Choices: false true ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "List installable errata for host"
  theforeman.foreman.host_errata_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    host: "host.example.com"

- name: "List applicable errata for host"
  theforeman.foreman.host_errata_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    host: "host.example.com"
    lifecycle_environment: "Library"
    content_view: "Default Organization View"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
host_errata list / elements=dictionary	List of all found errata for the host and their details Returned: success

Authors

• Evgeni Golov (@evgeni)

Collection links

Issue Tracker Homepage Repository (Sources)