redhat.satellite.bookmark module – Manage Bookmarks
Note
This module is part of the redhat.satellite collection (version 3.5.0).
To install it, use: ansible-galaxy collection install redhat.satellite
.
You need further requirements to be able to use this module,
see Requirements for details.
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 for the bookmark |
|
Name of the bookmark |
|
Password of the user accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
Make bookmark available for all users Choices:
|
|
Query of the bookmark |
|
URL of the Foreman server. If the value is not specified in the task, the value of environment variable |
|
State of the entity
Choices:
|
|
Username accessing the Foreman server. If the value is not specified in the task, the value of environment variable |
|
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 Choices:
|
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 |
---|---|
Final state of the affected entities grouped by their type. Returned: success |
|
List of bookmarks. Returned: success |
|
Controller, the query is performed on. Returned: success |
|
Database id of the bookmark. Returned: success |
|
Name of the bookmark. Returned: success |
|
Database id of the owner entity. Returned: success |
|
Class of the owner entity. Returned: success |
|
Publicity of the bookmark. Returned: success |
|
Query to be performed on the controller. Returned: success |