` for details.
To use it in a playbook, specify: :code:`theforeman.foreman.content_view`.
.. version_added
.. rst-class:: ansible-version-added
New in theforeman.foreman 1.0.0
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Create and manage content views
.. Aliases
Aliases: katello_content_view
.. Requirements
.. _ansible_collections.theforeman.foreman.content_view_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.content_view_module__parameter-auto_publish:
.. rst-class:: ansible-option-title
**auto_publish**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
- .. raw:: html
Auto publish composite view when a new version of a component content view is created.
Also note auto publish will only happen when the component is marked "latest".
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-ca_path:
.. rst-class:: ansible-option-title
**ca_path**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`path`
.. raw:: html
- .. raw:: html
PEM formatted file that contains a CA certificate to be used for validation.
If the value is not specified in the task, the value of environment variable :literal:`FOREMAN\_CA\_PATH` will be used instead.
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-components:
.. rst-class:: ansible-option-title
**components**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
- .. raw:: html
List of content views to includes content\_view and either version or latest.
Ignored if :emphasis:`composite=False`.
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-components/content_view:
.. rst-class:: ansible-option-title
**content_view**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Content View name to be added to the Composite Content View
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-components/content_view_version:
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-components/version:
.. rst-class:: ansible-option-title
**content_view_version**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-aliases:`aliases: version`
:ansible-option-type:`string`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Version of the Content View to add
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-components/latest:
.. rst-class:: ansible-option-title
**latest**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Always use the latest Content View Version
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-composite:
.. rst-class:: ansible-option-title
**composite**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
- .. raw:: html
A composite view contains other content views.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_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 Content View
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-import_only:
.. rst-class:: ansible-option-title
**import_only**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
:ansible-option-versionadded:`added in theforeman.foreman 3.14.0`
.. raw:: html
- .. raw:: html
Designate this Content View for importing from upstream servers only.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-label:
.. rst-class:: ansible-option-title
**label**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. raw:: html
- .. raw:: html
Label of the Content View. This field cannot be updated.
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_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 Content View
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-organization:
.. rst-class:: ansible-option-title
**organization**
.. raw:: html
.. 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_module__parameter-password:
.. rst-class:: ansible-option-title
**password**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. 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_module__parameter-repositories:
.. rst-class:: ansible-option-title
**repositories**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
.. raw:: html
- .. raw:: html
List of repositories that include name and product.
Cannot be combined with :emphasis:`composite=True`.
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-repositories/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 Repository to be added
.. raw:: html
* - .. raw:: html
.. raw:: latex
\hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth}
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-repositories/product:
.. rst-class:: ansible-option-title
**product**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string` / :ansible-option-required:`required`
.. raw:: html
.. raw:: latex
\end{minipage}
- .. raw:: html
Product of the Repository to be added
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_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.content_view_module__parameter-solve_dependencies:
.. rst-class:: ansible-option-title
**solve_dependencies**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
- .. raw:: html
Solve RPM dependencies by default on Content View publish
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry:`false`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_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.content_view_module__parameter-use_gssapi:
.. rst-class:: ansible-option-title
**use_gssapi**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`boolean`
.. raw:: html
- .. raw:: html
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
Requires the Python library \ `requests-gssapi `__ to be installed.
If the value is not specified in the task, the value of environment variable :literal:`FOREMAN\_USE\_GSSAPI` will be used instead.
.. rst-class:: ansible-option-line
:ansible-option-choices:`Choices:`
- :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
- :ansible-option-choices-entry:`true`
.. raw:: html
* - .. raw:: html
.. _ansible_collections.theforeman.foreman.content_view_module__parameter-username:
.. rst-class:: ansible-option-title
**username**
.. raw:: html
.. ansible-option-type-line::
:ansible-option-type:`string`
.. 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_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.content_view_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.content_view_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 or update Fedora content view"
theforeman.foreman.content_view:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "Fedora CV"
organization: "My Cool new Organization"
repositories:
- name: 'Fedora 26'
product: 'Fedora'
- name: "Create a composite content view"
theforeman.foreman.content_view:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
name: "Fedora CCV"
organization: "My Cool new Organization"
composite: true
auto_publish: true
components:
- content_view: Fedora CV
content_view_version: 1.0
- content_view: Internal CV
latest: true
.. 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.content_view_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.content_view_module__return-entity/content_views:
.. rst-class:: ansible-option-title
**content_views**
.. 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 content views.
.. rst-class:: ansible-option-line
:ansible-option-returned-bold:`Returned:` success
.. raw:: html
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Eric D Helms (@ehelms)
.. 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