fortinet.fortios.fortios_switch_controller_custom_command – Настройка контроллера коммутатора FortiGate для отправки пользовательских команд управляемым устройствам FortiSwitch в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин является частью коллекции fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в playbook, укажите: fortinet.fortios.fortios_switch_controller_custom_command.
В версии 2.9: коллекции fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры функции switch_controller и категорию custom_command. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано на FOS v6.0.0.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_token строка | Авторизация на основе токена. Сгенерировано из графического интерфейса Fortigate. | ||
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | |
| switch_controller_custom_command словарь | Настройка контроллера коммутатора FortiGate для отправки пользовательских команд управляемым устройствам FortiSwitch. | ||
| command строка | Строка команд для отправки устройствам FortiSwitch (например, (%0a = клавиша возврата): config switch trunk %0a edit myTrunk %0a set members port1 port2 %0a end %0a). | ||
| command_name строка | Имя команды, вызываемой контроллером коммутатора FortiGate в команде execute. | ||
| description строка | Описание. | ||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область (vdom) из тех, которые были определены ранее. Vdom — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. | |
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks.
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices.
fortios_switch_controller_custom_command:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_custom_command:
command: "<your_own_value>"
command_name: "<your_own_value>"
description: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа fortigate. Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для предоставления контента в FortiGate. Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate по последней примененной операции. Пример: 200 |
| mkey строка | успех | Главный ключ (идентификатор), используемый в последнем запросе к FortiGate. Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса. Пример: urlfilter |
| path строка | всегда | Путь к таблице, используемой для выполнения запроса. Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии. Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства. Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции. Пример: успех |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_switch_controller_custom_command_module.html
