foreman_operatingsystem – Manage Foreman Operating Systems

Synopsis

  • Manage Foreman Operating System Entities

Requirements

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

  • apypie

Parameters

Parameter Choices/Defaults Comments
architectures
list
architectures, the operating system can be installed on
description
string
Description of the Operating System
major
string
major version of the Operating System
media
list
list of installation media
minor
string
minor version of the Operating System
name
string / required
Name of the Operating System
os_family
string
    Choices:
  • AIX
  • Altlinux
  • Archlinux
  • Coreos
  • Debian
  • Freebsd
  • Gentoo
  • Junos
  • NXOS
  • Rancheros
  • Redhat
  • Solaris
  • Suse
  • Windows
  • Xenserver
Distribution family of the Operating System

aliases: family
parameters
list / elements=dictionary
Operating System 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
password_hash
string
    Choices:
  • MD5
  • SHA256
  • SHA512
hashing algorithm for passwd
provisioning_templates
list
List of provisioning templates that are associated with the operating system.
Specify the full list of template names you want to associate with your OS.
For example ["Kickstart default", "Kickstart default finish", "Kickstart default iPXE", "custom"].
After specifying the template associations, you can set the default association in
the foreman_os_default_template module.
ptables
list
list of partitioning tables
release_name
string
Release name of the operating system (recommended for debian)
server_url
string / required
URL of the Foreman server
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity in Foreman
present_with_defaults will ensure the entity exists, but won't update existing ones
updated_name
string
New operating system name. 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 an Operating System"
  foreman_operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian 9
    release_name: stretch
    family: Debian
    major: 9
    parameters:
      - name: additional-packages
        value: python vim
    state: present

- name: "Ensure existence of an Operating System (provide default values)"
  foreman_operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Centos 7
    family: Redhat
    major: 7
    password_hash: SHA256
    state: present_with_defaults

- name: "Delete an Operating System"
  foreman_operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: Debian 9
    family: Debian
    major: 9
    state: absent

Status

Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG

  • Bernhard Hopfenmüller (@Fobhep) ATIX AG

Hint

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