Модуль fortinet.fortimanager.fmgr_firewall_proxyaddress6 — прокси-адрес брандмауэра 6

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_proxyaddress6 dictionary	Набор параметров верхнего уровня.
application list / элементы=string	Приложение.
case_sensitivity псевдонимы: case-sensitivity string	Учет регистра. Варианты: `"disable"` `"enable"`
category list / элементы=integer	Категория.
color integer	Цвет.
comment string	Комментарий.
header string	Заголовок.
header_group псевдонимы: header-group list / элементы=dictionary	Группа заголовков.
case_sensitivity псевдонимы: case-sensitivity string	Учет регистра. Варианты: `"disable"` `"enable"`
header string	Заголовок.
header_name псевдонимы: header-name string	Имя заголовка.
id integer	Идентификатор.
header_name псевдонимы: header-name string	Имя заголовка.
host list / элементы=string	Узел.
host_regex псевдонимы: host-regex string	Регулярное выражение для узла.
llm_servers псевдонимы: llm-servers list / элементы=string	Серверы LLM.
method list / элементы=string	Метод. Варианты: `"delete"` `"get"` `"head"` `"options"` `"post"` `"put"` `"trace"` `"connect"`
name string / обязательный	Имя.
path string	Путь.
post_arg псевдонимы: post-arg string	Аргумент POST. Варианты: `"disable"` `"enable"`
query string	Запрос.
referrer string	Источник перехода. Варианты: `"disable"` `"enable"`
tagging list / элементы=dictionary	Разметка тегами.
category list / элементы=string	Категория.
name string	Имя.
tags list / элементы=string	Теги.
type string	Тип. Варианты: `"host-regex"` `"url"` `"category"` `"method"` `"ua"` `"header"` `"src-advanced"` `"dst-advanced"` `"url-list"` `"saas"` `"response-header"` `"llm-server"`
ua list / элементы=string	Пользовательский агент. Варианты: `"chrome"` `"ms"` `"firefox"` `"safari"` `"other"` `"ie"` `"edge"`
ua_max_ver псевдонимы: ua-max-ver string	Максимальная версия пользовательского агента.
ua_min_ver псевдонимы: ua-min-ver string	Минимальная версия пользовательского агента.
url_list псевдонимы: url-list list / элементы=string	Список URL-адресов.
uuid string	UUID.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
Обычно выполнение модуля может завершиться с ошибкой при возврате ненулевого кода rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Firewall proxy address6
      fortinet.fortimanager.fmgr_firewall_proxyaddress6:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_proxyaddress6:
          name: "your value" # Required variable, string
          # application: <list or string>
          # case_sensitivity: <value in [disable, enable]>
          # category: <list or integer>
          # color: <integer>
          # comment: <string>
          # header: <string>
          # header_group:
          #   - case_sensitivity: <value in [disable, enable]>
          #     header: <string>
          #     header_name: <string>
          #     id: <integer>
          # header_name: <string>
          # host: <list or string>
          # host_regex: <string>
          # method: ["delete", "get", "head", "options", "post", "put", "trace", "connect"]
          # path: <string>
          # post_arg: <value in [disable, enable]>
          # query: <string>
          # referrer: <value in [disable, enable]>
          # tagging:
          #   - category: <list or string>
          #     name: <string>
          #     tags: <list or string>
          # type: <value in [host-regex, url, category, ...]>
          # ua: ["chrome", "ms", "firefox", "safari", "other", "ie", "edge"]
          # ua_max_ver: <string>
          # ua_min_ver: <string>
          # url_list: <list or string>
          # uuid: <string>
          # llm_servers: <list or 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_proxyaddress6_module.html