redhat.satellite.role – Manage Roles
Note
This plugin is part of the redhat.satellite collection (version 3.1.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 redhat.satellite
.
To use it in a playbook, specify: redhat.satellite.role
.
New in version 1.0.0: of redhat.satellite
Synopsis
Create, update, and delete Roles
Requirements
The below requirements are needed on the host that executes this module.
requests
Parameters
Parameter |
Comments |
---|---|
Description of the role |
|
Filters with permissions for this role |
|
List of permissions |
|
Filter condition for the resources |
|
List of locations the entity should be assigned to |
|
The name of the role |
|
List of organizations the entity should be assigned to |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
Examples
- name: role
redhat.satellite.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://satellite.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 |
Description |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of roles. Returned: success |