fortios_switch_controller_custom_command – Настройка контроллера коммутатора FortiGate для отправки пользовательских команд управляемым устройствам FortiSwitch в FortiOS и FortiGate компании Fortinet
Новая версия 2.9.
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию switch_controller и категорию custom_command. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | ||
| https логическое значение |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |
| ssl_verify логическое значение |
| Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации. | |
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | |
| switch_controller_custom_command словарь | Значение по умолчанию: null | Настройте контроллер коммутатора FortiGate для отправки пользовательских команд управляемым устройствам FortiSwitch. | |
| command строка | Строка команд для отправки устройствам FortiSwitch (например, (%0a = клавиша возврата): config switch trunk %0a edit myTrunk %0a set members port1 port2 %0a end %0a). | ||
| command_name строка | Имя команды, вызываемой контроллером коммутатора FortiGate в команде выполнения. | ||
| description строка | Описание. | ||
| username строка | Имя пользователя FortiOS или FortiGate. | ||
| vdom строка | Значение по умолчанию: "root" | Виртуальная область, среди тех, которые были определены ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | |
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная компанией Fortinet
- Выполняется как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices.
fortios_switch_controller_custom_command:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
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 строка | успешно | Главный ключ (id), использованный в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успешно |
| vdom строка | всегда | Используемая виртуальная область Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/fortios_switch_controller_custom_command_module.html