fortinet.fortimanager.fmgr_switchcontroller_managedswitch_customcommand – Способ конфигурации для редактирования команд FortiSwitch, которые должны быть отправлены на это устройство FortiSwitch при перезагрузке контроллера коммутатора FortiGate…

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в версии 2.10: от fortinet.fortimanager

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

Обзор

Этот модуль способен настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean	Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
device string / required		параметр (device) в запрошенном URL
managed-switch string / required		параметр (managed-switch) в запрошенном URL
rc_failed list / elements=string		список rc-кодов, при которых условия будут считаться ошибочными
rc_succeeded list / elements=string		список rc-кодов, при которых условия будут считаться выполненными
state string / required	Варианты: present absent	направление для создания, обновления или удаления объекта
vdom string / required		параметр (vdom) в запрошенном URL
workspace_locking_adom string		область для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой
workspace_locking_timeout integer	Значение по умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте состояние present.
Для удаления объекта используйте состояние absent.
Обычно запуск одного модуля может завершиться ошибкой при возвращении ненулевого rc. Также можно переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configuration method to edit FortiSwitch commands to be pushed to this FortiSwitch device upon rebooting the FortiGate switch controller...
     fmgr_switchcontroller_managedswitch_customcommand:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        managed-switch: <your own value>
        state: <value in [present, absent]>

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_switchcontroller_managedswitch_customcommand_module.html