Spec-Zone.ru › Ansible

fortinet.fortios.fortios_nsxt_service_chain module – Настройка цепочки служб NSX-T в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_nsxt_service_chain.

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

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

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

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

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path подходит для выполнения операций с элементами.

member_state

string

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

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

nsxt_service_chain

dictionary

Настройка цепочки служб NSX-T.

id

integer / обязательный

Идентификатор цепочки. См. <a href=’#notes’>Примечания</a>.

name

string

Имя цепочки.

service_index

list / элементы=dictionary

Настройка индекса службы.

id

integer / обязательный

Индекс службы. См. <a href=’#notes’>Примечания</a>.

name

string

Имя индекса.

reverse_index

integer

Обратный индекс службы.

vd

string

Имя VDOM. Источник: system.vdom.name.

state

string / обязательный

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

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

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

Примечания

Примечание

  • Мы настоятельно рекомендуем использовать собственное значение для id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, однако у этого варианта есть ограничения. Подробную информацию см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска сценариев — httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure NSX-T service chain.
  fortinet.fortios.fortios_nsxt_service_chain:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      nsxt_service_chain:
          id: "3"
          name: "default_name_4"
          service_index:
              -
                  id: "6"
                  name: "default_name_7"
                  reverse_index: "1"
                  vd: "<your_own_value> (source system.vdom.name)"

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

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

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

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

Пример: "PUT"

http_status

string

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

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

Пример: "200"

mkey

string

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

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

Пример: "id"

name

string

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

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

Пример: "urlfilter"

path

string

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

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

Пример: "webfilter"

revision

string

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

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

Пример: "17.0.2.10658"

serial

string

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

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

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

Пример: "success"

vdom

string

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

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

Пример: "root"

version

string

Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_nsxt_service_chain_module.html

Spec-Zone.ru

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