foreman_role – Manage Foreman Roles using Foreman API

Synopsis

  • Create and Delete Foreman Roles using Foreman API

Requirements

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

  • apypie

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
server_url
string / required
URL of the Foreman server
state
string
    Choices:
  • present ←
  • absent
State of the entity in Foreman
username
string / required
Username accessing the Foreman server
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to verify the TLS certificates of the Foreman server

aliases: verify_ssl

Examples

- name: role
  foreman_role:
    name: "Provisioner"
    description: "Only provision on libvirt"
    locations:
      - "Uppsala"
    organizations:
      - "Basalt"
    filters:
      - permissions:
          - view_hosts
        search: "owner_type = Usergroup and owner_id = 4"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "secret"
    state: present

Status

Authors

  • Christoffer Reijer (@ephracis) Basalt AB

Hint

If you notice any issues in this documentation, you can edit this document to improve it.