mschuchard.general.puppet_agent (1.0.1) — module

Module to manage the Puppet agent daemon.

| "added in version" 1.0.0 of mschuchard.general"

Authors: Matthew Schuchard (@mschuchard)

Install collection

Install with ansible-galaxy collection install mschuchard.general:==1.0.1


Add to requirements.yml

  collections:
    - name: mschuchard.general
      version: 1.0.1

Description

Retrieves the client configuration from the Puppet master and applies it to the local host.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# initiate the puppet agent with test options and server port 8234
- name: Initiate the puppet agent with test options and server port 8234
  mschuchard.general.puppet_agent:
    server_port: 8234
    test: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# initiate the puppet agent with debug and verbosity enabled in no-operative mode
- name: Initiate the puppet agent with debug and verbosity enabled in no-operative mode
  mschuchard.general.puppet_agent:
    debug: true
    no_op: true
    verbose: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# initiate the puppet agent once (in a push model)
- name: Initiate the puppet agent once (in a push model)
  mschuchard.general.puppet_agent:
    no_daemonize: true
    onetime: true

Inputs

    
test:
    default: false
    description: Enable the most common options used for testing. These are 'verbose',
      'detailed-exitcodes', and 'show_diff'.
    required: false
    type: bool

debug:
    default: false
    description: Enable full debugging.
    required: false
    type: bool

no_op:
    default: false
    description: Use 'noop' mode where Puppet runs in a no-op or dry-run mode. This is
      useful for seeing what changes Puppet will make without actually executing the changes.
    required: false
    type: bool

onetime:
    default: false
    description: Run the configuration once. Runs a single (normally daemonized) Puppet
      run. Useful for interactively running puppet agent when used in conjunction with
      the no_daemonize option.
    required: false
    type: bool

verbose:
    default: false
    description: Print extra information.
    required: false
    type: bool

certname:
    default: fqdn
    description: Set the certname (unique ID) of the client.
    required: false
    type: str

server_port:
    default: 8140
    description: The port on which to contact the Puppet Server.
    required: false
    type: int

no_daemonize:
    default: false
    description: Do not send the process into the background.
    required: false
    type: bool

Outputs

command:
  description: The raw Puppet command executed by Ansible.
  returned: always
  type: str