Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortimanager.fmgr_router_accesslist6.

Впервые появился в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательно

Параметр (adom) в запрошенном URL.

bypass_validation

булево

Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределенный метод для основного запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, с которыми будут переопределены условия для завершения работы с ошибкой.

rc_succeeded

список / элементы=целое число

Список кодов rc, с которыми будут переопределены условия для успешного завершения работы.

router_accesslist6

словарь

Установленные параметры верхнего уровня.

comments

строка

Комментарий.

name

строка / обязательно

Имя.

rule

список / элементы=словарь

Правило.

action

строка

Разрешить или запретить этот IP-адрес и префикс маски сети.

Варианты:

  • "permit"
  • "deny"

exact_match

строка

Устарело, пожалуйста, переименуйте его в exact_match. Включить/выключить точное совпадение префикса.

Варианты:

  • "disable"
  • "enable"

flags

целое число

Флаги.

id

целое число

Идентификатор правила.

prefix6

строка

IPv6-префикс для определения критериев регулярного фильтра, таких как любые или подсети.

state

строка / обязательно

Направление для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

Область (adom) для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.

workspace_locking_timeout

целое число

Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

По умолчанию: 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 (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 IPv6 access lists.
      fortinet.fortimanager.fmgr_router_accesslist6:
        # 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]>
        router_accesslist6:
          comments: <string>
          name: <string>
          rule:
            -
              action: <value in [permit, deny]>
              exact_match: <value in [disable, enable]>
              flags: <integer>
              id: <integer>
              prefix6: <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_router_accesslist6_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API