fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields модуль — Настраиваемые поля datamask.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields.
Новинка в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation булево | Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
profile строка / обязательно | Параметр (profile) в запрошенном URL. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, при которых условие выполнения будет нарушено. |
rc_succeeded список / элементы=целое | Список rc-кодов, при которых условие выполнения будет соблюдено. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
system_admin_profile_datamaskcustomfields словарь | Установленные параметры верхнего уровня. |
|
field-category список / элементы=строка |
Устарело, пожалуйста, переименуйте на field_category. Категории полей. log - Журнал. fortiview - FortiView. alert - Управление событиями. ueba - UEBA. all - Все. Варианты:
|
|
field-name строка / обязательно |
Устарело, пожалуйста, переименуйте на field_name. Имя поля. |
|
field-status строка |
Устарело, пожалуйста, переименуйте на field_status. Статус поля. disable - Отключить поле. enable - Включить поле. Варианты:
|
|
field-type строка |
Устарело, пожалуйста, переименуйте на field_type. Тип поля. string - Строка. ip - IP. mac - MAC-адрес. email - Адрес электронной почты. unknown - Неизвестно. Варианты:
|
workspace_locking_adom строка | 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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Customized datamask fields.
fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields:
bypass_validation: false
profile: ansible-test-profile # profileid
state: present
system_admin_profile_datamaskcustomfields:
field-category:
- log
- fortiview
- alert
- ueba
- all
field-name: ansible-test-mask
field-status: disable
field-type: string # <value in [string, ip, mac, ...]>
- 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 customized datamask fields of admin profile
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_admin_profile_datamaskcustomfields"
params:
profile: "ansible-test-profile" # profileid
datamask-custom-fields: "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_system_admin_profile_datamaskcustomfields_module.html
