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

Примечание

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

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

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

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

Добавлено в theforeman.foreman 1.0.0

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

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

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

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

Требования

Следующие требования должны быть выполнены на узле, где выполняется этот модуль.

requests

Параметры

Параметр	Комментарии
ca_path path	Файл в формате PEM, содержащий сертификат CA, используемый для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
controller string / обязательный	Контроллер закладки
name string / обязательный	Название закладки
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
public boolean	Сделать закладку доступной всем пользователям Варианты: `false` `true` ← (по умолчанию)
query string	Запрос закладки
server_url string / обязательный	URL-адрес сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности `present_with_defaults` обеспечивает наличие сущности, но не обновляет существующие Варианты: `"present"` ← (по умолчанию) `"present_with_defaults"` `"absent"`
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя сущность
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 dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
bookmarks list / элементы=dictionary	Список закладок. Возвращается: при успешном выполнении
controller string	Контроллер, для которого выполняется запрос. Возвращается: при успешном выполнении
id integer	Идентификатор закладки в базе данных. Возвращается: при успешном выполнении
name string	Название закладки. Возвращается: при успешном выполнении
owner_id integer	Идентификатор сущности-владельца в базе данных. Возвращается: при успешном выполнении
owner_type string	Класс сущности-владельца. Возвращается: при успешном выполнении
public boolean	Общедоступность закладки. Возвращается: при успешном выполнении
query string	Запрос, выполняемый для контроллера. Возвращается: при успешном выполнении

Авторы

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

Ссылки на коллекцию

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