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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
firewall_ippool6 dictionary	Набор параметров верхнего уровня.
add-nat46-route string	Устарело, переименуйте в add_nat46_route. Включить/выключить добавление маршрута NAT46. Варианты: `"disable"` `"enable"`
comments string	Комментарий.
dynamic_mapping list / elements=dictionary	Динамическое отображение.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
add-nat46-route string	Устарело, переименуйте в add_nat46_route. Включить/выключить добавление маршрута NAT46. Варианты: `"disable"` `"enable"`
comments string	Комментарии.
endip string	Конечный IP-адрес.
external-prefix string	Устарело, переименуйте в external_prefix. Поддерживает метапеременную Внешняя длина префикса NPTv6
internal-prefix string	Устарело, переименуйте в internal_prefix. Поддерживает метапеременную Внутренняя длина префикса NPTv6
nat46 string	Включить/выключить NAT46. Варианты: `"disable"` `"enable"`
startip string	Начальный IP-адрес.
type string	Настроить тип пула IPv6 Варианты: `"overload"` `"nptv6"`
endip string	Конечный IPv6 адрес
external-prefix string	Устарело, переименуйте в external_prefix. Поддерживает метапеременную Внешняя длина префикса NPTv6
internal-prefix string	Устарело, переименуйте в internal_prefix. Поддерживает метапеременную Внутренняя длина префикса NPTv6
name string / required	Имя пула IPv6 IP-адресов.

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 / elements=integer	Список rc-кодов, при которых условия будут переопределены на отказ.
rc_succeeded list / elements=integer	Список rc-кодов, при которых условия будут переопределены на успех.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочей области, значение может быть global и другие, включая 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. Вы также можете переопределить условия отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
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_firewall_ippool6_module.html