uyuni_project.uyuni.inventory inventory – Uyuni inventory source

Note

This inventory plugin is part of the uyuni_project.uyuni collection (version 0.5.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install uyuni_project.uyuni.

To use it in a playbook, specify: uyuni_project.uyuni.inventory.

Synopsis

  • Get inventory hosts from the Uyuni API.

  • Uses a configuration file as an inventory source, it must end in .uyuni.yml or .uyuni.yaml.

Parameters

Parameter

Comments

groups

list / elements=string

Limits to specific names groups

host

string / required

Hostname/IP address of the Uyuni server.

If the value is not specified in the inventory configuration, the value of environment variable UYUNI_HOST will be used instead.

Configuration:

  • Environment variable: UYUNI_HOST

    added in uyuni_project.uyuni 0.2.0

ipv6_only

boolean

Use IPv6 addresses only

Choices:

  • false ← (default)

  • true

only_powered_on

boolean

Only shows powered-on hosts.

Choices:

  • false

  • true ← (default)

password

string / required

Password to query the API with.

If the value is not specified in the inventory configuration, the value of environment variable UYUNI_PASSWORD will be used instead.

Configuration:

  • Environment variable: UYUNI_PASSWORD

    added in uyuni_project.uyuni 0.2.0

pending_reboot_only

boolean

Limits to systems requiring a reboot only

Choices:

  • false ← (default)

  • true

plugin

string / required

Name of the plugin.

Choices:

  • "uyuni_project.uyuni.inventory"

port

integer

API port

Default: 443

show_custom_values

boolean

Lists defined custom parameters and values

Choices:

  • false ← (default)

  • true

user

string / required

Username to query the API with.

If the value is not specified in the inventory configuration, the value of environment variable UYUNI_USER will be used instead.

Configuration:

  • Environment variable: UYUNI_USER

    added in uyuni_project.uyuni 0.2.0

verify_ssl

boolean

Enables or disables SSL certificate verification.

Choices:

  • false

  • true ← (default)

Examples

---
# my.uyuni.yml
plugin: uyuni_project.uyuni.inventory
host: 192.168.180.1
user: admin
password: admin
verify_ssl: false
show_custom_values: true
ipv6_only: true
groups:
  - dev
  - demo
...

---
# for use in AWX / AAP (Inventory Source "Sourced from a Project"),
# together with a custom credential that injects environment variables UYUNI_HOST, UYUNI_USER, UYUNI_PASSWORD
plugin: uyuni_project.uyuni.inventory
show_custom_values: true
...

Authors

  • Christian Stankowic (@stdevel)