theforeman.foreman.architecture module – Manage Architectures

Note

This module is part of the theforeman.foreman collection (version 4.2.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 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.architecture.

New in theforeman.foreman 1.0.0

Synopsis 

Create, update, and delete Architectures

Aliases: foreman_architecture

Requirements 

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

requests

Parameters 

Parameter	Comments
name string / required	Name of architecture
operatingsystems list / elements=string	List of operating systems the entity should be assigned to. Operating systems are looked up by their title which is composed as “<name> <major>.<minor>”. You can omit the version part as long as you only have one operating system by that name.
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"`
updated_name string	New architecture name. When this parameter is set, the module will not be idempotent.
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)

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 an Architecture"
  theforeman.foreman.architecture:
    name: "i386"
    operatingsystems:
      - "TestOS1"
      - "TestOS2"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: "Update an Architecture"
  theforeman.foreman.architecture:
    name: "i386"
    operatingsystems:
      - "TestOS3"
      - "TestOS4"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

- name: "Delete an Architecture"
  theforeman.foreman.architecture:
    name: "i386"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: absent

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
architectures list / elements=dictionary	List of architectures. Returned: success
id integer	Database id of the architecture. Returned: success
name string	Name of the architecture. Returned: success
operatinsystem_ids list / elements=integer	Database ids of associated operatingsystems. Returned: success

Authors

Manisha Singhal (@Manisha15) ATIX AG

theforeman.foreman.architecture module – Manage Architectures

Synopsis

Requirements

Parameters

Attributes

Examples

Return Values