модуль fortinet.fortios.fortios_system_geneve — настройка устройств GENEVE в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_geneve.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя системные функции и категорию geneve. Примеры содержат все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Проверено с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path предназначен для выполнения операций с элементами. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
system_geneve dictionary | Настройка устройств GENEVE. |
|
dstport integer |
Порт назначения GENEVE (1–65535). |
|
interface string |
Исходящий интерфейс для инкапсулированного трафика GENEVE. Источник: system.interface.name. |
|
ip_version string |
Версия IP для интерфейса GENEVE и связи через GENEVE. Одноадресный IPv4 или IPv6. Варианты:
|
|
name string / обязательный |
Имя устройства или интерфейса GENEVE. Имя интерфейса должно быть уникальным. |
|
remote_ip string |
IPv4-адрес интерфейса GENEVE на устройстве, расположенном на удалённом конце туннеля GENEVE. |
|
remote_ip6 string |
IPv6-адрес интерфейса GENEVE на устройстве, расположенном на удалённом конце туннеля GENEVE. |
|
type string |
Тип GENEVE. Варианты:
|
|
vni integer |
Идентификатор сети GENEVE. |
vdom string | Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure GENEVE devices.
fortinet.fortios.fortios_system_geneve:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_geneve:
dstport: "6081"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "ipv4-unicast"
name: "default_name_6"
remote_ip: "<your_own_value>"
remote_ip6: "<your_own_value>"
type: "ethernet"
vni: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate после последней выполненной операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_system_geneve_module.html