Модуль fortinet.fortimanager.fmgr_securityconsole_sign_certificate_template — Генерация и подпись сертификата на целевом устройстве.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.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_sign_certificate_template словарь	Настройка верхнего уровня параметров.
adom строка	Имя исходного ADOM.
scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
template строка	Шаблон.
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: 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: Generate and sign certificate on the target device.
      fortinet.fortimanager.fmgr_securityconsole_sign_certificate_template:
        # 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, ...]
        securityconsole_sign_certificate_template:
          adom: <string>
          scope:
            -
              name: <string>
              vdom: <string>
          template: <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_securityconsole_sign_certificate_template_module.html