theforeman.foreman.content_view_filter_rule_info (4.0.0) — module

Fetch information about a Content View Filter Rule

| "added in version" 3.9.0 of theforeman.foreman"

Authors: Paul Armstrong (@parmstro)

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

Fetch information about a Content View Filter Rule


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Show a content_view_filter_rule"
  theforeman.foreman.content_view_filter_info:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    content_view: "SOE_RHEL9"
    content_view_filter: "NoFireFox"
    name: firefox

Inputs

    
name:
    description:
    - Name of the resource to fetch information for.
    - Mutually exclusive with I(search).
    required: false
    type: str

search:
    description:
    - Search query to use
    - If None, and I(name) is not set, all resources are returned.
    - Mutually exclusive with I(name).
    type: str

location:
    description:
    - Label of the Location to scope the search for.
    required: false
    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

errata_id:
    description:
    - for erratum fitlers using errata_by_id, the errata id to search for
    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

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

organization:
    description:
    - Name of the Organization to scope the search for.
    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

content_view_filter_rule:
  description: Details about the found content_view_filter_rule
  returned: success and I(name) was passed
  type: dict
content_view_filter_rules:
  description: Details about the found content_view_filter_rules
  returned: success and the filter type is erratum or modulemd
  type: dict