theforeman.foreman.installation_medium module – Manage Installation Media

Note

This module is part of the theforeman.foreman collection (version 3.6.0).

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

To use it in a playbook, specify: theforeman.foreman.installation_medium.

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Create, update, and delete Installation Media

Requirements

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

  • requests

Parameters

Parameter

Comments

locations

list / elements=string

List of locations the entity should be assigned to

name

string / required

The full installation medium name.

The special name “*” (only possible as parameter) is used to perform bulk actions (modify, delete) on all existing partition tables.

operatingsystems

list / elements=string

List of operating systems the entity should be assigned to.

Operating systems are looked up by their title which is composed as “<name> <major>.<minor>”.

You can omit the version part as long as you only have one operating system by that name.

organizations

list / elements=string

List of organizations the entity should be assigned to

os_family

string

The OS family the template shall be assigned with.

If no os_family is set but a operatingsystem, the value will be derived from it.

Choices:

  • AIX

  • Altlinux

  • Archlinux

  • Coreos

  • Debian

  • Fcos

  • Freebsd

  • Gentoo

  • Junos

  • NXOS

  • Rancheros

  • Redhat

  • Rhcos

  • Solaris

  • Suse

  • VRP

  • Windows

  • Xenserver

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

path

string

Path to the installation medium

server_url

string / required

URL of the Foreman server.

If the value is not specified in the task, the value of environment variable FOREMAN_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 full installation medium 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 FOREMAN_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 FOREMAN_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Examples

- name: create new debian medium
  theforeman.foreman.installation_medium:
    name: "wheezy"
    locations:
      - "Munich"
    organizations:
      - "ACME"
    operatingsystems:
      - "Debian"
    path: "http://debian.org/mirror/"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

media

list / elements=dictionary

List of installation media.

Returned: success

Authors

  • Manuel Bonk(@manuelbonk) ATIX AG