Модуль fortinet.fortimanager.fmgr_dvmdb_workspace_commit_pkg — Запись изменений

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_dvmdb_workspace_commit_pkg.

Новая функция в fortinet.fortimanager 2.0.0

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для получения данных из источников перед использованием.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только в случае расхождений между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация Ansible клиента с помощью токена доступа к API forticloud.
package_path_name строка / обязательно	Параметр (package_path_name) в запрошенном URL.
rc_failed список / элементы=целое	Список кодов rc, при которых выполнение задачи будет прервано.
rc_succeeded список / элементы=целое	Список кодов rc, при которых выполнение задачи будет завершено успешно.
workspace_locking_adom строка	Область (adom), которая должна быть заблокирована при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое	Максимальное время ожидания (в секундах) в режиме блокировки рабочего пространства, пока другой пользователь не разблокирует его. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства реализована в этом модуле FortiManager; параметры workspace_locking_adom и workspace_locking_timeout предназначены для этой цели.
Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевой код rc. Также можно настроить условия для завершения задачи по ошибке или успешному завершению с использованием параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Commit change
      fortinet.fortimanager.fmgr_dvmdb_workspace_commit_pkg:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        package_path_name: <your own value>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortinet/fortimanager/fmgr_dvmdb_workspace_commit_pkg_module.html