proxmox_inventory

Table of Contents

1. Description
2. Requirements
3. Usage
4. Examples

Description

This module includes a Bolt plugin to generate targets from Proxmox VE.

Requirements

This Bolt plugin requires the proxmox-api gem to connect to the Proxmox REST API. If it is not installed, the plugin will automatically attempt to when the plugin is executed by Bolt.

You will need a token and secret, or username, password and realm to authenticate.

Usage

The Proxmox inventory plugin supports looking up running LXC and QEMU VMs. It supports several configuration properties.

• username: Do not set if using a token
• password: Do not set if using a token
• realm: Do not set if using a token
• token: Complete API token (eg. admin@pve!puppetbolt)
• secret: Token secret
• host: Hostname of the Proxmox node (any cluster member)
• port: API port (optional)
• verify_ssl: Set to false if using a self-signed certificate
• type: Filter on VM type, qemu or lxc (optional, default 'all')
• target_mapping: A hash of the target attributes to populate with resource values. Proxmox cluster/resources and node configuration attributes are available for mapping. Network interface (eg. net0, net1, ...) string value is converted to a Hash. Default mapping: name: fqdn alias: name uri: net0.ip

Examples

groups:
  - name: lxc proxmox containers at dc1
    targets:
      - _plugin: proxmox_inventory
        host: dc1.bogus.site
        username: admin
        password: supersecret
        realm: pve
        type: lxc
        target_mapping:
          name: fqdn
          uri: net0.ip
          alias: name
          vars:
            arch: arch
            type: type
  - name: all proxmox VMs at dc2
    targets:
      - _plugin: proxmox_inventory
        host: dc2.another.site
        token: admin@pve!bolt
        secret: 095ce810-4e28-11ed-bdc3-0242ac120002
        target_mapping:
          alias: vmid

Qemu: the agent service must be running on the VM to determine the IP address

Reference

Table of Contents

Tasks

• resolve_reference: Generate targets from Proxmox

Tasks

resolve_reference

Generate targets from Proxmox

Supports noop? false

Parameters

username

Data type: Optional[String]

password

Data type: Optional[String]

otp

Data type: Optional[String]

realm

Data type: Optional[String]

token

Data type: Optional[String]

secret

Data type: Optional[String]

host

Data type: String

port

Data type: Optional[Integer]

verify_ssl

Data type: Optional[Boolean]

type

Data type: Enum['lxc', 'qemu', 'all']

target_mapping

Data type: Hash

Changelog

All notable changes to this project will be documented in this file.

Release 0.7.1

• Fix error when IP is not set

Release 0.7.0

• BREAKING: net is no longer an array, use net0 instead.
• Default uri is now net0.ip

Release 0.6.2

• Fix resolving container DHCP ip address

Release 0.6.0

• Support resolving container DHCP ip address

Release 0.5.0

• Fix missing qemu targets with Proxmox 8
• Add Puppet 8, drop Puppet 6 support

Release 0.4.0

• Provide a default target mapping
• Add fqdn attribute and map to node name by default
• Remove qemu specific agent attribute, normalize net attribute between lxc and qemu. agent.net.0.ip is now net.0.ip (same as lxc)
• Fix inventory error when nodes have interfaces without ip addresses
• Work-around OSX qemu agent hwaddr reporting bug

Release 0.3.0

• Fix inventory error when QEMU VM's have the agent feature enabled but said agent is not running or reporting an IP address.

Release 0.2.3

• Fix automatic install of the proxmox-api gem

Release 0.2.1

• Token support now working with update to proxmox-api gem

Release 0.2.0

• New required type parameter accepts two possible values; lxc, qemu
• Filter qemu VMs without agent running

Release 0.1.0

Initial public release