fortinet.fortimanager.fmgr_extendercontroller_simprofile модуль — Контроллер расширения sim профиль

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Новое в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extendercontroller_simprofile словарь	Настройка параметров верхнего уровня.
auto_switch_profile словарь	Устарело, пожалуйста, переименуйте на auto_switch_profile. Автоматический переключение профиля.
dataplan строка	Планирование данных. Варианты: `"disable"` `"enable"`
disconnect строка	Отключение. Варианты: `"disable"` `"enable"`
disconnect_period целое число	Срок отключения.
disconnect_threshold целое число	Пороговое значение отключения.
signal строка	Сигнал. Варианты: `"disable"` `"enable"`
status строка	Статус. Варианты: `"disable"` `"enable"`
switch_back список / элементы=строка	Устарело, пожалуйста, переименуйте на switch_back. Возврат к предыдущему. Варианты: `"time"` `"timer"`
switch_back_time строка	Время возврата к предыдущему.
switch_back_timer целое число	Таймер возврата к предыдущему.
conn_status целое число	Статус подключения.
default_sim строка	По умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
description строка	Описание.
gps строка	GPS. Варианты: `"disable"` `"enable"`
modem_id целое число	Идентификатор модема.

END_OF_DOCUMENT_MARKER

Имя строка / обязательно	Имя.
preferred-carrier строка	Устарело, пожалуйста, переименуйте на preferred_carrier. Предпочтительный носитель.
redundant-intf строка	Устарело, пожалуйста, переименуйте на redundant_intf. Резервный интерфейс.
redundant-mode строка	Устарело, пожалуйста, переименуйте на redundant_mode. Резервный режим. Варианты: `"disable"` `"enable"`
sim1-pin строка	Устарело, пожалуйста, переименуйте на sim1_pin. PIN кода SIM1. Варианты: `"disable"` `"enable"`
sim1-pin-code любой	(список) Устарело, пожалуйста, переименуйте на sim1_pin_code. Код PIN SIM1.
sim2-pin строка	Устарело, пожалуйста, переименуйте на sim2_pin. PIN кода SIM2. Варианты: `"disable"` `"enable"`
sim2-pin-code любой	(список) Устарело, пожалуйста, переименуйте на sim2_pin_code. Код PIN SIM2.
Статус строка	Статус. Варианты: `"disable"` `"enable"`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с помощью которых будут переопределены условия для завершения с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с помощью которых будут переопределены условия для успешного завершения.
состояние строка / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы будете получать предупреждения о устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочего пространства реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой 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: Extender controller sim profile
      fortinet.fortimanager.fmgr_extendercontroller_simprofile:
        # 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: present # <value in [present, absent]>
        extendercontroller_simprofile:
          auto_switch_profile:
            dataplan: <value in [disable, enable]>
            disconnect: <value in [disable, enable]>
            disconnect_period: <integer>
            disconnect_threshold: <integer>
            signal: <value in [disable, enable]>
            status: <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, ...]>
          description: <string>
          gps: <value in [disable, enable]>
          modem_id: <integer>
          name: <string>
          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>
          status: <value in [disable, enable]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_extendercontroller_simprofile_module.html