theforeman.foreman.puppetclasses_import (4.0.0) — module

Import Puppet Classes from a Proxy

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

Authors: Evgeni Golov (@evgeni)

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

Import Puppet Classes from a Proxy


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Import Puppet Classes
  theforeman.foreman.puppetclasses_import:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    smart_proxy: "foreman.example.com"

Inputs

    
except:
    choices:
    - new
    - updated
    - obsolete
    description:
    - Which types of Puppet Classes to exclude from the import.
    elements: str
    required: false
    type: list

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

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

environment:
    description:
    - Puppet Environment to import Puppet Classes from
    required: false
    type: str

smart_proxy:
    description:
    - Smart Proxy to import Puppet Classes from
    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

Outputs

result:
  contains:
    environments_ignored:
      description:
      - Number of ignored Puppet Environments
      returned: when I(environment) not specificed
      type: int
    environments_obsolete:
      description:
      - Number of Puppet Environments with removed Puppet Classes
      returned: when I(environment) not specificed
      type: int
    environments_updated_puppetclasses:
      description:
      - Number of Puppet Environments with updated Puppet Classes
      returned: when I(environment) not specificed
      type: int
    environments_with_new_puppetclasses:
      description:
      - Number of Puppet Environments with new Puppet Classes
      returned: when I(environment) not specificed
      type: int
    results:
      description:
      - List of Puppet Environments and the changes made to them
      returned: success
      type: list
  description: Details about the Puppet Class import
  returned: success
  type: dict