/ home / theforeman / theforeman.foreman / 0.8.1 / module / foreman_ptable

theforeman.foreman.foreman_ptable (0.8.1) — module

Manage Partition Table Template in Foreman

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Manage Foreman Partition Table

Requirements

apypie

Usage examples

Scanned by Steampunk Spotter


# Keep in mind, that in this case, the inline parameters will be overwritten
- name: "Create a Partition Table inline"
  foreman_ptable:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: A New Partition Template
    state: present
    layout: |
      <%#
        name: A Partition Template
      %>
        zerombr
        clearpart --all --initlabel
        autopart
    locations:
      - Gallifrey
    organizations:
      - TARDIS INC

Scanned by Steampunk Spotter

- name: "Create a Partition Template from a file"
  foreman_ptable:
    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

- name: "Delete a Partition Template"
  foreman_ptable:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: timeywimey
    layout: |
      <%#
          dummy:
      %>
    state: absent

Scanned by Steampunk Spotter

- name: "Create a Partition Template from a file and modify with parameter(s)"
  foreman_ptable:
    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 partition templates"
  foreman_ptable:
    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 Ptable Community Templates
  foreman_ptable:
    server_url: "https://foreman.example.com"
    username:  "admin"
    password:  "changeme"
    state: present
    layout: '{{ lookup("file", item.src) }}'
  with_filetree: '/path/to/partition/tables'
  when: item.state == 'file'

Scanned by Steampunk Spotter


# with name set to "*" bulk actions can be performed
- name: "Delete *ALL* partition tables"
  local_action:
    module: foreman_ptable
    username: "admin"
    password: "admin"
    server_url: "https://foreman.example.com"
    name: "*"
    state: absent

Scanned by Steampunk Spotter

- name: "Assign all partition tables to the same organization(s)"
  local_action:
    module: foreman_ptable
    username: "admin"
    password: "admin"
    server_url: "https://foreman.example.com"
    name: "*"
    state: present
    organizations:
      - DALEK INC
      - sky.net
      - Doc Brown's garage

Inputs

    
name:
    description:
    - 'The name a template should be assigned with in Foreman.

      A name must be provided.

      Possible sources are, ordererd by preference:

      The "name" parameter, config header (inline or in a file),

      basename of a file.

      The special name "*" (only possible as parameter) is used

      to perform bulk actions (modify, delete) on all existing partition tables.

      '
    required: false
    type: str

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

layout:
    description:
    - 'The content of the Partitioning Table Template, either this or file_name

      is required as a source for the Partition Template "content".

      '
    required: false
    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
    required: true
    type: str

username:
    description: Username accessing the Foreman server
    required: true
    type: str

file_name:
    description:
    - 'The path of a template file, that shall be imported.

      Either this or layout is required as a source for

      the Partition Template "content".

      '
    required: false
    type: path

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

os_family:
    choices:
    - AIX
    - Altlinux
    - Archlinux
    - Coreos
    - Debian
    - Freebsd
    - Gentoo
    - Junos
    - NXOS
    - Rancheros
    - Redhat
    - Solaris
    - Suse
    - Windows
    - Xenserver
    description:
    - The OS family the template shall be assigned with.
    required: false
    type: str

server_url:
    description: URL of the Foreman server
    required: true
    type: str

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

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

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    type: bool