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.subscription_info module – Fetch information about Subscriptions

Note

This module 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.subscription_info.

New in version 2.1.0: of theforeman.foreman

Synopsis

• Fetch information about Subscriptions

Requirements

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

• requests

Parameters

Parameter	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.
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	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: no yes ← (default)

Examples

- name: "Show a subscription"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "Red Hat Satellite Infrastructure Subscription"

- name: "Show all subscriptions with a certain name"
  theforeman.foreman.subscription_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    search: name="Red Hat Satellite Infrastructure Subscription"

Return Values

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

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

Authors

• Evgeni Golov (@evgeni)

Collection links

Issue Tracker Homepage Repository (Sources)