theforeman.foreman.bookmark – Manage Bookmarks

Note

This plugin is part of the theforeman.foreman collection (version 1.5.1).

To install it use: ansible-galaxy collection install theforeman.foreman.

To use it in a playbook, specify: theforeman.foreman.bookmark.

New in version 1.0.0: of theforeman.foreman

Synopsis
Requirements
Parameters
Examples
Return Values

Synopsis

Manage Bookmark Entities

Requirements

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

requests

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. If the value is not specified in the task, the value of environment variable `FOREMAN_PASSWORD` will be used instead.
public boolean	no yes ←	Make bookmark available for all users
query string		Query of the bookmark
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	present ← present_with_defaults absent	State of the entity `present_with_defaults` will ensure the entity exists, but won't update existing ones
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	no yes ←	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: "Create a Bookmark"
  theforeman.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"
  theforeman.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"
  theforeman.foreman.bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://foreman.example.com"
    name: "recent"
    controller: "job_invocations"
    state: absent

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.
	bookmarks list / elements=dictionary		success	List of bookmarks.
		controller string	success	Controller, the query is performed on.
		id integer	success	Database id of the bookmark.
		name string	success	Name of the bookmark.
		owner_id integer	success	Database id of the owner entity.
		owner_type string	success	Class of the owner entity.
		public boolean	success	Publicity of the bookmark.
		query string	success	Query to be performed on the controller.

Authors

Bernhard Hopfenmueller (@Fobhep) ATIX AG
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/2.11/collections/theforeman/foreman/bookmark_module.html