fortinet.fortimanager.fmgr_dvm_cmd_add_device модуль — Добавление устройства в базу данных диспетчера устройств.

Примечание

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

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvm_cmd_add_device.

Добавлен в fortinet.fortimanager 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
dvm_cmd_add_device dictionary	Набор параметров верхнего уровня.
adom string	Имя или ID ADOM, на котором должна быть выполнена команда.
device dictionary	Устройство.
adm_pass any	(list) Добавить реальное устройство и повысить его статус.
adm_usr string	Добавить реальное устройство и повысить его статус.
authorization template string	Устарело, переименуйте в authorization_template. Добавить только модель устройства.
desc string	Доступно для всех операций.
device action string	Устарело, переименуйте в device_action. Укажите операции добавления устройства или оставьте пустым, чтобы добавить реальное устройство add_model - добавить модель устройства. promote_unreg - повысить статус незарегистрированного устройства до управляемого FortiManager, используя информацию из базы данных.
device blueprint string	Устарело, переименуйте в device_blueprint. Добавить только модель устройства.
faz.quota integer	Устарело, переименуйте в faz_quota. Доступно для всех операций.
ip string	Только для добавления реального устройства.
meta fields any	(dict or str) Устарело, переименуйте в meta_fields. Мета-поля.
mgmt_mode string	Добавить реальное и модельное устройство. Варианты: `"unreg"` `"fmg"` `"faz"` `"fmgfaz"`
mr integer	Добавить только модель устройства.
name string	Обязательно для всех операций.
os_type string	Добавить только модель устройства. Варианты: `"unknown"` `"fos"` `"fsw"` `"foc"` `"fml"` `"faz"` `"fwb"` `"fch"` `"fct"` `"log"` `"fmg"` `"fsa"` `"fdd"` `"fac"` `"fpx"` `"fna"`
os_ver string	Добавить только модель устройства. Варианты: `"unknown"` `"0.0"` `"1.0"` `"2.0"` `"3.0"` `"4.0"` `"5.0"` `"6.0"` `"7.0"` `"8.0"`
patch integer	Добавить только модель устройства.
platform_str string	Добавить только модель устройства.
sn string	Добавить только модель устройства.

flags список / элементы=строка	создание задачи - Создать новую задачу в базе данных диспетчера задач. без ожидания - API вернет результат сразу при вызове без ожидания. Варианты: `"none"` `"create_task"` `"nonblocking"` `"log_dev"`
groups список / элементы=словарь	Группы.
name строка	Имя.
vdom строка	Vdom.
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: Add a FOS device to FMG
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
    fos_user: "admin"
    fos_pass: "password"
    fos_ip: "192.168.190.151"
  tasks:
    - name: Discover device
      fortinet.fortimanager.fmgr_dvm_cmd_discover_device:
        bypass_validation: true
        dvm_cmd_discover_device:
          device:
            adm_pass: "{{ fos_pass }}"
            adm_usr: "{{ fos_user }}"
            ip: "{{ fos_ip }}"
      register: probed_device
    - name: Add device
      fortinet.fortimanager.fmgr_dvm_cmd_add_device:
        bypass_validation: true
        dvm_cmd_add_device:
          adom: "root"
          flags:
            - "create_task"
            - "nonblocking"
          device:
            adm_usr: "{{ probed_device.meta.response_data.device.adm_usr }}"
            adm_pass: "{{ probed_device.meta.response_data.device.adm_pass }}"
            desc: "The device is added via FortiManager Ansible"
            ip: "{{ probed_device.meta.response_data.device.ip }}"
            mgmt_mode: "fmg"
            name: "{{ probed_device.meta.response_data.device.name }}"
            sn: "{{ probed_device.meta.response_data.device.sn }}"
      register: installing_task
    - name: Poll the task
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ installing_task.meta.response_data.taskid }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 5
      failed_when: taskinfo.meta.response_data.state == 'error' and 'devsnexist' not in taskinfo.meta.response_data.line[0].detail

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Add a device to the Device Manager database.
      fortinet.fortimanager.fmgr_dvm_cmd_add_device:
        bypass_validation: false
        dvm_cmd_add_device:
          adom: ansible
          device:
            adm_pass: fortinet # device password
            adm_usr: admin # device user name
            ip: 0.0.0.0 # device ip
            mgmt_mode: fmg # <value in [unreg, fmg, faz, ...]>
            name: FGT_AWS
          flags:
            - none
            - create_task
            - nonblocking
            - log_dev

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

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

Ключ	Описание
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_add_device_module.html