theforeman / theforeman.foreman / 4.0.0 / module / host_collection Manage Host Collections | "added in version" 1.0.0 of theforeman.foreman" Authors: Maxim Burgerhout (@wzzrd), Christoffer Reijer (@ephracis)theforeman.foreman.host_collection (4.0.0) — module
Install with ansible-galaxy collection install theforeman.foreman:==4.0.0
collections: - name: theforeman.foreman version: 4.0.0
Create and Manage host collections
- 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
name: description: - Name of the host collection required: true type: str state: choices: - present - absent default: present description: - State of the entity type: str password: description: - Password of the user accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD) will be used instead. required: true type: str username: description: - Username accessing the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME) will be used instead. required: true type: str server_url: description: - URL of the Foreman server. - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL) will be used instead. required: true type: str description: description: - Description of the host collection required: false type: str organization: description: - Organization that the entity is in required: true type: str updated_name: description: - New name of the host collection. When this parameter is set, the module will not be idempotent. type: str validate_certs: default: true description: - 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 C(FOREMAN_VALIDATE_CERTS) will be used instead. type: bool
entity: contains: host_collections: description: List of host collections. elements: dict type: list description: Final state of the affected entities grouped by their type. returned: success type: dict