Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_router_community_list – Настройка списков сообществ в FortiOS и FortiGate Fortinet.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в книге задач укажите: fortinet.fortios.fortios_router_community_list.

Добавлен в fortinet.fortios 2.0.0

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

Обзор

  • Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры маршрутизатора и категорию community_list. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Сгенерировано из интерфейса Fortigate.

enable_log

булево

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для обработки.

Разделяется символом «/», если атрибутов более одного.

Параметр, помеченный member_path, является допустимым для выполнения операции над членом.

member_state

строка

Добавить или удалить члена по указанному пути к атрибуту.

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

router_community_list

словарь

Настройка списков сообществ.

name

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

Имя списка сообществ.

rule

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

Правило списка сообществ.

action

строка

Разрешить или запретить операции на основе маршрута, основанные на атрибуте COMMUNITY маршрута.

Варианты:

  • "deny"
  • "permit"

id

целое число / обязательно

ИД. См. <Примечания>.

match

строка

Спецификации сообщества для сопоставления с зарезервированным сообществом.

regexp

строка

Упорядоченный список атрибутов COMMUNITY в виде регулярного выражения.

type

строка

Тип списка сообществ (стандартный или расширенный).

Варианты:

  • "standard"
  • "expanded"

state

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

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

строка

Виртуальная область (vdom), определенная ранее. Vdom – виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi предпочтительнее для выполнения книг задач.
  • Модуль поддерживает режим проверки (check_mode).

Примеры

- name: Configure community lists.
  fortinet.fortios.fortios_router_community_list:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_community_list:
          name: "default_name_3"
          rule:
              -
                  action: "deny"
                  id: "6"
                  match: "<your_own_value>"
                  regexp: "<your_own_value>"
          type: "standard"

Значения возврата

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

Ключ

Описание

build

строка

Номер сборки образа fortigate

Возвращается: всегда

Пример: "1547"

http_method

строка

Последний метод, используемый для предоставления контента в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

строка

Последний результат, предоставленный FortiGate после последней операции

Возвращается: всегда

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

Возвращается: успех

Пример: "id"

name

строка

Имя таблицы, используемой для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

строка

Путь таблицы, используемой для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

строка

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

Возвращается: всегда

Пример: "success"

vdom

строка

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

строка

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на сборку

  • Система отслеживания проблем
  • Главная страница
  • Репозиторий (исходные коды)

© 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/fortios/fortios_router_community_list_module.html

Spec-Zone.ru

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