модуль fortinet.fortimanager.fmgr_fmupdate_fgdsetting_serveroverride — переопределение настроек сервера fmupdate fgd через CLI

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_fmupdate_fgdsetting_serveroverride.

Добавлено в fortinet.fortimanager 2.10.0

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

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Возможные значения: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Возможные значения: `false` ← (по умолчанию) `true`
fmupdate_fgdsetting_serveroverride словарь	Набор параметров верхнего уровня.
servlist список / элементы=словарь	Список серверов.
id целое число	Идентификатор.
ip строка	IP-адрес.
ip6 строка	Адрес IPv6.
port целое число	Порт.
service_type псевдонимы: service-type строка	Тип службы. Возможные значения: `"fgd"` `"fsa"` `"fgfq"` `"geoip"` `"iot-collect"`
status строка	Состояние. Возможные значения: `"disable"` `"enable"`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределяемый метод для базового запроса Json RPC. Возможные значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded список / элементы=целое число	Список кодов rc, для которых переопределяются условия успешного выполнения.
workspace_locking_adom строка	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания (в секундах) освобождения блокировки workspace другим пользователем. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Cli fmupdate fgd setting server override
      fortinet.fortimanager.fmgr_fmupdate_fgdsetting_serveroverride:
        # workspace_locking_adom: <global or your adom name>
        fmupdate_fgdsetting_serveroverride:
          # servlist:
          #   - id: <integer>
          #     ip: <string>
          #     ip6: <string>
          #     port: <integer>
          #     service_type: <value in [fgd, fsa, fgfq, ...]>
          # status: <value in [disable, enable]>

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

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

Ключ	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fgdsetting_serveroverride_module.html