fortinet.fortimanager.fmgr_bonjourprofile модуль – Настройка профилей Bonjour.
Примечание
Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_bonjourprofile.
Новая функция в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить согласно источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bonjourprofile словарь | Параметры верхнего уровня. |
|
comment строка |
Комментарий. |
|
micro-location строка |
Устарело, пожалуйста, переименуйте в micro_location. Включение/выключение микроположения для профиля Bonjour Варианты:
|
|
name строка / обязательно |
Имя профиля Bonjour. |
|
policy-list список / элементы=словарь |
Устарело, пожалуйста, переименуйте в policy_list. Список политик. |
|
description строка |
Описание. |
|
from-vlan строка |
Устарело, пожалуйста, переименуйте в from_vlan. Идентификатор VLAN, с которого объявляется Bonjour-сервис |
|
policy-id целое число |
Устарело, пожалуйста, переименуйте в policy_id. Идентификатор политики. |
|
services список / элементы=строка |
Bonjour-сервисы для VLAN, подключенного к Bonjour-сети. Варианты:
|
|
to-vlan строка |
Устарело, пожалуйста, переименуйте в to_vlan. Идентификатор VLAN, которому доступен Bonjour-сервис |
bypass_validation логическое | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Проверка подлинности клиента Ansible с помощью маркера доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми условия отказа будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми условия успеха будут переопределены. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневое. |
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 Bonjour profiles.
fortinet.fortimanager.fmgr_bonjourprofile:
# 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]>
bonjourprofile:
comment: <string>
name: <string>
policy_list:
-
description: <string>
from_vlan: <string>
policy_id: <integer>
services:
- airplay
- afp
- bit-torrent
- ftp
- ichat
- itunes
- printers
- samba
- scanners
- ssh
- chromecast
- all
- miracast
to_vlan: <string>
micro_location: <value in [disable, enable]>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_bonjourprofile_module.html