theforeman.foreman.installation_medium (4.0.0) — module

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==4.0.0

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 4.0.0

Description

Create, update, and delete Installation Media

Requirements

• requests

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - 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.
    required: true
    type: str

path:
    description: Path to the installation medium
    type: str

state:
    choices:
    - present
    - present_with_defaults
    - absent
    default: present
    description:
    - State of the entity
    - C(present_with_defaults) will ensure the entity exists, but won't update existing
      ones
    type: str

password:
    description:
    - Password of the user accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD)
      will be used instead.
    required: true
    type: str

username:
    description:
    - Username accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME)
      will be used instead.
    required: true
    type: str

locations:
    description: List of locations the entity should be assigned to
    elements: str
    type: list

os_family:
    choices:
    - AIX
    - Altlinux
    - Archlinux
    - Coreos
    - Debian
    - Fcos
    - Freebsd
    - Gentoo
    - Junos
    - NXOS
    - Rancheros
    - Redhat
    - Rhcos
    - Solaris
    - Suse
    - VRP
    - Windows
    - Xenserver
    description:
    - 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.
    required: false
    type: str

server_url:
    description:
    - URL of the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL)
      will be used instead.
    required: true
    type: str

updated_name:
    description: New full installation medium name. When this parameter is set, the module
      will not be idempotent.
    type: str

organizations:
    description: List of organizations the entity should be assigned to
    elements: str
    type: list

validate_certs:
    default: true
    description:
    - 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 C(FOREMAN_VALIDATE_CERTS)
      will be used instead.
    type: bool

operatingsystems:
    description:
    - 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.
    elements: str
    required: false
    type: list

Outputs

entity:
  contains:
    media:
      description: List of installation media.
      elements: dict
      type: list
  description: Final state of the affected entities grouped by their type.
  returned: success
  type: dict