theforeman.foreman.content_view_filter module – Manage Content View Filters
Note
This module is part of the theforeman.foreman collection (version 4.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: theforeman.foreman.content_view_filter
.
New in theforeman.foreman 1.0.0
Synopsis
Create and manage content View filters
Aliases: katello_content_view_filter
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Name of the content view |
|
Description of the Content View Filter |
|
Content view filter type Choices:
|
|
Create an include filter Choices:
|
|
Name of the Content View Filter |
|
Organization that the entity is in |
|
Include all module streams with no errata Only valid on filter_type=modulemd. Choices:
|
|
Include all RPMs with no errata Choices:
|
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
List of repositories that include name and product An empty Array means all current and future repositories Default: |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the content view filter Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying the entity |
|
Support: full |
Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode |
Examples
# as of v4.0.0 you can no longer manage rules from this module, content_view_filter_rule should be used for that
# you still need to ensure the filter itself exists before adding rules to said filter
- name: Ensure the filter for errata inclusion by date exists
theforeman.foreman.content_view_filter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
organization: "Default Organization"
name: "errata_by_date"
content_view: "Standard Operating Environment"
filter_type: rpm
inclusion: true
- name: Ensure package exclude filter 1 exists
theforeman.foreman.content_view_filter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
organization: "Default Organization"
name: "package filter 1"
content_view: "Standard Operating Environment"
filter_type: rpm
- name: Ensure modulemd filter for 389 exists
theforeman.foreman.content_view_filter:
username: "admin"
password: "changeme"
server_url: "https://foreman.example.com"
organization: "Default Organization"
name: "modulemd filter"
content_view: "Standard Operating Environment"
filter_type: modulemd
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of content view filters. Returned: success |