fortinet.fortimanager.fmgr_extendercontroller_simprofile_autoswitchprofile модуль — Контроллер расширения профиль симуляции автоматический переход профиля
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_extendercontroller_simprofile_autoswitchprofile.
Добавлен в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить логирование для задачи. Варианты:
|
extendercontroller_simprofile_autoswitchprofile словарь | Настройка параметров верхнего уровня. |
|
dataplan строка |
Dataplan. Варианты:
|
|
disconnect строка |
Отключение. Варианты:
|
|
disconnect_period целое число |
Устарело, пожалуйста, переименуйте на disconnect_period. Период отключения. |
|
disconnect_threshold целое число |
Устарело, пожалуйста, переименуйте на disconnect_threshold. Порог отключения. |
|
signal строка |
Сигнал. Варианты:
|
|
status строка |
Статус. Варианты:
|
|
switch_back список / элементы=строка |
Устарело, пожалуйста, переименуйте на switch_back. Возврат к предыдущему состоянию. Варианты:
|
|
switch_back_time строка |
Устарело, пожалуйста, переименуйте на switch_back_time. Время возврата к предыдущему состоянию. |
|
switch_back_timer целое число |
Устарело, пожалуйста, переименуйте на switch_back_timer. Таймер возврата к предыдущему состоянию. |
forticloud_access_token строка | Авторизует Ansible клиента с токеном доступа к API forticloud. |
proposed_method строка | Переопределенный метод для запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых выполнение будет прервано. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых выполнение будет завершено успешно. |
sim_profile строка / обязательно | Параметр (sim_profile) в запрошенном URL. |
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Extender controller sim profile auto switch profile
fortinet.fortimanager.fmgr_extendercontroller_simprofile_autoswitchprofile:
# 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>
sim_profile: <your own value>
extendercontroller_simprofile_autoswitchprofile:
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>
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
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_extendercontroller_simprofile_autoswitchprofile_module.html
