fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings модуль — Настройка интегрированных параметров FortiLink для FortiSwitch.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings.
Новое в fortinet.fortimanager 2.2.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 строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
switchcontroller_fortilinksettings словарь | Набор параметров верхнего уровня. |
|
access-vlan-mode строка |
Устаревшее, переименуйте на access_vlan_mode. Поведение трафика внутри VLAN с потерей подключения к FortiGate. Варианты:
|
|
fortilink строка |
Интерфейс FortiLink, к которому принадлежит данная настройка fortilink. |
|
inactive-timer целое число |
Устаревшее, переименуйте на inactive_timer. Промежуток времени. |
|
link-down-flush строка |
Устаревшее, переименуйте на link_down_flush. Очистка NAC и динамических устройств на портах коммутатора при событии отключения связи. Варианты:
|
|
nac-ports словарь |
Устаревшее, переименуйте на nac_ports. Порты NAC. |
|
bounce-nac-port строка |
Устаревшее, переименуйте на bounce_nac_port. Включить/выключить переподключение. Варианты:
|
|
lan-segment строка |
Устаревшее, переименуйте на lan_segment. Включить/выключить функцию LAN сегмента на интерфейсе FortiLink. Варианты:
|
|
member-change целое число |
Устаревшее, переименуйте на member_change. Изменение участника. |
|
nac-lan-interface строка |
Устаревшее, переименуйте на nac_lan_interface. Настройка интерфейса NAC LAN. |
|
nac-segment-vlans any |
(list) Устаревшее, пожалуйста, переименуйте на nac_segment_vlans. Настройка VLAN сегментов NAC. |
|
onboarding-vlan string |
Устаревшее, пожалуйста, переименуйте на onboarding_vlan. Значение VLAN по умолчанию для onboarding NAC устройств. |
|
parent-key string |
Устаревшее, пожалуйста, переименуйте на parent_key. Родительский ключ. |
|
name string / обязательно |
Имя настроек FortiLink. |
workspace_locking_adom string | ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая root. |
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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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: Configure integrated FortiLink settings for FortiSwitch.
fortinet.fortimanager.fmgr_switchcontroller_fortilinksettings:
# 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]>
switchcontroller_fortilinksettings:
fortilink: <string>
inactive_timer: <integer>
link_down_flush: <value in [disable, enable]>
nac_ports:
lan_segment: <value in [disabled, enabled]>
member_change: <integer>
nac_lan_interface: <string>
nac_segment_vlans: <list or string>
onboarding_vlan: <string>
parent_key: <string>
bounce_nac_port: <value in [disable, enable]>
name: <string>
access_vlan_mode: <value in [legacy, fail-open, fail-close]>
Значения возврата
Общие значения возврата описаны здесь. Ниже приведены поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_switchcontroller_fortilinksettings_module.html