redhat.satellite.operatingsystem module – Manage Operating Systems

Note

This module is part of the redhat.satellite collection (version 4.1.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install redhat.satellite. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: redhat.satellite.operatingsystem.

New in redhat.satellite 1.0.0

Synopsis

  • Manage Operating Systems

Aliases: foreman_operatingsystem

Requirements

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

  • requests

Parameters

Parameter

Comments

architectures

list / elements=string

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 / elements=string

list of installation media

minor

string

minor version of the Operating System

name

string / required

Name of the Operating System

os_family

aliases: family

string

Distribution family of the Operating System

Choices:

  • "AIX"

  • "Altlinux"

  • "Archlinux"

  • "Coreos"

  • "Debian"

  • "Fcos"

  • "Freebsd"

  • "Gentoo"

  • "Junos"

  • "NXOS"

  • "Rancheros"

  • "Redhat"

  • "Rhcos"

  • "Solaris"

  • "Suse"

  • "VRP"

  • "Windows"

  • "Xenserver"

parameters

list / elements=dictionary

Operating System specific host parameters

name

string / required

Name of the parameter

parameter_type

string

Type of the parameter

Choices:

  • "string" ← (default)

  • "boolean"

  • "integer"

  • "real"

  • "array"

  • "hash"

  • "yaml"

  • "json"

value

any / required

Value of the parameter

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 SATELLITE_PASSWORD will be used instead.

password_hash

string

hashing algorithm for passwd

Choices:

  • "MD5"

  • "SHA256"

  • "SHA512"

  • "Base64"

  • "Base64-Windows"

provisioning_templates

list / elements=string

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 redhat.satellite.os_default_template module.

ptables

list / elements=string

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.

If the value is not specified in the task, the value of environment variable SATELLITE_SERVER_URL will be used instead.

state

string

State of the entity

present_with_defaults will ensure the entity exists, but won’t update existing ones

Choices:

  • "present" ← (default)

  • "present_with_defaults"

  • "absent"

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.

If the value is not specified in the task, the value of environment variable SATELLITE_USERNAME will be used instead.

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 SATELLITE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "Create an Operating System"
  redhat.satellite.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: Debian
    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)"
  redhat.satellite.operatingsystem:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: Centos
    family: Redhat
    major: 7
    password_hash: SHA256
    state: present_with_defaults

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

operatinsystems

list / elements=dictionary

List of operatinsystems.

Returned: success

Authors

  • Matthias M Dellweg (@mdellweg) ATIX AG

  • Bernhard Hopfenmüller (@Fobhep) ATIX AG