/ home / theforeman / theforeman.foreman / 4.0.0 / module / provisioning_template

theforeman.foreman.provisioning_template (4.0.0) — module

Manage Provisioning Templates

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

Authors: Bernhard Hopfenmueller (@Fobhep) ATIX AG, Matthias Dellweg (@mdellweg) ATIX AG

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

Manage Provisioning Templates

Requirements

requests

Usage examples

Scanned by Steampunk Spotter


# Keep in mind, that in this case, the inline parameters will be overwritten
- name: "Create a Provisioning Template inline"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: A New Finish Template
    kind: finish
    state: present
    template: |
      <%#
          name: Finish timetravel
          kind: finish
      %>
      cd /
      rm -rf *
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

Scanned by Steampunk Spotter

- name: "Create a Provisioning Template from a file"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    file_name: timeywimey_template.erb
    state: present
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

Scanned by Steampunk Spotter

# Due to the module logic, deleting requires a template dummy,
# either inline or from a file.
- name: "Delete a Provisioning Template"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: timeywimey_template
    template: |
      <%#
          dummy:
      %>
    state: absent

Scanned by Steampunk Spotter

- name: "Create a Provisioning Template from a file and modify with parameter"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    file_name: timeywimey_template.erb
    name: Wibbly Wobbly Template
    state: present
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

Scanned by Steampunk Spotter

# Providing a name in this case wouldn't be very sensible.
# Alternatively make use of with_filetree to parse recursively with filter.
- name: "Parsing a directory of provisioning templates"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    file_name: "{{ item }}"
    state: present
    locations:
      - SKARO
    organizations:
      - DALEK INC
  with_fileglob:
    - "./arsenal_templates/*.erb"

Scanned by Steampunk Spotter

# If the templates are stored locally and the ansible module is executed on a remote host
- name: Ensure latest version of all Provisioning Community Templates
  theforeman.foreman.provisioning_template:
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present
    template: '{{ lookup("file", item.src) }}'
  with_filetree: '/path/to/provisioning/templates'
  when: item.state == 'file'

Scanned by Steampunk Spotter


# with name set to "*" bulk actions can be performed
- name: "Delete *ALL* provisioning templates"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "*"
    state: absent

Scanned by Steampunk Spotter

- name: "Assign all provisioning templates to the same organization(s)"
  theforeman.foreman.provisioning_template:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "*"
    state: present
    organizations:
      - DALEK INC
      - sky.net
      - Doc Brown's garage

Inputs

kind:
choices:
- Bootdisk
- cloud-init
- finish
- host_init_config
- iPXE
- job_template
- kexec
- POAP
- provision
- PXEGrub
- PXEGrub2
- PXELinux
- registration
- script
- snippet
- user_data
- ZTP
description:
- The provisioning template kind
required: false
type: str

name:
description:
- The name of the Provisioning Template.
- If omited, will be determined from the C(name) header of the template or the filename
(in that order).
- The special value "*" can be used to perform bulk actions (modify, delete) on all
existing templates.
required: false
type: str

state:
choices:
- present
- present_with_defaults
- absent
default: present
description:
- State of the entity
- C(present_with_defaults) will ensure the entity exists, but won't update existing
ones
type: str

locked:
description:
- Determines whether the template shall be locked
required: false
type: bool

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

template:
description:
- The content of the provisioning template.
- Either this or I(file_name) is required as a source for the Provisioning Template
"content".
required: false
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

file_name:
description:
- The path of a template file, that shall be imported.
- Either this or I(template) is required as a source for the Provisioning Template
"content".
required: false
type: path

locations:
description: List of locations the entity should be assigned to
elements: str
type: list

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

updated_name:
description: New provisioning template name. When this parameter is set, the module
will not be idempotent.
type: str

audit_comment:
description:
- Content of the audit comment field
required: false
type: str

organizations:
description: List of organizations the entity should be assigned to
elements: str
type: list

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

operatingsystems:
description:
- List of operating systems the entity should be assigned to.
- Operating systems are looked up by their title which is composed as "<name> <major>.<minor>".
- You can omit the version part as long as you only have one operating system by that
name.
elements: str
required: false
type: list

Outputs

entity:
  contains:
    provisioning_templates:
      description: List of provisioning templates.
      elements: dict
      type: list
  description: Final state of the affected entities grouped by their type.
  returned: success
  type: dict