.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. meta:: :antsibull-docs: 2.10.0 .. Anchors .. _ansible_collections.theforeman.foreman.operatingsystem_module: .. Anchors: short name for ansible.builtin .. Title theforeman.foreman.operatingsystem module -- Manage Operating Systems +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `theforeman.foreman collection `_ (version 4.1.0-dev). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install theforeman.foreman`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`theforeman.foreman.operatingsystem`. .. version_added .. rst-class:: ansible-version-added New in theforeman.foreman 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage Operating Systems .. Aliases Aliases: foreman_operatingsystem .. Requirements .. _ansible_collections.theforeman.foreman.operatingsystem_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-architectures: .. rst-class:: ansible-option-title **architectures** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
architectures, the operating system can be installed on .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the Operating System .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-major: .. rst-class:: ansible-option-title **major** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
major version of the Operating System .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-media: .. rst-class:: ansible-option-title **media** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
list of installation media .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-minor: .. rst-class:: ansible-option-title **minor** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
minor version of the Operating System .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the Operating System .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-family: .. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-os_family: .. rst-class:: ansible-option-title **os_family** .. raw:: html .. ansible-option-type-line:: :ansible-option-aliases:`aliases: family` :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Distribution family of the Operating System .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"AIX"` - :ansible-option-choices-entry:`"Altlinux"` - :ansible-option-choices-entry:`"Archlinux"` - :ansible-option-choices-entry:`"Coreos"` - :ansible-option-choices-entry:`"Debian"` - :ansible-option-choices-entry:`"Fcos"` - :ansible-option-choices-entry:`"Freebsd"` - :ansible-option-choices-entry:`"Gentoo"` - :ansible-option-choices-entry:`"Junos"` - :ansible-option-choices-entry:`"NXOS"` - :ansible-option-choices-entry:`"Rancheros"` - :ansible-option-choices-entry:`"Redhat"` - :ansible-option-choices-entry:`"Rhcos"` - :ansible-option-choices-entry:`"Solaris"` - :ansible-option-choices-entry:`"Suse"` - :ansible-option-choices-entry:`"VRP"` - :ansible-option-choices-entry:`"Windows"` - :ansible-option-choices-entry:`"Xenserver"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-parameters: .. rst-class:: ansible-option-title **parameters** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Operating System specific host parameters .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-parameters/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Name of the parameter .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-parameters/parameter_type: .. rst-class:: ansible-option-title **parameter_type** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Type of the parameter .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"string"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"boolean"` - :ansible-option-choices-entry:`"integer"` - :ansible-option-choices-entry:`"real"` - :ansible-option-choices-entry:`"array"` - :ansible-option-choices-entry:`"hash"` - :ansible-option-choices-entry:`"yaml"` - :ansible-option-choices-entry:`"json"` .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-parameters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`any` / :ansible-option-required:`required` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
Value of the parameter .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-password: .. rst-class:: ansible-option-title **password** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_PASSWORD`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-password_hash: .. rst-class:: ansible-option-title **password_hash** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
hashing algorithm for passwd .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"MD5"` - :ansible-option-choices-entry:`"SHA256"` - :ansible-option-choices-entry:`"SHA512"` - :ansible-option-choices-entry:`"Base64"` - :ansible-option-choices-entry:`"Base64-Windows"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-provisioning_templates: .. rst-class:: ansible-option-title **provisioning_templates** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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 \ :ref:`theforeman.foreman.os\_default\_template `\ module. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-ptables: .. rst-class:: ansible-option-title **ptables** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
list of partitioning tables .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-release_name: .. rst-class:: ansible-option-title **release_name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Release name of the operating system (recommended for debian) .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-server_url: .. rst-class:: ansible-option-title **server_url** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
URL of the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_SERVER\_URL`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State of the entity \ :literal:`present\_with\_defaults`\ will ensure the entity exists, but won't update existing ones .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"present\_with\_defaults"` - :ansible-option-choices-entry:`"absent"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-updated_name: .. rst-class:: ansible-option-title **updated_name** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` .. raw:: html
- .. raw:: html
New operating system name. When this parameter is set, the module will not be idempotent. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-username: .. rst-class:: ansible-option-title **username** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable \ :literal:`FOREMAN\_USERNAME`\ will be used instead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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 \ :literal:`FOREMAN\_VALIDATE\_CERTS`\ will be used instead. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes Attributes ---------- .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Attribute - Support - Description * - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__attribute-check_mode: .. rst-class:: ansible-option-title **check_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html
- .. raw:: html
Can run in check\_mode and return changed status prediction without modifying the entity .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__attribute-diff_mode: .. rst-class:: ansible-option-title **diff_mode** .. raw:: html .. raw:: html
- .. raw:: html
:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html
- .. raw:: html
Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode .. raw:: html
.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: "Create an Operating System" theforeman.foreman.operatingsystem: username: "admin" password: "changeme" server_url: "https://foreman.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)" theforeman.foreman.operatingsystem: username: "admin" password: "changeme" server_url: "https://foreman.example.com" name: Centos family: Redhat major: 7 password_hash: SHA256 state: present_with_defaults - name: "Delete an Operating System" theforeman.foreman.operatingsystem: username: "admin" password: "changeme" server_url: "https://foreman.example.com" name: Debian family: Debian major: 9 state: absent .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. tabularcolumns:: \X{1}{3}\X{2}{3} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Key - Description * - .. raw:: html
.. _ansible_collections.theforeman.foreman.operatingsystem_module__return-entity: .. rst-class:: ansible-option-title **entity** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Final state of the affected entities grouped by their type. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. raw:: latex \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} .. _ansible_collections.theforeman.foreman.operatingsystem_module__return-entity/operatinsystems: .. rst-class:: ansible-option-title **operatinsystems** .. raw:: html .. ansible-option-type-line:: :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
.. raw:: latex \end{minipage} - .. raw:: html
List of operatinsystems. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Matthias M Dellweg (@mdellweg) ATIX AG - Bernhard Hopfenmüller (@Fobhep) ATIX AG .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. ansible-links:: - title: "Issue Tracker" url: "https://github.com/theforeman/foreman-ansible-modules/issues" external: true - title: "Homepage" url: "https://theforeman.org/" external: true - title: "Repository (Sources)" url: "https://github.com/theforeman/foreman-ansible-modules" external: true .. Parsing errors