theforeman.foreman.compute_profile – Manage Compute Profiles
theforeman.foreman.compute_profile – Manage Compute Profiles
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.compute_profile
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete Compute Profiles
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
compute_attributes list / elements=dictionary |
Compute attributes related to this compute profile. Some of these attributes are specific to the underlying compute resource type | ||
compute_resource string |
Name of the compute resource the attribute should be for | ||
vm_attrs dictionary |
Hash containing the data of vm_attrs
| ||
name string / required |
compute profile 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 | ||
server_url string / required |
URL of the Foreman server. If the value is not specified in the task, the value of environment variable | ||
state string |
|
State of the entity | |
updated_name string |
new compute profile name | ||
username string / required |
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable | ||
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 |
Examples
- name: compute profile
theforeman.foreman.compute_profile:
name: example_compute_profile
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: another compute profile
theforeman.foreman.compute_profile:
name: another_example_compute_profile
compute_attributes:
- compute_resource: ovirt_compute_resource1
vm_attrs:
cluster: 'a96d44a4-f14a-1015-82c6-f80354acdf01'
template: 'c88af4b7-a24a-453b-9ac2-bc647ca2ef99'
instance_type: 'cb8927e7-a404-40fb-a6c1-06cbfc92e077'
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: compute profile2
theforeman.foreman.compute_profile:
name: example_compute_profile2
compute_attributes:
- compute_resource: ovirt_compute_resource01
vm_attrs:
cluster: a96d44a4-f14a-1015-82c6-f80354acdf01
cores: 1
sockets: 1
memory: 1073741824
ha: 0
interfaces_attributes:
0:
name: ""
network: 390666e1-dab3-4c99-9f96-006b2e2fd801
interface: virtio
volumes_attributes:
0:
size_gb: 16
storage_domain: 19c50090-1ab4-4023-a63f-75ee1018ed5e
preallocate: '1'
wipe_after_delete: '0'
interface: virtio_scsi
bootable: 'true'
- compute_resource: libvirt_compute_resource03
vm_attrs:
cpus: 1
memory: 2147483648
nics_attributes:
0:
type: bridge
bridge: ""
model: virtio
volumes_attributes:
0:
pool_name: default
capacity: 16G
allocation: 16G
format_type: raw
server_url: "https://foreman.example.com"
username: "admin"
password: "changeme"
state: present
- name: Remove compute profile
theforeman.foreman.compute_profile:
name: example_compute_profile2
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 | Returned | Description | ||
---|---|---|---|---|
entity dictionary |
success |
Final state of the affected entities grouped by their type.
| ||
compute_profiles list / elements=dictionary |
success |
List of compute profiles.
| ||
compute_attributes list / elements=string |
success |
Attributes for this compute profile.
| ||
id integer |
success |
Database id of the compute profile.
| ||
name string |
success |
Name of the compute profile.
|
Authors
- Philipp Joos (@philippj)
- Baptiste Agasse (@bagasse)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/compute_profile_module.html