theforeman.foreman.content_view_filter – Manage Content View Filters

Note

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

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

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

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Create and manage content View filters

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults Comments
architecture
string
package architecture
content_view
string / required
Name of the content view
date_type
string
    Choices:
  • issued
  • updated ←
Search using the 'Issued On' or 'Updated On'
Only valid on filter_type=erratum.
description
string
Description of the Content View Filter
end_date
string
erratum end date (YYYY-MM-DD)
errata_id
string
erratum id
filter_state
string
    Choices:
  • present ←
  • absent
State of the content view filter
filter_type
string / required
    Choices:
  • rpm
  • package_group
  • erratum
  • docker
Content view filter type
inclusion
boolean
    Choices:
  • no ←
  • yes
Create an include filter
max_version
string
package maximum version
min_version
string
package minimum version
name
string / required
Name of the Content View Filter
organization
string / required
Organization that the entity is in
original_packages
boolean
    Choices:
  • no
  • yes
Include all RPMs with no errata
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
Default:
[]
List of repositories that include name and product
An empty Array means all current and future repositories
rule_name
string
Content view filter rule name or package name
If omitted, the value of name will be used if necessary

aliases: package_name, package_group, tag
rule_state
string
    Choices:
  • present ←
  • absent
State of the content view filter rule
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.
start_date
string
erratum start date (YYYY-MM-DD)
types
list / elements=string
Default:
["bugfix", "enhancement", "security"]
erratum types (enhancement, bugfix, security)
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.
version
string
package version

Examples

- name: Exclude csh
  theforeman.foreman.content_view_filter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "package filter 1"
    organization: "Default Organization"
    content_view: Web Servers
    filter_type: "rpm"
    package_name: tcsh

- name: Include newer csh versions
  theforeman.foreman.content_view_filter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "package filter 1"
    organization: "Default Organization"
    content_view: Web Servers
    filter_type: "rpm"
    package_name: tcsh
    min_version: 6.20.00
    inclusion: 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_view_filters
list / elements=dictionary
success
List of content view filters.



Authors

  • Sean O’Keeffe (@sean797)