theforeman.foreman.foreman_role (0.8.1) — module

Install collection

Install with ansible-galaxy collection install theforeman.foreman:==0.8.1

Add to requirements.yml

  collections:
    - name: theforeman.foreman
      version: 0.8.1

Description

Create and Delete Foreman Roles using Foreman API

Requirements

• apypie

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description: The name of the role
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the entity in Foreman
    type: str

filters:
    description: Filters with permissions for this role
    elements: dict
    required: false
    suboptions:
      permissions:
        description: List of permissions
        elements: str
        required: true
        type: list
      search:
        description: Filter condition for the resources
        required: false
        type: str
    type: list

password:
    description: Password of the user accessing the Foreman server
    required: true
    type: str

username:
    description: Username accessing the Foreman server
    required: true
    type: str

locations:
    description: List of locations the entity should be assigned to
    elements: str
    type: list

server_url:
    description: URL of the Foreman server
    required: true
    type: str

description:
    description: Description of the role
    required: false
    type: str

organizations:
    description: List of organizations the entity should be assigned to
    elements: str
    type: list

validate_certs:
    aliases:
    - verify_ssl
    default: true
    description: Whether or not to verify the TLS certificates of the Foreman server
    type: bool