Модуль fortinet.fortios.fortios_wireless_controller_ap_status — Настройка состояния точки доступа (rogue | accepted | suppressed) в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в playbook укажите: fortinet.fortios.fortios_wireless_controller_ap_status.
Добавлена в fortinet.fortios 2.0.0
Описание
- Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять функцию wireless_controller и категорию ap_status. Примеры включают все параметры и значения, которые необходимо настроить перед использованием. Тестировалось на FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log логическое значение | Включить/отключить логирование задачи. Выбооры:
|
member_path строка | Путь к атрибуту элемента для работы. Разделяется слешем, если атрибутов более одного. Параметр, помеченный как member_path, подходит для выполнения операций с элементами. |
member_state строка | Добавить или удалить элемент в указанном пути к атрибуту. При указании member_state опция state игнорируется. Выбооры:
|
state строка / обязательный | Указывает, нужно ли создать или удалить объект. Выбооры:
|
vdom строка | Виртуальная область (vdom), определённая ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
wireless_controller_ap_status словарь | Настроить состояние точки доступа (rogue | accepted | suppressed). |
|
bssid строка |
BSSID точки доступа (AP). |
|
id целое число / обязательный |
ID точки доступа. См. <Примечания>. |
|
ssid строка |
SSID точки доступа (AP). |
|
status строка |
Статус точки доступа (AP): rogue, accepted или supressed. Выбооры:
|
Примечания
Примечание
- Настоятельно рекомендуется использовать собственное значение в качестве id вместо 0. Хотя «0» является специальным маркером, позволяющим бэкенду назначить последнее доступное число для объекта, он имеет ограничения. Дополнительную информацию см. в разделе «Вопросы и ответы».
- Модуль legacy fortiosapi устарел, httpapi является предпочтительным способом запуска playbooks
- Модуль поддерживает режим check_mode.
Примеры
- name: Configure access point status (rogue | accepted | suppressed).
fortinet.fortios.fortios_wireless_controller_ap_status:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_ap_status:
bssid: "<your_own_value>"
id: "4"
ssid: "<your_own_value>"
status: "rogue"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
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_ap_status_module.html