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

Примечание

Этот модуль является частью коллекции theforeman.foreman (версия 4.2.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install theforeman.foreman. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: theforeman.foreman.bookmark.

Новое в theforeman.foreman 1.0.0

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

Краткое описание

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

Псевдонимы: foreman_bookmark

Требования

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

requests

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в check_mode и возвращать прогноз состояния changed без изменения сущности
diff_mode	Поддержка: полная	В режиме diff вернет подробную информацию о том, что изменилось (или что, возможно, нужно изменить в check_mode)

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/bookmark_module.html