fortinet.fortimanager.fmgr_firewall_sslsshprofile_sslserver модуль — SSL серверы.

Примечание

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

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

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

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

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_sslsshprofile_sslserver словарь	Настройка параметров верхнего уровня.
ftps-client-cert-request строка	Устаревшее, пожалуйста, переименуйте на ftps_client_cert_request. Действие, основанное на запросе сертификата клиента во время… Варианты: `"bypass"` `"inspect"` `"block"`
ftps-client-certificate строка	Устаревшее, пожалуйста, переименуйте на ftps_client_certificate. Действие, основанное на полученном сертификате клиента… Варианты: `"bypass"` `"inspect"` `"block"`
https-client-cert-request строка	Устаревшее, пожалуйста, переименуйте на https_client_cert_request. Действие, основанное на запросе сертификата клиента… Варианты: `"bypass"` `"inspect"` `"block"`
https-client-certificate строка	Устаревшее, пожалуйста, переименуйте на https_client_certificate. Действие, основанное на полученном сертификате клиента… Варианты: `"bypass"` `"inspect"` `"block"`
id целое число / обязательно	ID SSL сервера.
imaps-client-cert-request строка	Устаревшее, пожалуйста, переименуйте на imaps_client_cert_request. Действие, основанное на запросе сертификата клиента… Варианты: `"bypass"` `"inspect"` `"block"`
imaps-client-certificate строка	Устаревшее, пожалуйста, переименуйте на imaps_client_certificate. Действие, основанное на полученном сертификате клиента… Варианты: `"bypass"` `"inspect"` `"block"`
ip строка	IPv4 адрес SSL сервера.
pop3s-client-cert-request строка	Устаревшее, пожалуйста, переименуйте на pop3s_client_cert_request. Действие, основанное на запросе сертификата клиента… Варианты: `"bypass"` `"inspect"` `"block"`
pop3s-client-certificate строка	Устаревшее, пожалуйста, переименуйте на pop3s_client_certificate. Действие, основанное на полученном сертификате клиента… Варианты: `"bypass"` `"inspect"` `"block"`
smtps-client-cert-request строка	Устаревшее, пожалуйста, переименуйте на smtps_client_cert_request. Действие, основанное на запросе сертификата клиента… Варианты: `"bypass"` `"inspect"` `"block"`

smtps-client-certificate string	Устаревшее, пожалуйста, переименуйте на smtps_client_certificate. Действие, основанное на полученном клиентом сертификате во время обработки SMTPS... Варианты: `"bypass"` `"inspect"` `"block"`
ssl-other-client-cert-request string	Устаревшее, пожалуйста, переименуйте на ssl_other_client_cert_request. Действие, основанное на запросе сертификата клиента во время SSL-процесса... Варианты: `"bypass"` `"inspect"` `"block"`
ssl-other-client-certificate string	Устаревшее, пожалуйста, переименуйте на ssl_other_client_certificate. Действие, основанное на полученном сертификате клиента во время SSL-процесса... Варианты: `"bypass"` `"inspect"` `"block"`
forticloud_access_token string	Авторизует клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список rc-кодов, с которыми будут переопределены условия завершения с ошибкой.
rc_succeeded list / elements=integer	Список rc-кодов, с которыми будут переопределены условия успешного завершения.
ssl-ssh-profile string	Устаревшее, используйте “ssl_ssh_profile”
ssl_ssh_profile string	Параметр (ssl-ssh-profile) в запрошенном URL.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область (adom) для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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: SSL servers.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile_sslserver:
        bypass_validation: false
        adom: ansible
        ssl-ssh-profile: "ansible-test" # name
        state: present
        firewall_sslsshprofile_sslserver:
          ftps-client-cert-request: block # <value in [bypass, inspect, block]>
          https-client-cert-request: bypass # <value in [bypass, inspect, block]>
          id: 1
          imaps-client-cert-request: bypass # <value in [bypass, inspect, block]>

- 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 SSL servers SSL/SSH protocol option
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_sslsshprofile_sslserver"
          params:
            adom: "ansible"
            ssl-ssh-profile: "ansible-test" # name
            ssl-server: "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_firewall_sslsshprofile_sslserver_module.html