fortinet.fortimanager.fmgr_certificate_template – без описания

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливать в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
certificate_template словарь			параметры верхнего уровня
	city строка		без описания
	country строка		без описания
	digest-type строка	Варианты: sha1 ← sha256	без описания
	email строка		без описания
	id-type строка	Варианты: host-ip ← имя домена электронная почта	без описания
	key-size строка	Варианты: 512 1024 1536 2048 ←	без описания
	key-type строка	Варианты: rsa ←	без описания
	name строка		без описания
	organization строка		без описания
	organization-unit строка		без описания
	scep-password строка		без описания
	scep-server строка		без описания
	state строка		без описания
	subject-name строка		без описания
	type строка	Варианты: external ← локальный	без описания
rc_failed список / элементы=строка			список кодов rc, с которыми условия провала будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, с которыми условия успеха будут переопределены
state строка / обязательно		Варианты: present absent	направление создания, обновления или удаления объекта
workspace_locking_adom строка			адрес (adom) для блокировки FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Поддерживается работа в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте направление state present.
Для удаления объекта используйте направление state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия провала или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_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, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        certificate_template:
           city: <value of string>
           country: <value of string>
           digest-type: <value in [sha1, sha256]>
           email: <value of string>
           id-type: <value in [host-ip, domain-name, email]>
           key-size: <value in [512, 1024, 1536, ...]>
           key-type: <value in [rsa]>
           name: <value of string>
           organization: <value of string>
           organization-unit: <value of string>
           scep-password: <value of string>
           scep-server: <value of string>
           state: <value of string>
           subject-name: <value of string>
           type: <value in [external, local]>

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_certificate_template_module.html