theforeman.foreman.content_view_filter module – Manage Content View Filters

Note

This module is part of the theforeman.foreman collection (version 3.11.0).

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

Requirements

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

  • requests

Parameters

Parameter

Comments

architecture

string

package architecture

content_view

string / required

Name of the content view

date_type

string

Search using the ‘Issued On’ or ‘Updated On’

Only valid on filter_type=erratum.

Choices:

  • "issued"

  • "updated" ← (default)

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

State of the content view filter

Choices:

  • "present" ← (default)

  • "absent"

filter_type

string / required

Content view filter type

Choices:

  • "rpm"

  • "package_group"

  • "erratum"

  • "docker"

  • "modulemd"

inclusion

boolean

Create an include filter

Choices:

  • false ← (default)

  • true

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_module_streams

boolean

added in theforeman.foreman 3.10.0

Include all module streams with no errata

Only valid on filter_type=modulemd.

Choices:

  • false

  • true

original_packages

boolean

Include all RPMs with no errata

Choices:

  • false

  • true

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

An empty Array means all current and future repositories

Default: []

rule_name

aliases: package_name, package_group, tag

string

Content view filter rule name or package name

If omitted, the value of name will be used if necessary

rule_state

string

State of the content view filter rule

Choices:

  • "present" ← (default)

  • "absent"

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

erratum types (enhancement, bugfix, security)

Default: ["bugfix", "enhancement", "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

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.

Choices:

  • false

  • true ← (default)

version

string

package version

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying the entity

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

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

Description

entity

dictionary

Final state of the affected entities grouped by their type.

Returned: success

content_view_filters

list / elements=dictionary

List of content view filters.

Returned: success

Authors

  • Sean O’Keeffe (@sean797)