Docs4dev
Docs
ansible / 2.11 / collections / theforeman / foreman / hardware_model_module.html

theforeman.foreman.hardware_model – Manage Hardware Models

Note

This plugin is part of the theforeman.foreman collection (version 1.5.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

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

New in version 1.0.0: of theforeman.foreman

Synopsis

  • Manage hardware models

Requirements

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

  • requests

Parameters

Parameter Choices/Defaults 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
    Choices:
  • present ←
  • absent
State of the entity
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
    Choices:
  • no
  • yes ←
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.
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.

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 Returned Description
entity
dictionary
success
Final state of the affected entities grouped by their type.

hardware_models
list / elements=dictionary
success
List of hardware models.



Authors

  • Evgeni Golov (@evgeni)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/theforeman/foreman/hardware_model_module.html