fortinet.fortimanager.fmgr_icap_server модуль – Настройка серверов ICAP.

Примечание

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

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

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

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

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

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

Обзор

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью маркера доступа к API forticloud.
icap_server словарь	Настройка параметров верхнего уровня.
addr-type строка	Устарело, пожалуйста, переименуйте на addr_type. Тип адреса удаленного сервера ICAP Варианты: `"fqdn"` `"ip4"` `"ip6"`
fqdn строка	Полное доменное имя удаленного сервера ICAP
healthcheck строка	Включить/выключить проверку работоспособности удаленного сервера ICAP. Варианты: `"disable"` `"enable"`
healthcheck-service строка	Устарело, пожалуйста, переименуйте на healthcheck_service. Имя службы ICAP для использования при проверке работоспособности.
ip-address строка	Устарело, пожалуйста, переименуйте на ip_address. IPv4-адрес сервера ICAP.
ip-version строка	Устарело, пожалуйста, переименуйте на ip_version. Версия IP. Варианты: `"4"` `"6"`
ip6-address строка	Устарело, пожалуйста, переименуйте на ip6_address. IPv6-адрес сервера ICAP.
max-connections целое	Устарело, пожалуйста, переименуйте на max_connections. Максимальное количество одновременных подключений к серверу ICAP.
name строка / обязательно	Имя сервера.
port целое	Порт сервера ICAP.
secure строка	Включить/выключить безопасное подключение к серверу ICAP. Варианты: `"disable"` `"enable"`
ssl-cert строка	Устарело, пожалуйста, переименуйте на ssl_cert. Имя сертификата CA.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, при которых условия будут переопределены для неудачи.
rc_succeeded список / элементы=целое	Список rc-кодов, при которых условия будут переопределены для успеха.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`

END_OF_DOCUMENT_MARKER

workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов всё ещё доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код возврата. Также вы можете переопределить условия завершения ошибкой или успехом с параметрами 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: Configure ICAP servers.
      fortinet.fortimanager.fmgr_icap_server:
        # 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>
        state: present # <value in [present, absent]>
        icap_server:
          ip_address: <string>
          ip_version: <value in [4, 6]>
          ip6_address: <string>
          max_connections: <integer>
          name: <string>
          port: <integer>
          secure: <value in [disable, enable]>
          ssl_cert: <string>
          addr_type: <value in [fqdn, ip4, ip6]>
          fqdn: <string>
          healthcheck: <value in [disable, enable]>
          healthcheck_service: <string>

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

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

Ключ	Описание
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_icap_server_module.html