foreman_hostgroup – Manage Foreman Hostgroups using Foreman API

Synopsis

• Create, Update and Delete Foreman Hostgroups using Foreman API

Requirements

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

• apypie

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			Katello Content source. Only available for Katello installations.
content_view string			Katello 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 of Katello. Mutually exclusive with medium. Only available for Katello installations.
lifecycle_environment string			Katello 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. aliases: media
name string / required			Name of hostgroup
openscap_proxy string			OpenSCAP proxy name. Only available when the OpenSCAP plugin is installed.
operatingsystem string			Operatingsystem title
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	Choices: string ← boolean integer real array hash yaml json	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
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		Choices: PXELinux BIOS PXELinux UEFI Grub UEFI Grub2 BIOS Grub2 ELF Grub2 UEFI Grub2 UEFI SecureBoot Grub2 UEFI HTTP Grub2 UEFI HTTPS Grub2 UEFI HTTPS SecureBoot iPXE Embedded iPXE UEFI HTTP iPXE Chain BIOS iPXE Chain UEFI	PXE Bootloader
realm string			Realm name
root_pass string			root password
server_url string / required			URL of the Foreman server
state string		Choices: present ← absent	State of the entity in Foreman
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
validate_certs boolean		Choices: no yes ←	Whether or not to verify the TLS certificates of the Foreman server aliases: verify_ssl

Examples

- name: "Create a Hostgroup"
  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: "secret"
    state: present

- name: "Update a Hostgroup"
  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: "secret"
    state: present

- name: "My nested hostgroup"
  foreman_hostgroup:
    parent: "new_hostgroup"
    name: "my nested hostgroup"

- name: "My hostgroup with some proxies"
  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"
  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"
  foreman_hostgroup:
    name: "new_hostgroup"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "secret"
    state: absent

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Manisha Singhal (@Manisha15) ATIX AG

• Baptiste Agasse (@bagasse)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.