Модуль fortinet.fortimanager.fmgr_certificate_template — Шаблон сертификата

Примечание

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

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

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

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_certificate_template.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
certificate_template словарь	Установленные параметры верхнего уровня.
city строка	Город.
country строка	Страна.
curve_name строка	Устарело, пожалуйста, переименуйте на curve_name. Имя кривой. Варианты: `"secp256r1"` `"secp384r1"` `"secp521r1"`
digest_type строка	Устарело, пожалуйста, переименуйте на digest_type. Тип дайджеста. Варианты: `"sha1"` `"sha256"`
email строка	Электронная почта.
id_type строка	Устарело, пожалуйста, переименуйте на id_type. Тип идентификатора. Варианты: `"host-ip"` `"domain-name"` `"email"`
key_size строка	Устарело, пожалуйста, переименуйте на key_size. Размер ключа. Варианты: `"512"` `"1024"` `"1536"` `"2048"` `"4096"`
key_type строка	Устарело, пожалуйста, переименуйте на key_type. Тип ключа. Варианты: `"rsa"` `"ec"`
name строка / обязательно	Название.
organization строка	Организация.
organization_unit любой	(список) Устарело, пожалуйста, переименуйте на organization_unit. Организационная единица.
scep_ca_identifier строка	Устарело, пожалуйста, переименуйте на scep_ca_identifier. Идентификатор сертификационного центра SCeP.
scep_password любой	(список) Устарело, пожалуйста, переименуйте на scep_password. Пароль SCeP.
scep_server строка	Устарело, пожалуйста, переименуйте на scep_server. Сервер SCeP.
state строка	Состояние.
subject_name строка	Устарело, пожалуйста, переименуйте на subject_name. Имя субъекта.
type строка	Тип. Варианты: `"external"` `"local"`
enable_log логическое	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

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, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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: No description
      fortinet.fortimanager.fmgr_certificate_template:
        adom: ansible
        state: present
        certificate_template:
          # digest-type: sha1
          id-type: host-ip
          key-size: 512
          key-type: rsa
          name: "ansible-test"
          scep-password: "fortinet1"
          type: external

- 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 scripts
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "certificate_template"
          params:
            adom: "ansible"
            template: "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_certificate_template_module.html