foreman_host – Manage Foreman hosts

Synopsis

  • Manage Foreman host Entities

  • This beta version can create and delete hosts from preexisting host groups

Requirements

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

  • apypie

Parameters

Parameter Choices/Defaults Comments
architecture
string
Architecture name
build
boolean
    Choices:
  • no
  • yes
Whether or not to setup build context for the host
comment
string
Comment about the host.
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.
domain
string
Domain name
enabled
boolean
    Choices:
  • no
  • yes
Include this host within Foreman reporting
environment
string
Puppet environment name
hostgroup
string
Name of related hostgroup.
image
string
The image to use when provision_method=image.
ip
string
IP address of the primary interface of the host.
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.
location
string
Name of related location
mac
string
MAC address of the primary interface of the host.
Please include leading zeros and separate nibbles by colons, otherwise the execution will not be idempotent.
Example EE:BB:01:02:03:04
managed
boolean
    Choices:
  • no
  • yes
Whether a host is managed or unmanaged.
Forced to true when build=true
medium
string
Medium name
Mutually exclusive with kickstart_repository.

aliases: media
name
string / required
Fully Qualified Domain Name of host
openscap_proxy
string
OpenSCAP proxy name.
Only available when the OpenSCAP plugin is installed.
operatingsystem
string
Operatingsystem title
organization
string
Name of related organization
owner
string
Owner (user) of the host.
Mutually exclusive with owner_group.
owner_group
string
Owner (user group) of the host.
Mutually excluside with owner.
parameters
list / elements=dictionary
Entity domain 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
password
string / required
Password of the user accessing the Foreman server
provision_method
string
    Choices:
  • build
  • image
  • bootdisk
The method used to provision the host.
provision_method=bootdisk is only available if the bootdisk plugin is installed.
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.
Will result in the entity always being updated, as the current password cannot be retrieved.
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
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 host"
  foreman_host:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "new_host"
    hostgroup: my_hostgroup
    state: present

- name: "Create a host with build context"
  foreman_host:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "new_host"
    hostgroup: my_hostgroup
    build: true
    state: present

- name: "Create an unmanaged host"
  foreman_host:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "new_host"
    managed: false
    state: present

- name: "Delete a host"
  foreman_host:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "new_host"
    state: absent

Status

Authors

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

Hint

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