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

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логическое значение			Варианты: нет ← да	устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
pkg_path строка / обязательно				параметр (pkg_path) в запрошенном URL
pm_wanprof_pkg словарь				настраиваемые параметры верхнего уровня
	description строка			без описания
	name строка			без описания
	oid целое число			без описания
	scope member список / элементы=строка			без описания
		name строка		без описания
		vdom строка		без описания
	type строка		Варианты: wanprof	без описания
rc_failed список / элементы=строка				список кодов rc, при которых условия будут нарушены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут выполнены
state строка / обязательно			Варианты: present absent	директива для создания, обновления или удаления объекта
workspace_locking_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_pm_wanprof_pkg:
        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>
        pkg_path: <your own value>
        pm_wanprof_pkg:
           description: <value of string>
           name: <value of string>
           oid: <value of integer>
           scope member:
             -
                 name: <value of string>
                 vdom: <value of string>
           type: <value in [wanprof]>

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

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

Ключ	Возвращаемое значение	Описание
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_pm_wanprof_pkg_module.html