Модуль fortinet.fortios.fortios_switch_controller_custom_command – Настройка контроллера коммутаторов FortiGate для отправки пользовательских команд на управляемые устройства FortiSwitch в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_switch_controller_custom_command.

Новая функция в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в GUI Fortigate.
enable_log логическое	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом «/», если атрибутов больше одного. Параметр, помеченный member_path, является допустимым для выполнения операции с членами.
member_state строка	Добавить или удалить члена по указанному пути атрибута. Если member_state указан, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
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 в команде выполнения.
description строка	Описание.
vdom строка	Виртуальная область, из ранее определенных. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревший fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks
Модуль поддерживает режим check_mode.

Примеры

- name: Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices.
  fortinet.fortios.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 строка	Главный ключ (id), используемый в последнем вызове FortiGate Возвращаемое значение: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращаемое значение: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, используемой для выполнения запроса Возвращаемое значение: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращаемое значение: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращаемое значение: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращаемое значение: всегда Пример: `"success"`
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_custom_command_module.html