.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.theforeman.foreman.content_view_version_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title theforeman.foreman.content_view_version module -- Manage Content View Versions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `theforeman.foreman collection `_ (version 3.7.0). 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.content_view_version`. .. version_added .. rst-class:: ansible-version-added New in theforeman.foreman 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Publish, Promote or Remove a Content View Version .. Aliases .. Requirements .. _ansible_collections.theforeman.foreman.content_view_version_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - requests .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-content_view: .. rst-class:: ansible-option-title **content_view** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Name of the content view .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-current_lifecycle_environment: .. rst-class:: ansible-option-title **current_lifecycle_environment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The lifecycle environment that is already associated with the content view version Helpful for promoting a content view version .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the Content View Version .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-force: .. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-force_promote: .. rst-class:: ansible-option-title **force_promote** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: force` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Force content view promotion and bypass lifecycle environment restriction .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-force_yum_metadata_regeneration: .. rst-class:: ansible-option-title **force_yum_metadata_regeneration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Force metadata regeneration when performing Publish and Promote tasks .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-lifecycle_environments: .. rst-class:: ansible-option-title **lifecycle_environments** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
The lifecycle environments the Content View Version should be in. .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-organization: .. rst-class:: ansible-option-title **organization** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Organization that the entity is in .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: 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.content_view_version_module__parameter-server_url: .. rst-class:: ansible-option-title **server_url** .. raw:: html .. rst-class:: 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.content_view_version_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State of the entity .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`"present"` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`"absent"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: 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.content_view_version_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: 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-default-bold:`true` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__parameter-version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The content view version number (i.e. 1.0) .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - You cannot use this to remove a Content View Version from a Lifecycle environment, you should promote another version first. - For idempotency you must specify either \ :literal:`version`\ or \ :literal:`current\_lifecycle\_environment`\ . .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: "Ensure content view version 2.0 is in Test & Pre Prod" theforeman.foreman.content_view_version: username: "admin" password: "changeme" server_url: "https://foreman.example.com" content_view: "CV 1" organization: "Default Organization" version: "2.0" lifecycle_environments: - Test - Pre Prod - name: "Ensure content view version in Test is also in Pre Prod" theforeman.foreman.content_view_version: username: "admin" password: "changeme" server_url: "https://foreman.example.com" content_view: "CV 1" organization: "Default Organization" current_lifecycle_environment: Test lifecycle_environments: - Pre Prod - name: "Publish a content view, not idempotent" theforeman.foreman.content_view_version: username: "admin" password: "changeme" server_url: "https://foreman.example.com" content_view: "CV 1" organization: "Default Organization" - name: "Publish a content view and promote that version to Library & Dev, not idempotent" theforeman.foreman.content_view_version: username: "admin" password: "changeme" server_url: "https://foreman.example.com" content_view: "CV 1" organization: "Default Organization" lifecycle_environments: - Library - Dev - name: "Ensure content view version 1.0 doesn't exist" theforeman.foreman.content_view_version: username: "admin" password: "changeme" server_url: "https://foreman.example.com" content_view: "Web Servers" organization: "Default Organization" version: "1.0" state: absent # Obtain information about a Content View and its versions - name: find all CVs theforeman.foreman.resource_info: username: "admin" password: "changeme" server_url: "https://foreman.example.com" organization: "Default Organization" resource: content_views search: 'name="Example Content"' register: example_content # Obtain more details about all versions of a specific Content View - name: "find content view versions of {{ cv_id }}" theforeman.foreman.resource_info: username: "admin" password: "changeme" server_url: "https://foreman.example.com" organization: "Default Organization" resource: content_view_versions params: content_view_id: "{{ example_content.resources[0].id }}" register: version_information .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_version_module__return-entity: .. rst-class:: ansible-option-title **entity** .. raw:: html .. rst-class:: 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
.. _ansible_collections.theforeman.foreman.content_view_version_module__return-entity/content_view_versions: .. rst-class:: ansible-option-title **content_view_versions** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of content view versions. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Sean O'Keeffe (@sean797) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors