Модуль fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist – Получение списка устройств.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist.

Новинка в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием из источников данных.

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dvm_cmd_reload_devlist словарь	Установленные параметры верхнего уровня.
adom строка	Имя или ID ADOM, на котором будет выполнена команда.
flags список / элементы=строка	create_task - Создать новую задачу в базе данных диспетчера задач. nonblocking - API вернет значение сразу же для неблокирующего вызова. Варианты: `"none"` `"create_task"` `"nonblocking"` `"log_dev"`
from строка	От. Варианты: `"um"` `"fgfm"` `"apache"` `"dvm"` `"fwm"` `"xml"` `"json"`
reload-dev-member-list список / элементы=словарь	Устарело, пожалуйста, переименуйте на reload_dev_member_list. Перезагрузка списка членов устройства.
name строка	Имя.
vdom строка	Vdom.
tag строка	Имя ревизии для полученной конфигурации.
enable_log логическое	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
rc_failed список / элементы=целое	Список кодов rc, по которым будут переопределены условия завершения неудачей.
rc_succeeded список / элементы=целое	Список кодов rc, по которым будут переопределены условия успешного завершения.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. Значение по умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код 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: Retrieve a list of devices.
      fortinet.fortimanager.fmgr_dvm_cmd_reload_devlist:
        # 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, ...]
        dvm_cmd_reload_devlist:
          adom: <string>
          flags:
            - none
            - create_task
            - nonblocking
            - log_dev
          from: <value in [um, fgfm, apache, ...]>
          reload_dev_member_list:
            -
              name: <string>
              vdom: <string>
          tag: <string>

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_dvm_cmd_reload_devlist_module.html