.. Document meta :orphan: .. Anchors .. _ansible_collections.theforeman.foreman.host_collection_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.host_collection -- Manage Host Collections +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `theforeman.foreman collection `_ (version 2.1.2). To install it use: :code:`ansible-galaxy collection install theforeman.foreman`. To use it in a playbook, specify: :code:`theforeman.foreman.host_collection`. .. version_added .. versionadded:: 1.0.0 of theforeman.foreman .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Create and Manage host collections .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults 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 FOREMAN_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 FOREMAN_SERVER_URL will be used instead.
state
string
    Choices:
  • present ←
  • absent
State of the entity
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 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.

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.

 
host_collections
list / elements=dictionary
success
List of host collections.



.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Maxim Burgerhout (@wzzrd) - Christoffer Reijer (@ephracis) .. Parsing errors