Docs4dev
Docs
ansible / latest / collections / theforeman / foreman / content_view_module.html

theforeman.foreman.content_view – Manage Content Views

Note

This plugin is part of the theforeman.foreman collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install theforeman.foreman.

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

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Create and manage content views

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments
auto_publish
boolean
    Choices:
  • no ←
  • yes
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".
components
list / elements=dictionary
List of content views to includes content_view and either version or latest.
Ignored if composite=False.
content_view
string / required
Content View name to be added to the Composite Content View
content_view_version
string
Version of the Content View to add

aliases: version
latest
boolean
    Choices:
  • no ←
  • yes
Always use the latest Content View Version
composite
boolean
    Choices:
  • no ←
  • yes
A composite view contains other content views.
description
string
Description of the Content View
name
string / required
Name of the Content View
organization
string / required
Organization that the entity is in
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.
repositories
list / elements=dictionary
List of repositories that include name and product.
Cannot be combined with composite=True.
name
string / required
Name of the Repository to be added
product
string / required
Product of the Repository to be added
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.
solve_dependencies
boolean
    Choices:
  • no
  • yes
Solve RPM dependencies by default on Content View publish
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity
present_with_defaults will ensure the entity exists, but won't update existing ones
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
    Choices:
  • no
  • yes ←
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.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.

content_views
list / elements=dictionary
success
List of content views.



Authors

  • Eric D Helms (@ehelms)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/content_view_module.html