Модуль fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy — Настройка политики VLAN для применения к портам управляемого FortiSwitch через политику dynamic-port-policy.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
У вас может быть уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy.
Новинка в 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_vlanpolicy словарь | Настройка параметров верхнего уровня. |
|
allowed-vlans любой |
(список) Устарело, пожалуйста, переименуйте на allowed_vlans. Разрешённые VLAN, применяемые при использовании этой политики VLAN. |
|
allowed-vlans-all строка |
Устарело, пожалуйста, переименуйте на allowed_vlans_all. Включение/выключение всех определённых VLAN при использовании этой политики VLAN. Варианты:
|
|
description строка |
Описание политики VLAN. |
|
discard-mode строка |
Устарело, пожалуйста, переименуйте на discard_mode. Режим удаления, применяемый при использовании этой политики VLAN. Варианты:
|
|
fortilink любой |
(список) Интерфейс FortiLink, к которому относится данная политика VLAN. |
|
name строка / обязательно |
Имя политики VLAN. |
|
untagged-vlans любой |
(список) Устарело, пожалуйста, переименуйте на untagged_vlans. VLAN без тегов, применяемые при использовании этой политики VLAN. |
|
vlan строка |
Базовая VLAN, применяемая при использовании этой политики VLAN. |
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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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 VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy:
# 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_vlanpolicy:
allowed_vlans: <list or string>
allowed_vlans_all: <value in [disable, enable]>
description: <string>
discard_mode: <value in [none, all-untagged, all-tagged]>
name: <string>
untagged_vlans: <list or string>
vlan: <string>
fortilink: <list or string>
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
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_vlanpolicy_module.html
