fortinet.fortimanager.fmgr_vpn_certificate_ca модуль – Сертификат CA.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_certificate_ca.

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
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"`
vpn_certificate_ca словарь	Настройка верхнего уровня параметров.
_private_key строка	Приватный ключ.
auto_update_days целое число	Устаревшее, переименуйте на auto_update_days. Количество дней ожидания перед запросом обновленного сертификата CA.
auto_update_days_warning целое число	Устаревшее, переименуйте на auto_update_days_warning. Количество дней до появления сообщения об истечении срока действия сертификата.
ca строка	Сертификат CA в формате PEM.
ca_identifier строка	Устаревшее, переименуйте на ca_identifier. Идентификатор CA сервера SCEP.
est_url строка	Устаревшее, переименуйте на est_url. URL сервера EST.
fabric_ca строка	Устаревшее, переименуйте на fabric_ca. Включить/выключить синхронизацию CA через Security Fabric. Варианты: `"disable"` `"enable"`
last_updated целое число	Устаревшее, переименуйте на last_updated. Время последнего обновления CA.
name строка / обязательно	Имя.
non_fabric_name строка	Устаревшее, переименуйте на non_fabric_name. Имя, используемое до синхронизации CA с Security Fabric.
obsolete строка	Включить/выключить этот сертификат CA как устаревший. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

диапазон строка	Диапазон IP-адресов глобального или VDOM для сертификата CA. Варианты: `"global"` `"vdom"`
scep-url строка	Устарело, пожалуйста, переименуйте на scep_url. URL-адрес сервера SCEP.
источник строка	Тип источника сертификата CA. Варианты: `"factory"` `"user"` `"bundle"` `"fortiguard"`
source-ip строка	Устарело, пожалуйста, переименуйте на source_ip. IP-адрес источника для связи с сервером SCEP.
ssl-inspection-trusted строка	Устарело, пожалуйста, переименуйте на ssl_inspection_trusted. Включить/отключить этот CA в качестве доверенного CA для SSL-инспекции. Варианты: `"disable"` `"enable"`
доверенный строка	Включить/отключить в качестве доверенного CA. Варианты: `"disable"` `"enable"`
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 (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: CA certificate.
      fortinet.fortimanager.fmgr_vpn_certificate_ca:
        # 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: present # <value in [present, absent]>
        vpn_certificate_ca:
          _private_key: <string>
          auto_update_days: <integer>
          auto_update_days_warning: <integer>
          ca: <string>
          last_updated: <integer>
          name: <string>
          range: <value in [global, vdom]>
          scep_url: <string>
          source: <value in [factory, user, bundle, ...]>
          source_ip: <string>
          trusted: <value in [disable, enable]>
          ssl_inspection_trusted: <value in [disable, enable]>
          ca_identifier: <string>
          obsolete: <value in [disable, enable]>
          est_url: <string>
          fabric_ca: <value in [disable, enable]>
          non_fabric_name: <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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_vpn_certificate_ca_module.html