Модуль fortinet.fortimanager.fmgr_fact – Сбор фактов FortiManager.
Примечание
Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
enable_log логическое | Включить/отключить ведение журнала для задачи. Варианты:
|
facts словарь / обязательно | Сбор фактов FortiManager. |
|
extra_params словарь |
Дополнительные параметры для каждого селектора. |
|
fields список / элементы=любой |
Ограничить вывод, возвращая только атрибуты, указанные в строковом массиве. Если не указано, будут возвращены все атрибуты. |
|
filter список / элементы=любой |
Фильтровать результат по набору критериев. |
|
option любой |
Установить параметр извлечения для запроса. Если параметр не указан, по умолчанию возвращаются атрибуты объектов. См. подробные сведения в документации API FNDN. |
|
params словарь |
Конкретные параметры для каждого селектора. |
|
selector строка / обязательно |
Селектор полученных фактов FortiManager. Варианты: |
|
|
|
| |
|
Сортировки список / элементы=любой |
Список правил сортировки. Элементы возвращаются в порядке возрастания (1) или убывания (-1) полей в списке. |
токен_доступа_forticloud строка | Токен доступа к пользователям управляемого API FortiCloud, этот параметр доступен в FortiManager, начиная с версии 6.4.0. |
rc_отказ список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия отказа. |
rc_успех список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успеха. |
блокировка_рабочего_пространства_adom строка | ADOM для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root. |
срок_блокировки_рабочего_пространства целое число | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: |
Примечания
Примечание
- Работа в режиме блокировки рабочего пространства поддерживается в этом модуле 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 словарь | Результат запроса. Возвращается: всегда |
|
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_fact_module.html