theforeman.foreman.bookmark – Управление закладками

Примечание

Этот плагин входит в коллекцию theforeman.foreman (версия 1.5.1).

Для его установки используйте: ansible-galaxy collection install theforeman.foreman.

Чтобы использовать его в книге задач, укажите: theforeman.foreman.bookmark.

Новое в версии 1.0.0: theforeman.foreman

Описание
Требования
Параметры
Примеры
Возвращаемые значения

Описание

Управление сущностями закладок

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

requests

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
controller строка / обязательно		Контроллер для закладки
name строка / обязательно		Имя закладки
password строка / обязательно		Пароль пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_PASSWORD`.
public булево	Варианты: нет да ←	Сделать закладку доступной для всех пользователей
query строка		Запрос к закладке
server_url строка / обязательно		URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_SERVER_URL`.
state строка	Варианты: present ← present_with_defaults absent	Состояние сущности `present_with_defaults` гарантирует существование сущности, но не будет обновлять существующие
username строка / обязательно		Имя пользователя, получающего доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_USERNAME`.
validate_certs булево	Варианты: нет да ←	Подтверждать ли сертификаты TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной среды `FOREMAN_VALIDATE_CERTS`.

Примеры

- 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое	Описание
entity словарь			успех	Конечное состояние затронутых сущностей, сгруппированных по их типу.
	bookmarks список / элементы=словарь		успех	Список закладок.
		controller строка	успех	Контроллер, на котором выполняется запрос.
		id целое число	успех	Базовый идентификатор закладки.
		name строка	успех	Имя закладки.
		owner_id целое число	успех	Базовый идентификатор сущности владельца.
		owner_type строка	успех	Класс сущности владельца.
		public булево	успех	Доступность закладки.
		query строка	успех	Запрос, который выполняется на контроллере.

Авторы

Bernhard Hopfenmueller (@Fobhep) ATIX AG
Christoffer Reijer (@ephracis) Basalt AB

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/bookmark_module.html