Модуль fortinet.fortimanager.fmgr_firewall_ippool6 — настройка пулов IP-адресов IPv6.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательно	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_ippool6 dictionary	Набор параметров верхнего уровня.
add_nat46_route псевдонимы: add-nat46-route string	Включить или отключить добавление маршрута NAT46. Варианты: `"disable"` `"enable"`
comments string	Комментарий.
dynamic_mapping list / элементы=dictionary	Динамическое сопоставление.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
add_nat46_route псевдонимы: add-nat46-route string	Включить или отключить добавление маршрута NAT46. Варианты: `"disable"` `"enable"`
comments string	Комментарии.
endip string	Конечный IP-адрес.
external_prefix псевдонимы: external-prefix string	Поддержка метапеременной Длина внешнего префикса NPTv6
internal_prefix псевдонимы: internal-prefix string	Поддержка метапеременной Длина внутреннего префикса NPTv6
nat46 string	Включить или отключить NAT46. Варианты: `"disable"` `"enable"`
startip string	Начальный IP-адрес.
type string	Настройка типа пула IPv6 Варианты: `"overload"` `"nptv6"`
endip string	Последний адрес IPv6
external_prefix псевдонимы: external-prefix string	Поддержка метапеременной Длина внешнего префикса NPTv6
internal_prefix псевдонимы: internal-prefix string	Поддержка метапеременной Длина внутреннего префикса NPTv6
name string / обязательно	Имя пула IP-адресов IPv6.
nat46 string	Включить или отключить NAT46. Варианты: `"disable"` `"enable"`
startip string	Первый адрес IPv6
type string	Настройка типа пула IPv6 Варианты: `"overload"` `"nptv6"`
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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv6 IP pools.
      fortinet.fortimanager.fmgr_firewall_ippool6:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_ippool6:
          comments: "ansible-comment"
          endip: "2001::101"
          name: "ansible-test"
          startip: "2001::0"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the IPv6 IP pools
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_ippool6"
          params:
            adom: "ansible"
            ippool6: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_ippool6_module.html