Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_hotspot20_anqp3gppcellular – Настройка 3GPP общедоступной сети сотовой связи (PLMN).

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_hotspot20_anqp3gppcellular.

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логическое значение
    Варианты:
  • нет ←
  • да
устанавливать в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
hotspot20_anqp3gppcellular
словарь
установленные параметры верхнего уровня
mcc-mnc-list
список / элементы=строка
нет описания
id
целое число
Идентификатор.
mcc
строка
Код страны мобильной связи.
mnc
строка
Код сети мобильной связи.
name
строка
Имя 3GPP PLMN.
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: Configure 3GPP public land mobile network (PLMN).
     fmgr_hotspot20_anqp3gppcellular:
        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]>
        hotspot20_anqp3gppcellular:
           mcc-mnc-list:
             -
                 id: <value of integer>
                 mcc: <value of string>
                 mnc: <value of string>
           name: <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_hotspot20_anqp3gppcellular_module.html

Spec-Zone.ru

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