theforeman.foreman.repository_set_info – Fetch information about Red Hat Repositories

Note

This plugin is part of the theforeman.foreman collection (version 2.1.2).

To install it use: ansible-galaxy collection install theforeman.foreman.

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

New in version 2.1.0: of theforeman.foreman

Synopsis

  • Fetch information about Red Hat Repositories

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments
location
string
Label of the Location to scope the search for.
name
string
Name of the resource to fetch information for.
Mutually exclusive with search.
organization
string / required
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.
product
string
Name of the parent product
search
string
Search query to use
If None, and name is not set, all resources are returned.
Mutually exclusive with name.
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: "Find repository set by name and product."
  theforeman.foreman.repository_set_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    name: "Red Hat Enterprise Linux 7 Server (RPMs)"
    product: "Red Hat Enterprise Linux Server"

- name: "Find repository set by label."
  theforeman.foreman.repository_set_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    search: 'label = "rhel-7-server-rpms"'

Return Values

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

Key Returned Description
repository_set
dictionary
success and name was passed
Details about the found Red Hat Repository.

repository_sets
list / elements=dictionary
success and search was passed
List of all found Red Hat Repositories and their details.



Authors

  • William Bradford Clark (@wbclark)