модуль fortinet.fortimanager.fmgr_devprof_system_template_interface — интерфейс системного шаблона системного шаблона

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрошенном URL.
devprof_system_template_interface dictionary	Параметры верхнего уровня.
action string	Действие. Варианты: `"add-aggregate"` `"add-loopback"` `"add-vlan"` `"add-zone"` `"conf-intf"` `"conf-dhcp-server"` `"conf-monitor-bandwd"` `"conf-vap-ssid"`
allowaccess list / элементы=string	Разрешённый доступ. Варианты: `"https"` `"ping"` `"ssh"` `"snmp"` `"http"` `"telnet"` `"fgfm"` `"radius-acct"` `"probe-response"` `"dnp"` `"ftm"` `"fabric"` `"speed-test"`
dhcp_id псевдонимы: dhcp-id integer	Поддерживает метапеременную
gateway string	Поддерживает метапеременную
interface string	Поддерживает метапеременную
interface_members псевдонимы: interface-members list / элементы=string	Поддерживает метапеременную
ip_range псевдонимы: ip-range list / элементы=dictionary	Диапазон IP-адресов.
end_ip псевдонимы: end-ip string	Конечный IP-адрес.
id integer	Идентификатор.
start_ip псевдонимы: start-ip string	Начальный IP-адрес.
ipmask list / элементы=string	Поддерживает метапеременную
model string	Модель.
monitor_bandwidth псевдонимы: monitor-bandwidth string	Мониторинг пропускной способности. Варианты: `"disable"` `"enable"`
name string / обязательный	Поддерживает метапеременную
netmask string	Поддерживает метапеременную
role string	Роль. Варианты: `"lan"` `"wan"` `"dmz"` `"undefined"`
seq integer	Порядковый номер.
vdom string	Поддерживает метапеременную
vlan_id псевдонимы: vlan-id integer	Поддерживает метапеременную
wifi_key псевдонимы: wifi-key list / элементы=string	Ключ Wi-Fi.
wifi_security псевдонимы: wifi-security string	Безопасность Wi-Fi. Варианты: `"None"` `"wep64"` `"wep128"` `"WPA_PSK"` `"WPA_RADIUS"` `"WPA"` `"WPA2"` `"WPA2_AUTO"` `"open"` `"wpa-personal"` `"wpa-enterprise"` `"captive-portal"` `"wpa-only-personal"` `"wpa-only-enterprise"` `"wpa2-only-personal"` `"wpa2-only-enterprise"` `"wpa-personal+captive-portal"` `"wpa-only-personal+captive-portal"` `"wpa2-only-personal+captive-portal"` `"osen"` `"wpa3-enterprise"` `"sae"` `"sae-transition"` `"owe"` `"wpa3-sae"` `"wpa3-sae-transition"` `"wpa3-only-enterprise"` `"wpa3-enterprise-transition"`
wifi_ssid псевдонимы: wifi-ssid string	Поддерживает метапеременную
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
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: System template system template interface
      fortinet.fortimanager.fmgr_devprof_system_template_interface:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        state: present # <value in [present, absent]>
        devprof_system_template_interface:
          name: "your value" # Required variable, string
          # action: <value in [add-aggregate, add-loopback, add-vlan, ...]>
          # allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet", "fgfm", "radius-acct",
          #               "probe-response", "dnp", "ftm", "fabric", "speed-test"]
          # dhcp_id: <integer>
          # gateway: <string>
          # interface: <string>
          # interface_members: <list or string>
          # ip_range:
          #   - end_ip: <string>
          #     id: <integer>
          #     start_ip: <string>
          # ipmask: <list or string>
          # model: <string>
          # monitor_bandwidth: <value in [disable, enable]>
          # netmask: <string>
          # role: <value in [lan, wan, dmz, ...]>
          # seq: <integer>
          # vdom: <string>
          # vlan_id: <integer>
          # wifi_key: <list or string>
          # wifi_security: <value in [None, wep64, wep128, ...]>
          # wifi_ssid: <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_devprof_system_template_interface_module.html