Модуль fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy — настройка политики VLAN, применяемой к управляемым портам FortiSwitch с помощью dynamic-port-policy.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
switchcontroller_vlanpolicy dictionary | Набор параметров верхнего уровня. |
|
allowed_vlans псевдонимы: allowed-vlans any |
(список) VLAN, разрешенные для применения с этой политикой VLAN. |
|
allowed_vlans_all псевдонимы: allowed-vlans-all string |
Включить или отключить все определенные VLAN при использовании этой политики VLAN. Варианты:
|
|
description string |
Описание политики VLAN. |
|
discard_mode псевдонимы: discard-mode string |
Режим отбрасывания, применяемый при использовании этой политики VLAN. Варианты:
|
|
fortilink any |
(список) Интерфейс FortiLink, к которому относится эта политика VLAN. |
|
name string / обязательный |
Имя политики VLAN. |
|
untagged_vlans псевдонимы: untagged-vlans any |
(список) VLAN без тегов, применяемые при использовании этой политики VLAN. |
|
vlan string |
Собственный VLAN, применяемый при использовании этой политики VLAN. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое значение, включая 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.
- Обычно выполнение модуля может завершиться ошибкой, если возвращен ненулевой код 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: Configure VLAN policy to be applied on the managed FortiSwitch ports through dynamic-port-policy.
fortinet.fortimanager.fmgr_switchcontroller_vlanpolicy:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
switchcontroller_vlanpolicy:
name: "your value" # Required variable, string
# allowed_vlans: <list or string>
# allowed_vlans_all: <value in [disable, enable]>
# description: <string>
# discard_mode: <value in [none, all-untagged, all-tagged]>
# untagged_vlans: <list or string>
# vlan: <string>
# fortilink: <list or string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: сложный тип |
Ссылки на коллекцию
© 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_switchcontroller_vlanpolicy_module.html
