theforeman.foreman.repository_info – Fetch information about Repositories

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.repository_info.

New in version 2.0.0: of theforeman.foreman

Synopsis

Fetch information about 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 / required		Product to which the repository lives in
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 by name"
  theforeman.foreman.repository_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "My repository"
    product: "My Product"
    organization: "Default Organization"

- name: "Find repository using a search"
  theforeman.foreman.repository_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    product: "My Product"
    organization: "Default Organization"
    search: 'name = "My repository"'

Return Values

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

Key	Returned	Description
repositories list / elements=dictionary	success and search was passed	List of all found repositories and their details
repository dictionary	success and name was passed	Details about the found repository

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/repository_info_module.html

Docs

Docs4dev

Title here