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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extendercontroller_simprofile dictionary	Параметры верхнего уровня.
auto_switch_profile псевдонимы: auto-switch_profile dictionary	Профиль автоматического переключения.
dataplan string	Тарифный план передачи данных. Варианты: `"disable"` `"enable"`
disconnect string	Отключение. Варианты: `"disable"` `"enable"`
disconnect_period псевдонимы: disconnect-period integer	Период отключения.
disconnect_threshold псевдонимы: disconnect-threshold integer	Порог отключения.
signal string	Сигнал. Варианты: `"disable"` `"enable"`
status string	Состояние. Варианты: `"disable"` `"enable"`
switch_back псевдонимы: switch-back list / elements=string	Обратное переключение. Варианты: `"time"` `"timer"`
switch_back_time псевдонимы: switch-back-time string	Время обратного переключения.
switch_back_timer псевдонимы: switch-back-timer integer	Таймер обратного переключения.
conn_status псевдонимы: conn-status integer	Состояние подключения.
default_sim псевдонимы: default-sim string	SIM-карта по умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
description string	Описание.
gps string	GPS. Варианты: `"disable"` `"enable"`
modem_id псевдонимы: modem-id integer	Идентификатор модема.
name string / обязательный	Имя.
preferred_carrier псевдонимы: preferred-carrier string	Предпочитаемый оператор связи.
redundant_intf псевдонимы: redundant-intf string	Резервный интерфейс.
redundant_mode псевдонимы: redundant-mode string	Режим резервирования. Варианты: `"disable"` `"enable"`
sim1_pin псевдонимы: sim1-pin string	PIN-код SIM1. Варианты: `"disable"` `"enable"`
sim1_pin_code псевдонимы: sim1-pin-code any	(список) PIN-код SIM1.
sim2_pin псевдонимы: sim2-pin string	PIN-код SIM2. Варианты: `"disable"` `"enable"`
sim2_pin_code псевдонимы: sim2-pin-code any	(список) PIN-код SIM2.
status string	Состояние. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие значения, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Extender controller sim profile
      fortinet.fortimanager.fmgr_extendercontroller_simprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        extendercontroller_simprofile:
          name: "your value" # Required variable, string
          # 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>
          # 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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Состояние запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Сведения о целевой системе. Возвращается: всегда
rc integer	Состояние запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_extendercontroller_simprofile_module.html