redhat.satellite.resource_info module – Gather information about resources

Note

This module is part of the redhat.satellite collection (version 3.10.0).

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

To use it in a playbook, specify: redhat.satellite.resource_info.

New in redhat.satellite 1.0.0

Synopsis

• Gather information about resources

Requirements

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

• requests

Parameters

Parameter	Comments
full_details aliases: info boolean	If True all details about the found resources are returned Choices: false ← (default) true
organization string	Scope the searched resource by organization
params dictionary	Add parameters to the API call if necessary If not specified, no additional parameters are passed
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 SATELLITE_PASSWORD will be used instead.
resource string / required	Resource to search Set to an invalid choice like foo see all available options.
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 SATELLITE_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 SATELLITE_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 SATELLITE_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

Notes

Note

• Some resources don’t support scoping and will return errors when you pass organization or unknown data in params.

Examples

- name: "Read a Setting"
  redhat.satellite.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    resource: settings
    search: name = foreman_url
  register: result
- debug:
    var: result.resources[0].value

- name: "Read all Registries"
  redhat.satellite.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    resource: registries
  register: result
- debug:
    var: item.name
  with_items: "{{ result.resources }}"

- name: "Read all Organizations with full details"
  redhat.satellite.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    resource: organizations
    full_details: true
  register: result
- debug:
    var: result.resources

- name: Get all existing subscriptions for organization with id 1
  redhat.satellite.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    resource: subscriptions
    params:
      organization_id: 1
  register: result
- debug:
    var: result

- name: Get all existing activation keys for organization ACME
  redhat.satellite.resource_info:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    resource: activation_keys
    organization: ACME
  register: result
- debug:
    var: result

Return Values

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

Key	Description
resources list / elements=string	Resource information Returned: always

Authors

• Sean O’Keeffe (@sean797)

Collection links

Issue Tracker Homepage Repository (Sources)