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

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_sslsshprofile_sslserver dictionary	Набор параметров верхнего уровня.
ftps_client_cert_request псевдонимы: ftps-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия FTPS. Варианты: `"bypass"` `"inspect"` `"block"`
ftps_client_certificate псевдонимы: ftps-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия FTPS. Варианты: `"bypass"` `"inspect"` `"block"`
https_client_cert_request псевдонимы: https-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия HTTPS. Варианты: `"bypass"` `"inspect"` `"block"`
https_client_certificate псевдонимы: https-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия HTTPS. Варианты: `"bypass"` `"inspect"` `"block"`
id integer / обязательный	Идентификатор SSL-сервера.
imaps_client_cert_request псевдонимы: imaps-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия IMAPS. Варианты: `"bypass"` `"inspect"` `"block"`
imaps_client_certificate псевдонимы: imaps-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия IMAPS. Варианты: `"bypass"` `"inspect"` `"block"`
ip string	IPv4-адрес SSL-сервера.
pop3s_client_cert_request псевдонимы: pop3s-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия POP3S. Варианты: `"bypass"` `"inspect"` `"block"`
pop3s_client_certificate псевдонимы: pop3s-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия POP3S. Варианты: `"bypass"` `"inspect"` `"block"`
smtps_client_cert_request псевдонимы: smtps-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия SMTPS. Варианты: `"bypass"` `"inspect"` `"block"`
smtps_client_certificate псевдонимы: smtps-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия SMTPS. Варианты: `"bypass"` `"inspect"` `"block"`
ssl_other_client_cert_request псевдонимы: ssl-other-client-cert-request string	Действие в зависимости от запроса сертификата клиента во время рукопожатия по протоколу SSL. Варианты: `"bypass"` `"inspect"` `"block"`
ssl_other_client_certificate псевдонимы: ssl-other-client-certificate string	Действие в зависимости от полученного сертификата клиента во время рукопожатия по протоколу 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, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
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, работающего в режиме рабочей области. Значением может быть global или другие значения, включая root.
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.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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 dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса к API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_sslsshprofile_sslserver_module.html