Модуль fortinet.fortios.fortios_wireless_controller_region — Настройка областей FortiAP (для планов этажей и карт) в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в плейбуке укажите: fortinet.fortios.fortios_wireless_controller_region.
Добавлена в fortinet.fortios 2.0.0
Обзор
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры беспроводного контроллера и категории областей. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.0
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Создается в графическом интерфейсе Fortigate. |
enable_log логический тип | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом слэша, если атрибутов несколько. Параметр с member_path подходит для выполнения операции с членом. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. Когда member_state задан, опция state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom строка | Виртуальная область, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которая может настраиваться и использоваться как отдельное устройство. По умолчанию: |
wireless_controller_region словарь | Настройка областей FortiAP (для планов этажей и карт). |
|
comments строка |
Комментарии. |
|
grayscale строка |
Оттенки серого изображения области. Варианты:
|
|
image_type строка |
Тип изображения области FortiAP (png|jpeg|gif). Варианты:
|
|
name строка / обязательно |
Имя области FortiAP. |
|
opacity целое число |
Непрозрачность изображения области (0 - 100). |
Примечания
Примечание
- Модуль legacy fortiosapi устарел, httpapi является предпочтительным способом выполнения плейбуков
- Модуль поддерживает check_mode.
Примеры
- name: Configure FortiAP regions (for floor plans and maps).
fortinet.fortios.fortios_wireless_controller_region:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_region:
comments: "<your_own_value>"
grayscale: "enable"
image_type: "png"
name: "default_name_6"
opacity: "100"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate после последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекции
© 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/fortios/fortios_wireless_controller_region_module.html