theforeman.foreman.compute_attribute module – Manage Compute Attributes

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.compute_attribute.

New in theforeman.foreman 1.0.0

Synopsis

  • Manage Compute Attributes

  • This beta version can create, and update compute attributes

Aliases: foreman_compute_attribute

Requirements

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

  • requests

Parameters

Parameter

Comments

compute_profile

string / required

Name of compute profile

compute_resource

string / required

Name of compute resource

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)

vm_attrs

aliases: vm_attributes

dictionary

Hash containing the data of vm_attrs

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 compute attribute"
  theforeman.foreman.compute_attribute:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    compute_profile: "Test Compute Profile"
    compute_resource: "Test Compute Resource"
    vm_attrs:
      memory_mb: '2048'
      cpu: '2'
    state: present

- name: "Update compute attribute"
  theforeman.foreman.compute_attribute:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    compute_profile: "Test Compute Profile"
    compute_resource: "Test Compute Resource"
    vm_attrs:
      memory_mb: '1024'
      cpu: '1'
    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

compute_attributes

list / elements=dictionary

List of compute attributes.

Returned: success

attributes

dictionary

Effective attributes for the given combination of compute profile and resource.

Returned: success

compute_profile_id

integer

Database id of the associated compute profile.

Returned: success

compute_profile_name

string

Name of the associated compute profile.

Returned: success

compute_resource_id

integer

Database id of the associated compute resource.

Returned: success

compute_resource_name

string

Name of the associated compute resource.

Returned: success

created_at

string

Creation date of the compute attribute.

Returned: success

id

integer

Database id of the compute_attribute.

Returned: success

name

string

Generated friendly name for the compute attribute.

Returned: success

provider_friendly_name

string

Name of the provider type of the compute resource.

Returned: success

updated_at

string

Date of last change to the compute attribute.

Returned: success

vm_attrs

dictionary

Configured attributes.

Returned: success

Authors

  • Manisha Singhal (@Manisha15) ATIX AG