Модуль fortinet.fortimanager.fmgr_switchcontroller_managedswitch_systeminterface — настройка системного интерфейса на FortiSwitch.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_systeminterface.

Добавлено в fortinet.fortimanager 2.12.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
managed-switch string	Устарел, используйте «managed_switch»
managed_switch string	Параметр (managed-switch) в запрашиваемом URL.
proposed_method string	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
switchcontroller_managedswitch_systeminterface dictionary	Набор параметров верхнего уровня.
allowaccess list / элементы=string	Разрешенные типы доступа к управлению этим интерфейсом. Варианты: `"https"` `"ping"` `"ssh"` `"snmp"` `"http"` `"telnet"` `"radius-acct"`
interface list / элементы=string	Имя интерфейса.
ip list / элементы=string	IP-адрес и маска для этого интерфейса.
mode string	Режим адресации интерфейса. Варианты: `"static"` `"dhcp"`
name string / обязательный	Имя интерфейса.
status string	Включить или отключить интерфейс. Варианты: `"disable"` `"enable"`
switch_id псевдонимы: switch-id list / элементы=string	Идентификатор коммутатора.
type string	Тип интерфейса. Варианты: `"physical"` `"vlan"`
vlan list / элементы=string	Имя VLAN.
vrf list / элементы=string	VRF для этого маршрута.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. В качестве значения можно указать global и другие ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для имен всех входных аргументов используется соглашение с нижним подчеркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочего пространства. Для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается с ошибкой при возврате ненулевого rc. Условия сбоя или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure system interface on FortiSwitch.
      fortinet.fortimanager.fmgr_switchcontroller_managedswitch_systeminterface:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        managed_switch: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_managedswitch_systeminterface:
          name: "your value" # Required variable, string
          # allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "radius-acct"]
          # interface: <list or string>
          # ip: <list or string>
          # mode: <value in [static, dhcp]>
          # status: <value in [disable, enable]>
          # switch_id: <list or string>
          # type: <value in [physical, vlan]>
          # vlan: <list or string>
          # vrf: <list or string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_switchcontroller_managedswitch_systeminterface_module.html