ansible.builtin.puppet (v2.9.27) — module

Runs puppet

| "added in version" 2.0 of ansible.builtin"

Authors: Monty Taylor (@emonty)

stableinterface | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Runs I(puppet) agent or apply in a reliable manner.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet agent and fail if anything goes wrong
  puppet:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet and timeout in 5 minutes
  puppet:
    timeout: 5m
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet using a different environment
  puppet:
    environment: testing
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet using a specific certname
  puppet:
    certname: agent01.example.com
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet using a specific piece of Puppet code. Has no effect with a puppetmaster
  puppet:
    execute: include ::mymodule
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet using a specific tags
  puppet:
    tags:
    - update
    - nginx
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run puppet agent in noop mode
  puppet:
    noop: yes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Run a manifest with debug, log to both syslog and stdout, specify module path
  puppet:
    modulepath: /etc/puppet/modules:/opt/stack/puppet-modules:/usr/share/openstack-puppet/modules
    logdest: all
    manifest: /var/lib/example/puppet_step_config.pp

Inputs

    
noop:
    description:
    - Override puppet.conf noop mode.
    - When C(yes), run Puppet agent with C(--noop) switch set.
    - When C(no), run Puppet agent with C(--no-noop) switch set.
    - When unset (default), use default or puppet.conf value if defined.
    type: bool
    version_added: '2.8'
    version_added_collection: ansible.builtin

tags:
    description:
    - A list of puppet tags to be used.
    type: list
    version_added: '2.1'
    version_added_collection: ansible.builtin

debug:
    description:
    - Enable full debugging.
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

facts:
    description:
    - A dict of values to pass in as persistent external facter facts.
    type: dict

execute:
    description:
    - Execute a specific piece of Puppet code.
    - It has no effect with a puppetmaster.
    type: str
    version_added: '2.1'
    version_added_collection: ansible.builtin

logdest:
    choices:
    - all
    - stdout
    - syslog
    default: stdout
    description:
    - Where the puppet logs should go, if puppet apply is being used.
    - C(all) will go to both C(stdout) and C(syslog).
    type: str
    version_added: '2.1'
    version_added_collection: ansible.builtin

timeout:
    default: 30m
    description:
    - How long to wait for I(puppet) to finish.
    type: str

verbose:
    description:
    - Print extra information.
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

certname:
    description:
    - The name to use when handling certificates.
    type: str
    version_added: '2.1'
    version_added_collection: ansible.builtin

manifest:
    description:
    - Path to the manifest file to run puppet apply on.
    type: str

summarize:
    description:
    - Whether to print a transaction summary.
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

modulepath:
    description:
    - Path to an alternate location for puppet modules.
    type: str
    version_added: '2.4'
    version_added_collection: ansible.builtin

environment:
    description:
    - Puppet environment to be used.
    type: str

puppetmaster:
    description:
    - The hostname of the puppetmaster to contact.
    type: str

facter_basename:
    default: ansible
    description:
    - Basename of the facter output file.
    type: str

use_srv_records:
    description:
    - Toggles use_srv_records flag
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin