fortinet.fortimanager.fmgr_wagprofile модуль — Настройка беспроводного шлюза доступа
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_wagprofile.
Добавлен в fortinet.fortimanager 2.1.0
Описание
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список кодов rc, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
wagprofile словарь | Набор параметров верхнего уровня. |
|
comment строка |
Комментарий. |
|
dhcp_ip_addr строка |
Устарело, переименуйте на dhcp_ip_addr. IP-адрес пакета мониторинга DHCP-запроса, отправленного через туннель. |
|
name строка / обязательно |
Имя профиля туннеля. |
|
ping_interval целое |
Устарело, переименуйте на ping_interval. Интервал между двумя пакетами эха мониторинга туннеля. |
|
ping_number целое |
Устарело, переименуйте на ping_number. Количество пакетов эха мониторинга туннеля. |
|
return_packet_timeout целое |
Устарело, переименуйте на return_packet_timeout. Время ожидания пакетов возврата от удалённого конца туннелей. |
|
tunnel_type строка |
Устарело, переименуйте на tunnel_type. Тип туннеля. Варианты:
|
|
wag_ip строка |
Устарело, переименуйте на wag_ip. IP-адрес беспроводного шлюза доступа. |
|
wag_port целое |
Устарело, переименуйте на wag_port. UDP-порт беспроводного шлюза доступа. |
workspace_locking_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 помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно запуск одного модуля может завершиться ошибкой, когда возвращается код ошибки, отличный от нуля. Вы также можете переопределить условия ошибки или успеха с помощью параметров 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: Configure wireless access gateway
fortinet.fortimanager.fmgr_wagprofile:
# 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]>
wagprofile:
comment: <string>
dhcp_ip_addr: <string>
name: <string>
ping_interval: <integer>
ping_number: <integer>
return_packet_timeout: <integer>
tunnel_type: <value in [gre, l2tpv3]>
wag_ip: <string>
wag_port: <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_wagprofile_module.html
