redhat.satellite.host_collection – Manage Host Collections

Note

This plugin is part of the redhat.satellite collection (version 3.1.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 redhat.satellite.

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

New in version 1.0.0: of redhat.satellite

Synopsis

• Create and Manage host collections

Requirements

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

• requests

Parameters

Parameter	Comments
description string	Description of the host collection
name string / required	Name of the host collection
organization string / required	Organization that the entity is in
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.
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.
state string	State of the entity Choices: present ← (default) absent
updated_name string	New name of the host collection. When this parameter is set, the module will not be idempotent.
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: no yes ← (default)

Examples

- name: "Create Foo host collection"
  redhat.satellite.host_collection:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "Foo"
    description: "Foo host collection for Foo servers"
    organization: "My Cool new Organization"
    state: present

Return Values

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

Key	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
host_collections list / elements=dictionary	List of host collections. Returned: success

Authors

• Maxim Burgerhout (@wzzrd)

• Christoffer Reijer (@ephracis)