fortinet.fortimanager.fmgr_fsp_vlan – без описания

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_fsp_vlan

В версии 2.10: из fortinet.fortimanager

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

Описание

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation логическое значение				Варианты: нет ← да	устанавливается в True только при различиях между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров
fsp_vlan словарь					установленные параметры верхнего уровня
	_dhcp-status строка			Варианты: отключить включить	нет описания
	auth строка			Варианты: radius группа пользователей	нет описания
	color целое число				нет описания
	comments строка				нет описания
	dynamic_mapping список / элементы=строка				нет описания
		_dhcp-status строка		Варианты: отключить включить	нет описания
		_scope список / элементы=строка			нет описания
			name строка		нет описания
			vdom строка		нет описания
	name строка				нет описания
	portal-message-override-group строка				нет описания
	radius-server строка				нет описания
	security строка			Варианты: открытый каптивный портал 8021x	нет описания
	selected-usergroups строка				нет описания
	usergroup строка				нет описания
	vdom строка				нет описания
	vlanid целое число				нет описания
rc_failed список / элементы=строка					список кодов rc, при которых будут игнорироваться условия ошибки
rc_succeeded список / элементы=строка					список кодов rc, при которых будут игнорироваться условия успеха
state строка / обязательно				Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка					adom для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число				Значение по умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Режим блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state 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: no description
     fmgr_fsp_vlan:
        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, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        fsp_vlan:
           _dhcp-status: <value in [disable, enable]>
           auth: <value in [radius, usergroup]>
           color: <value of integer>
           comments: <value of string>
           dynamic_mapping:
             -
                 _dhcp-status: <value in [disable, enable]>
                 _scope:
                   -
                       name: <value of string>
                       vdom: <value of string>
           name: <value of string>
           portal-message-override-group: <value of string>
           radius-server: <value of string>
           security: <value in [open, captive-portal, 8021x]>
           selected-usergroups: <value of string>
           usergroup: <value of string>
           vdom: <value of string>
           vlanid: <value of integer>

Значения возврата

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

Ключ	Возвращается	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_fsp_vlan_module.html