theforeman.foreman.role – Manage Roles
Note
This plugin is part of the theforeman.foreman collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package. 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
.
To use it in a playbook, specify: theforeman.foreman.role
.
New in version 1.0.0: of theforeman.foreman
Synopsis
- Create, update, and delete Roles
Requirements
The below requirements are needed on the host that executes this module.
- requests
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description
string
|
Description of the role
|
||
filters
list /
elements=dictionary
|
Filters with permissions for this role
|
||
permissions
list /
elements=string /
required
|
List of permissions
|
||
search
string
|
Filter condition for the resources
|
||
locations
list /
elements=string
|
List of locations the entity should be assigned to
|
||
name
string /
required
|
The name of the role
|
||
organizations
list /
elements=string
|
List of organizations the entity should be assigned to
|
||
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
|
|
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.
|
Examples
- name: role theforeman.foreman.role: name: "Provisioner" description: "Only provision on libvirt" locations: - "Uppsala" organizations: - "ACME" filters: - permissions: - view_hosts search: "owner_type = Usergroup and owner_id = 4" server_url: "https://foreman.example.com" username: "admin" password: "changeme" 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.
|
|
roles
list /
elements=dictionary
|
success |
List of roles.
|
Authors
- Christoffer Reijer (@ephracis) Basalt AB
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/role_module.html