fortinet.fortimanager.fmgr_user_device_dynamicmapping модуль — Настройка устройств.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_user_device_dynamicmapping.
Добавлен в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
device строка / обязательно | Параметр (device) в запрошенном URL. |
enable_log логическое | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, при которых условия будут переопределены для отказа. |
rc_succeeded список / элементы=целое число | Список rc-кодов, при которых условия будут переопределены для успеха. |
state строка / обязательно | Направление создания, обновления или удаления объекта. Варианты:
|
user_device_dynamicmapping словарь | Параметры верхнего уровня. |
|
_scope список / элементы=словарь |
Область. |
|
name строка |
Имя. |
|
vdom строка |
Vdom. |
|
avatar строка |
Аватар. |
|
category строка |
Категория. Варианты:
|
|
comment строка |
Комментарий. |
|
family строка |
Семейство. |
|
hardware_vendor строка |
Устарело, пожалуйста, переименуйте в hardware_vendor. Производитель оборудования. |
|
hardware_version строка |
Устарело, пожалуйста, переименуйте в hardware_version. Версия оборудования. |
|
mac строка |
Mac. |
|
master_device строка |
Устарело, пожалуйста, переименуйте в master_device. Мастер-устройство. |
|
os строка |
Os. |
|
software-version string |
Устаревший, пожалуйста, переименуйте его в software_version. Версия ПО. |
|
tags any |
(список или строка) Тэги. |
|
type string |
Тип. Выбо:
|
|
user string |
Пользователь. |
workspace_locking_adom string | ADOM для блокировки в режиме работы FortiManager в рабочем пространстве, значение может быть глобальным и другими, включая 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 помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure dynamic mappings
fortinet.fortimanager.fmgr_user_device_dynamicmapping:
bypass_validation: false
adom: ansible
device: ansible-test-device # alias
state: present
user_device_dynamicmapping:
_scope:
- name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
category: none # <value in [none, android-device, blackberry-device, ...]>
comment: ansible-comment
mac: "00:11:22:33:44:55"
type: iphone # <value in [ipad, iphone, gaming-console, ...]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the dynamic mappings
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_device_dynamicmapping"
params:
adom: "ansible"
device: "ansible-test-device" # alias
dynamic_mapping: "your_value"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_user_device_dynamicmapping_module.html
