Модуль fortinet.fortimanager.fmgr_fact — сбор сведений FortiManager.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_fact.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
facts dictionary / обязательный | Сбор сведений FortiManager. |
|
extra_params dictionary |
Дополнительные параметры для каждого селектора. |
|
fields list / elements=any |
Ограничьте вывод, возвращая только атрибуты, указанные в массиве строк. Если атрибуты не указаны, будут возвращены все атрибуты. |
|
filter list / elements=any |
Отфильтруйте результат по набору критериев. |
|
option any |
Задайте параметр получения данных для запроса. Если параметр не указан, по умолчанию будут возвращены атрибуты объектов. Подробнее см. в документации FNDN API. |
|
params dictionary |
Конкретные параметры для каждого селектора. |
|
selector string / обязательный |
Селектор получаемых сведений FortiManager. Варианты: |
|
| |
|
sortings list / elements=any |
Список правил сортировки. Элементы возвращаются в порядке возрастания (1) или убывания (-1) значений полей в списке. |
forticloud_access_token string | Токен доступа пользователей API, управляемых FortiCloud. Этот параметр доступен в FortiManager версии выше 6.4.0. |
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых будут переопределены условия успешного выполнения. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь не снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнять эту задачу.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- 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 scripts
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_script"
params:
adom: "root"
script: ""
- name: Retrive all the interfaces
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_interface"
params:
interface: ""
- name: Retrieve the interface port1
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_interface"
params:
interface: "port1"
- name: Fetch urlfilter with name urlfilter4
fortinet.fortimanager.fmgr_fact:
facts:
selector: "webfilter_urlfilter"
params:
adom: "root"
urlfilter: ""
filter:
- - "name"
- "=="
- "urlfilter4"
fields:
- "id"
- "name"
- "comment"
# option: "object member" # "count", "object member" or "syntax"
sortings:
- "id": 1
"name": -1
- name: Retrieve device
fortinet.fortimanager.fmgr_fact:
facts:
selector: "dvmdb_device"
params:
adom: "root"
device: ""
option:
- "get meta"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Состояние запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Состояние запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если параметры, использованные в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fact_module.html