Модуль fortinet.fortios.fortios_extension_controller_fortigate — конфигурация контроллера FortiGate в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробную информацию см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_extension_controller_fortigate.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции extension_controller и категории fortigate. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
extension_controller_fortigate dictionary | Конфигурация контроллера FortiGate. |
|
authorized string |
Включить или отключить администрирование FortiGate. Варианты:
|
|
description string |
Описание. |
|
device_id integer |
Идентификатор устройства. |
|
hostname string |
Имя хоста FortiGate. |
|
id string |
Серийный номер FortiGate. |
|
name string / обязательный |
Имя записи FortiGate. |
|
profile string |
Конфигурация профиля FortiGate. Источник: extension-controller.fortigate-profile.name. |
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path используется для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: FortiGate controller configuration.
fortinet.fortios.fortios_extension_controller_fortigate:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extension_controller_fortigate:
authorized: "discovered"
description: "<your_own_value>"
device_id: "1026"
hostname: "myhostname"
id: "7"
name: "default_name_8"
profile: "<your_own_value> (source extension-controller.fortigate-profile.name)"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: always Пример: |
http_method string | Последний метод, использованный для передачи данных на FortiGate Возвращается: always Пример: |
http_status string | Результат последней операции, возвращённый FortiGate Возвращается: always Пример: |
mkey string | Главный ключ (id), использованный при последнем обращении к FortiGate Возвращается: success Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: always Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: always Пример: |
revision string | Внутренний номер ревизии Возвращается: always Пример: |
serial string | Серийный номер устройства Возвращается: always Пример: |
status string | Результат выполнения операции Возвращается: always Пример: |
vdom string | Использованный виртуальный домен Возвращается: always Пример: |
version string | Версия FortiGate Возвращается: always Пример: |
Ссылки на коллекцию
© 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_extension_controller_fortigate_module.html