redhat.satellite.bookmark – Manage Bookmarks

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.bookmark.

New in version 1.0.0: of redhat.satellite

Synopsis

• Manage Bookmark Entities

Requirements

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

• requests

Parameters

Parameter	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 SATELLITE_PASSWORD will be used instead.
public boolean	Make bookmark available for all users Choices: no yes ← (default)
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 SATELLITE_SERVER_URL will be used instead.
state string	State of the entity present_with_defaults will ensure the entity exists, but won’t update existing ones Choices: present ← (default) present_with_defaults absent
username string / required	Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable SATELLITE_USERNAME will be used instead.
validate_certs boolean	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 SATELLITE_VALIDATE_CERTS will be used instead. Choices: no yes ← (default)

Examples

- name: "Create a Bookmark"
  redhat.satellite.bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.example.com"
    name: "recent"
    controller: "job_invocations"
    query: "started_at > '24 hours ago'"
    state: present_with_defaults

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

- name: "Delete a Bookmark"
  redhat.satellite.bookmark:
    username: "admin"
    password: "changeme"
    server_url: "https://satellite.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	Description
entity dictionary	Final state of the affected entities grouped by their type. Returned: success
bookmarks list / elements=dictionary	List of bookmarks. Returned: success
controller string	Controller, the query is performed on. Returned: success
id integer	Database id of the bookmark. Returned: success
name string	Name of the bookmark. Returned: success
owner_id integer	Database id of the owner entity. Returned: success
owner_type string	Class of the owner entity. Returned: success
public boolean	Publicity of the bookmark. Returned: success
query string	Query to be performed on the controller. Returned: success

Authors

• Bernhard Hopfenmueller (@Fobhep) ATIX AG

• Christoffer Reijer (@ephracis) Basalt AB