theforeman.foreman.hostgroup – Manage Hostgroups
theforeman.foreman.hostgroup – Manage Hostgroups
Note
This plugin is part of the theforeman.foreman collection (version 1.5.1).
To install it use: ansible-galaxy collection install theforeman.foreman
.
To use it in a playbook, specify: theforeman.foreman.hostgroup
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete Hostgroups
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
architecture string |
Architecture name | ||
compute_profile string |
Compute profile name | ||
compute_resource string |
Compute resource name | ||
config_groups list / elements=string |
Config groups list | ||
content_source string |
Content source. Only available for Katello installations. | ||
content_view string |
Content view. Only available for Katello installations. | ||
description string |
Description of hostgroup | ||
domain string |
Domain name | ||
environment string |
Puppet environment name | ||
kickstart_repository string |
Kickstart repository name. You need to provide this to use the "Synced Content" feature. Mutually exclusive with medium. Only available for Katello installations. | ||
lifecycle_environment string |
Lifecycle environment. Only available for Katello installations. | ||
locations list / elements=string |
List of locations the entity should be assigned to | ||
medium string |
Medium name Mutually exclusive with kickstart_repository.
| ||
name string / required |
Name of hostgroup | ||
openscap_proxy string |
OpenSCAP proxy name. Only available when the OpenSCAP plugin is installed. | ||
operatingsystem string |
Operating systems are looked up by their title which is composed as " .". You can omit the version part as long as you only have one operating system by that name. | ||
organization string |
Organization for scoped resources attached to the hostgroup. Only used for Katello installations. This organization will implicitly be added to the organizations parameter if needed. | ||
organizations list / elements=string |
List of organizations the entity should be assigned to | ||
parameters list / elements=dictionary |
Hostgroup specific host parameters | ||
name string / required |
Name of the parameter | ||
parameter_type string |
|
Type of the parameter | |
value raw / required |
Value of the parameter | ||
parent string |
Hostgroup parent name | ||
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 | ||
ptable string |
Partition table name | ||
puppet_ca_proxy string |
Puppet CA proxy name | ||
puppet_proxy string |
Puppet server proxy name | ||
puppetclasses list / elements=string |
List of puppet classes to include in this host group. Must exist for hostgroup's puppet environment. | ||
pxe_loader string |
|
PXE Bootloader | |
realm string |
Realm name | ||
root_pass string |
Root password. Will result in the entity always being updated, as the current password cannot be retrieved. | ||
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | ||
state string |
|
State of the entity | |
subnet string |
IPv4 Subnet name | ||
subnet6 string |
IPv6 Subnet name | ||
updated_name string |
New name of hostgroup. 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 | ||
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 |
Examples
- name: "Create a Hostgroup"
theforeman.foreman.hostgroup:
name: "new_hostgroup"
architecture: "architecture_name"
operatingsystem: "operatingsystem_name"
medium: "media_name"
ptable: "Partition_table_name"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: "Update a Hostgroup"
theforeman.foreman.hostgroup:
name: "new_hostgroup"
architecture: "updated_architecture_name"
operatingsystem: "updated_operatingsystem_name"
organizations:
- Org One
- Org Two
locations:
- Loc One
- Loc Two
- Loc One/Nested loc
medium: "updated_media_name"
ptable: "updated_Partition_table_name"
root_pass: "password"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: "My nested hostgroup"
theforeman.foreman.hostgroup:
parent: "new_hostgroup"
name: "my nested hostgroup"
- name: "My hostgroup with some proxies"
theforeman.foreman.hostgroup:
name: "my hostgroup"
environment: production
puppet_proxy: puppet-proxy.example.com
puppet_ca_proxy: puppet-proxy.example.com
openscap_proxy: openscap-proxy.example.com
- name: "My katello related hostgroup"
theforeman.foreman.hostgroup:
organization: "My Org"
name: "kt hostgroup"
content_source: capsule.example.com
lifecycle_environment: "Production"
content_view: "My content view"
parameters:
- name: "kt_activation_keys"
value: "my_prod_ak"
- name: "Delete a Hostgroup"
theforeman.foreman.hostgroup:
name: "new_hostgroup"
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| |
hostgroups list / elements=dictionary |
success |
List of hostgroups.
|
Authors
- Manisha Singhal (@Manisha15) ATIX AG
- Baptiste Agasse (@bagasse)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/hostgroup_module.html