theforeman.foreman.hardware_model module – Manage Hardware Models

Note

This module is part of the theforeman.foreman collection (version 3.14.0).

To install it, use: ansible-galaxy collection install theforeman.foreman. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: theforeman.foreman.hardware_model.

New in theforeman.foreman 1.0.0

Synopsis

• Manage hardware models

Aliases: foreman_model

Requirements

The below requirements are needed on the host that executes this module.

• requests

Parameters

Parameter	Comments
hardware_model string	The class of CPU supplied in this machine. This is primarily used by Sparc Solaris builds and can be left blank for other architectures.
info string	General description of the hardware model
name string / required	Name of the hardware model
password string / required	Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_PASSWORD will be used instead.
server_url string / required	URL of the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_SERVER_URL will be used instead.
state string	State of the entity Choices: "present" ← (default) "absent"
username string / required	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable FOREMAN_USERNAME will be used instead.
validate_certs boolean	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 FOREMAN_VALIDATE_CERTS will be used instead. Choices: false true ← (default)
vendor_class string	The class of the machine as reported by the OpenBoot PROM. This is primarily used by Solaris SPARC builds and can be left blank for other architectures.

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying the entity
diff_mode	Support: full	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

Examples

- name: "Create ACME Laptop model"
  theforeman.foreman.hardware_model:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "acme laptop"
    info: "this is the acme laptop"
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
hardware_models list / elements=dictionary	List of hardware models. Returned: success

Authors

• Evgeni Golov (@evgeni)

Collection links

Issue Tracker Homepage Repository (Sources)