Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
булево
    Варианты:
  • нет ←
  • да
устанавливается только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
device
строка / обязательно
параметр (device) в запрошенном URL
rc_failed
список / элементы=строка
список кодов rc, при которых условия будут игнорироваться
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия будут игнорироваться
state
строка / обязательно
    Варианты:
  • present
  • absent
директива для создания, обновления или удаления объекта
user_device_dynamicmapping
словарь
установленные параметры верхнего уровня
_scope
список / элементы=строка
без описания
name
строка
без описания
vdom
строка
без описания
avatar
строка
без описания
category
строка
    Варианты:
  • none
  • android-device
  • blackberry-device
  • fortinet-device
  • ios-device
  • windows-device
  • amazon-device
без описания
comment
строка
без описания
mac
строка
без описания
master-device
строка
без описания
tags
строка
без описания
type
строка
    Варианты:
  • ipad
  • iphone
  • gaming-console
  • blackberry-phone
  • blackberry-playbook
  • linux-pc
  • mac
  • windows-pc
  • android-phone
  • android-tablet
  • media-streaming
  • windows-phone
  • fortinet-device
  • ip-phone
  • router-nat-device
  • other-network-device
  • windows-tablet
  • printer
  • forticam
  • fortifone
  • unknown
без описания
user
строка
без описания
workspace_locking_adom
строка
область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root
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_user_device_dynamicmapping:
        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>
        device: <your own value>
        state: <value in [present, absent]>
        user_device_dynamicmapping:
           _scope:
             -
                 name: <value of string>
                 vdom: <value of string>
           avatar: <value of string>
           category: <value in [none, android-device, blackberry-device, ...]>
           comment: <value of string>
           mac: <value of string>
           master-device: <value of string>
           tags: <value of string>
           type: <value in [ipad, iphone, gaming-console, ...]>
           user: <value of string>

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

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API