Модуль fortinet.fortimanager.fmgr_securityconsole_install_device — Установка устройства консоли безопасности

Примечание

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

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
rc_failed список / элементы=целое	Список кодов rc, при которых выполнение будет завершено с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, при которых выполнение будет завершено успешно.
securityconsole_install_device словарь	Основные параметры.
adom строка	Имя источника ADOM.
dev_rev_comments строка	Комментарии к изменению версии устройства.
flags список / элементы=строка	preview — Генерация только кэша предварительного просмотра. auto_lock_ws — Автоматическое блокирование и разблокирование рабочей области при выполнении задачи консоли безопасности. Варианты: `"none"` `"preview"` `"auto_lock_ws"`
scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
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: Commit config to real device
  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"
    script_name: "FooScript"
    device_name: "CustomHostName"
    device_vdom: "root"
  tasks:
    - name: Invoke the task
      fortinet.fortimanager.fmgr_securityconsole_install_device:
        securityconsole_install_device:
          adom: "{{ device_adom }}"
          scope:
            - name: "{{ device_name }}"
              vdom: "{{ device_vdom }}"
      register: installing_task
    - name: Inspect the Task Status
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "task_task"
          params:
            task: "{{ installing_task.meta.response_data.task }}"
      register: taskinfo
      until: taskinfo.meta.response_data.percent == 100
      retries: 30
      delay: 3
      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: Run fmgr_securityconsole_install_device
      fortinet.fortimanager.fmgr_securityconsole_install_device:
        bypass_validation: false
        securityconsole_install_device:
          adom: ansible
          dev_rev_comments: ansible-comment
          flags:
            - none
            - preview
            - auto_lock_ws
          scope:
            - name: Ansible-test
              vdom: root

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

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

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