theforeman.foreman.host_errata_info – Fetch information about Host Errata

Note

This plugin is part of the theforeman.foreman collection (version 2.2.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.

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

New in version 2.1.0: of theforeman.foreman

Synopsis

  • Fetch information about Host Errata

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults 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
    Choices:
  • no
  • yes
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.

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 Returned Description
host_errata
list / elements=dictionary
success
List of all found errata for the host and their details



Authors

  • Evgeni Golov (@evgeni)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/host_errata_info_module.html