Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_dvm_cmd_del_device – Удаление устройства.

Примечание

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

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

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

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

Впервые в fortinet.fortimanager 1.0.0

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

Описание

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

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

логическое значение

Устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполняться без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

dvm_cmd_del_device

словарь

Набор параметров верхнего уровня.

adom

строка

Имя или идентификатор ADOM, на котором будет выполнена команда.

device

строка

Имя или идентификатор целевого устройства.

flags

список / элементы=строка

create_task - Создание новой задачи в базе данных менеджера задач.

nonblocking - API возвращает немедленно для вызова без блокировки.

Варианты:

  • "none"
  • "create_task"
  • "nonblocking"
  • "log_dev"

enable_log

логическое значение

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Авторизация Ansible-клиента с помощью токена доступа к API forticloud.

rc_failed

список / элементы=целое число

Список кодов rc, при которых выполнение будет остановлено.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых выполнение будет завершено успешно.

workspace_locking_adom

строка

ADOM для блокировки при работе в режиме рабочей области FortiManager, значение может быть глобальным или другим, включая root.

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: Delete first FOS devices from FMG In a specific adom
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
    device_adom: "root"
  tasks:
    - name: Fetch all devices
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "dvmdb_device"
          params:
            adom: "{{ device_adom }}"
            device: "your_value"
      register: alldevices
    - name: No name
      when: alldevices.meta.response_data != []
      ansible.builtin.debug:
        msg:
          - "We are going to delete device: {{ alldevices.meta.response_data[0].name }}"
          - "IP of the device is: {{ alldevices.meta.response_data[0].ip }}"
    - name: Create The Task To Delete The Device
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_dvm_cmd_del_device:
        dvm_cmd_del_device:
          device: "{{ alldevices.meta.response_data[0].name }}"
          adom: "{{ device_adom }}"
          flags:
            - "create_task"
            - "nonblocking"
      register: uninstalling_task
    - name: Poll the task
      when: alldevices.meta.response_data != [] and False
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ uninstalling_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'

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Delete a device.
      fortinet.fortimanager.fmgr_dvm_cmd_del_device:
        bypass_validation: false
        dvm_cmd_del_device:
          adom: ansible
          device: ansible-test # device name

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

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

Ключ

Описание

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_del_device_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API