fortinet.fortimanager.fmgr_application_custom модуль — Настройка пользовательских подписей приложений.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
application_custom словарь	Настройка параметров верхнего уровня.
behavior строка	Поведение пользовательской подписи приложения.
category строка	ID категории пользовательского приложения
comment строка	Комментарий.
id целое число	Идентификатор.
name строка	Имя.
protocol строка	Протокол пользовательской подписи приложения.
signature строка	Текст, составляющий фактическую пользовательскую подпись приложения.
tag строка / обязательно	Тег подписи.
technology строка	Технология пользовательской подписи приложения.
vendor строка	Производитель пользовательской подписи приложения.
bypass_validation логическое	Устанавливается в значение True только в том случае, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполняться без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, с помощью которых будут переопределены условия успешного завершения.
state строка / обязательно	Направление создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться неудачей при возвращении ненулевого кода rc. Вы также можете переопределить условия для завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure custom application signatures.
      fortinet.fortimanager.fmgr_application_custom:
        adom: ansible
        state: present
        application_custom:
          behavior: "ansible-test1"
          category: "ansible-test1"
          comment: "ansble-test"
          id: 1000
          name: "ansible-test1"
          protocol: "ansble-test1"
          signature: "ansble-test1"
          tag: "ansble-test-tag"
          technology: "ansble-test"
          vendor: "ansble-test-vendor"

- 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 custom application signatures
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "application_custom"
          params:
            adom: "ansible"
            custom: "your_value"

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

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

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