theforeman.foreman.host_collection – Manage Host Collections
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.host_collection
.
New in version 1.0.0: of theforeman.foreman
Parameters
Parameter |
Comments |
---|---|
Description of the host collection |
|
Name of the host collection |
|
Organization that the entity is in |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
New name of the host collection. When this parameter is set, the module will not be idempotent. |
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Examples
- name: "Create Foo host collection"
theforeman.foreman.host_collection:
username: "admin"
password: "changeme"
server_url: "https://foreman.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 |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of host collections. Returned: success |
Authors
Maxim Burgerhout (@wzzrd)
Christoffer Reijer (@ephracis)