foreman_bookmark – Manage Foreman Bookmarks

Synopsis

  • Manage Foreman Bookmark Entities

Requirements

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

  • apypie

Parameters

Parameter Choices/Defaults Comments
controller
string / required
Controller for the bookmark
name
string / required
Name of the bookmark
password
string / required
Password of the user accessing the Foreman server
public
boolean
    Choices:
  • no
  • yes ←
Make bookmark available for all users
query
string
Query of the bookmark
server_url
string / required
URL of the Foreman server
state
string
    Choices:
  • present ←
  • present_with_defaults
  • absent
State of the entity in Foreman
present_with_defaults will ensure the entity exists, but won't update existing ones
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: "Create a Bookmark"
  foreman_bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "recent"
    controller: "job_invocations"
    query: "started_at > '24 hours ago'"
    state: present_with_defaults

- name: "Update a Bookmark"
  foreman_bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "recent"
    controller: "job_invocations"
    query: "started_at > '12 hours ago'"
    state: present

- name: "Delete a Bookmark"
  foreman_bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "recent"
    controller: "job_invocations"
    state: absent

Status

Authors

  • Bernhard Hopfenmueller (@Fobhep) ATIX AG

  • Christoffer Reijer (@ephracis) Basalt AB

Hint

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