theforeman.foreman.content_view_filter_rule (4.0.0) — module

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==4.0.0

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 4.0.0

Description

Create, manage and remove content view filter rules

Requirements

• requests

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Include errata by date"
  theforeman.foreman.content_view_filter_rule:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    content_view: "Standard Operating Environment"
    content_view_filter: "errata_by_date"
    state: present
    inclusion: true
    date_type: updated
    types:
      - bugfix
      - security
      - enhancement
    end_date: "2022-05-25"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Exclude csh versions 6.20 and older"
  theforeman.foreman.content_view_filter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    content_view: "Standard Operating Environment"
    content_view_filter: "package filter 1"
    name: "tcsh"
    max_version: "6.20.00"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Exclude csh version 6.23 due to example policy"
  theforeman.foreman.content_view_filter:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    organization: "Default Organization"
    content_view: "Standard Operating Environment"
    content_view_filter: "package filter 1"
    name: "tcsh"
    version: "6.23.00"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Content View Filter Rule for 389"
  content_view_filter_rule:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    validate_certs: "true"
    organization: "Default Organization"
    content_view: "Standard Operating Environment"
    content_view_filter: "modulemd filter"
    name: "389-directory-server"
    stream: "next"
    version: "820220325123957"
    context: "9edba152"
    state: present

Inputs

    
name:
    aliases:
    - rule_name
    - module_name
    - package_name
    - package_group
    - tag
    description:
    - Content view filter rule name, package name, package_group name, module stream or
      docker tag
    - If omitted, the value of I(name) will be used if necessary
    - for module stream filters, this is the name of the module stream to search for
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the entity
    type: str

types:
    default:
    - bugfix
    - enhancement
    - security
    description:
    - errata types the ruel applies to (enhancement, bugfix, security)
    - Only valid on I(filter_type=erratum)
    elements: str
    type: list

stream:
    description:
    - the context for a module
    - only valid in filter I(type=modulemd)
    type: str

context:
    description:
    - the context for a module
    - only valid in filter I(type=modulemd)
    type: str

version:
    description:
    - package or module version
    type: str

end_date:
    description:
    - the rule limit for erratum end date (YYYY-MM-DD)
    - see date_type for the date the rule applies to
    - Only valid on I(filter_type=erratum_by_date).
    type: str

password:
    description:
    - Password of the user accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_PASSWORD)
      will be used instead.
    required: true
    type: str

username:
    description:
    - Username accessing the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_USERNAME)
      will be used instead.
    required: true
    type: str

date_type:
    choices:
    - issued
    - updated
    default: updated
    description:
    - set whether rule applied to erratum using the 'Issued On' or 'Updated On' date
    - only valid on filter I(type=erratum).
    type: str

errata_id:
    description:
    - erratum id
    type: str

server_url:
    description:
    - URL of the Foreman server.
    - If the value is not specified in the task, the value of environment variable C(FOREMAN_SERVER_URL)
      will be used instead.
    required: true
    type: str

start_date:
    description:
    - the rule limit for erratum start date (YYYY-MM-DD)
    - see date_type for the date the rule applies to
    - Only valid on I(filter_type=erratum).
    type: str

max_version:
    description:
    - package maximum version
    type: str

min_version:
    description:
    - package minimum version
    type: str

architecture:
    aliases:
    - arch
    description:
    - set package, module_stream, etc. architecture that the rule applies to
    type: str

content_view:
    description:
    - the name of the content view that the filter applies to
    required: true
    type: str

organization:
    description:
    - Organization that the entity is in
    required: true
    type: str

validate_certs:
    default: true
    description:
    - 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 C(FOREMAN_VALIDATE_CERTS)
      will be used instead.
    type: bool

content_view_filter:
    description:
    - the name of the content view filter that the rule applies to
    required: true
    type: str

Outputs

entity:
  contains:
    content_view_filters_rules:
      description: List of content view filter rule(s).
      elements: dict
      type: list
  description: Final state of the affected entities grouped by their type.
  returned: success
  type: dict