Модуль fortinet.fortimanager.fmgr_router_prefixlist6_rule — правило списка префиксов IPv6.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_router_prefixlist6_rule.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Допустимые значения:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Допустимые значения:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
prefix-list6 string | Устарело, используйте «prefix_list6» |
prefix_list6 string | Параметр (prefix-list6) в запрошенном URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Допустимые значения:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
router_prefixlist6_rule dictionary | Набор параметров верхнего уровня. |
|
action string |
Разрешить или запретить пакеты, соответствующие этому правилу. Допустимые значения:
|
|
flags integer |
Флаги. |
|
ge integer |
Минимальная длина префикса для сопоставления |
|
id integer / обязательный |
Идентификатор правила. |
|
le integer |
Максимальная длина префикса для сопоставления |
|
prefix6 string |
Префикс IPv6 для задания критериев обычной фильтрации, например любого префикса или подсетей. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Допустимые значения:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: IPv6 prefix list rule.
fortinet.fortimanager.fmgr_router_prefixlist6_rule:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
prefix_list6: <your own value>
state: present # <value in [present, absent]>
router_prefixlist6_rule:
id: 0 # Required variable, integer
# action: <value in [permit, deny]>
# flags: <integer>
# ge: <integer>
# le: <integer>
# prefix6: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии сложных условий |
Ссылки на коллекцию
© 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_router_prefixlist6_rule_module.html