fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem1 модуль – Параметры конфигурации модема 1.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem1.
Добавлена в fortinet.fortimanager 2.2.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
extender-profile строка | Устарело, используйте «extender_profile» |
extender_profile строка | Параметр (extender-profile) в запрошенном URL. |
extensioncontroller_extenderprofile_cellular_modem1 словарь | Настройка верхнего уровня. |
|
auto-switch словарь |
Устарело, переименуйте на auto_switch. Автоматический переключение. |
|
dataplan строка |
Автоматическое переключение на основе использования данных. Варианты:
|
|
disconnect строка |
Автоматическое переключение при отключении. Варианты:
|
|
disconnect-period целое число |
Устарело, переименуйте на disconnect_period. Автоматическое переключение на основе периода отключения. |
|
disconnect-threshold целое число |
Устарело, переименуйте на disconnect_threshold. Автоматическое переключение на основе порога отключения. |
|
signal строка |
Автоматическое переключение на основе силы сигнала. Варианты:
|
|
switch-back список / элементы=строка |
Устарело, переименуйте на switch_back. Автоматическое переключение с вариантами обратного переключения. Варианты:
|
|
switch-back-time строка |
Устарело, переименуйте на switch_back_time. Автоматическое переключение на предпочтительную SIM-карту/оператора в у… |
|
switch-back-timer целое число |
Устарело, переименуйте на switch_back_timer. Автоматическое переключение на предпочтительную SIM-карту/оператора п… |
|
conn-status целое число |
Устарело, переименуйте на conn_status. Состояние подключения. |
|
default-sim строка |
Устарело, переименуйте на default_sim. Выбор по умолчанию SIM-карты. Варианты:
|
|
gps строка |
Включение/выключение GPS FortiExtender. Варианты:
|
|
modem-id integer |
Устаревшее, пожалуйста, переименуйте на modem_id. Идентификатор модема. |
|
preferred-carrier string |
Устаревшее, пожалуйста, переименуйте на preferred_carrier. Предпочитаемый оператор. |
|
redundant-intf string |
Устаревшее, пожалуйста, переименуйте на redundant_intf. Резервный интерфейс. |
|
redundant-mode string |
Устаревшее, пожалуйста, переименуйте на redundant_mode. Режим FortiExtender. Варианты:
|
|
sim1-pin string |
Устаревшее, пожалуйста, переименуйте на sim1_pin. SIM Варианты:
|
|
sim1-pin-code any |
(список) Устаревшее, пожалуйста, переименуйте на sim1_pin_code. SIM |
|
sim2-pin string |
Устаревшее, пожалуйста, переименуйте на sim2_pin. SIM Варианты:
|
|
sim2-pin-code any |
(список) Устаревшее, пожалуйста, переименуйте на sim2_pin_code. SIM |
forticloud_access_token string | Аутентифицировать Ansible-клиент с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список rc кодов, с помощью которых будут переопределены условия для завершения работы с ошибкой. |
rc_succeeded list / elements=integer | Список rc кодов, с помощью которых будут переопределены условия для успешного завершения. |
workspace_locking_adom string | ADOM для блокировки в режиме работы в рабочем пространстве FortiManager, значение может быть глобальным и другими, включая корень. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configuration options for modem 1.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_cellular_modem1:
# 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>
extender_profile: <your own value>
extensioncontroller_extenderprofile_cellular_modem1:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <value in [disable, enable]>
switch_back:
- time
- timer
switch_back_time: <string>
switch_back_timer: <integer>
conn_status: <integer>
default_sim: <value in [sim1, sim2, carrier, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
preferred_carrier: <string>
redundant_intf: <string>
redundant_mode: <value in [disable, enable]>
sim1_pin: <value in [disable, enable]>
sim1_pin_code: <list or string>
sim2_pin: <value in [disable, enable]>
sim2_pin_code: <list or string>
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекции
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_extensioncontroller_extenderprofile_cellular_modem1_module.html
