fortinet.fortimanager.fmgr_firewall_sslsshprofile – Configure SSL/SSH protocol options.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr firewall sslsshprofile module


fortinet.fortimanager.fmgr_firewall_sslsshprofile – Configure SSL/SSH protocol options.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_sslsshprofile.


New in version 2.10: of fortinet.fortimanager


Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

  • no ←

  • yes

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

firewall_sslsshprofile

dictionary

the top level parameters set

caname

string

CA certificate used by SSL Inspection.

comment

string

Optional comments.

mapi-over-https

string

  • disable
  • enable

Enable/disable inspection of MAPI over HTTPS.

name

string

Name.

rpc-over-https

string

  • disable
  • enable

Enable/disable inspection of RPC over HTTPS.

server-cert

string

Certificate used by SSL Inspection to replace server certificate.

server-cert-mode

string

  • re-sign
  • replace

Re-sign or replace the servers certificate.

ssl-anomalies-log

string

  • disable
  • enable

Enable/disable logging SSL anomalies.

ssl-exempt

list / elements=string

no description

address

string

IPv4 address object.

address6

string

IPv6 address object.

fortiguard-category

string

FortiGuard category ID.

id

integer

ID number.

regex

string

Exempt servers by regular expression.

type

string

  • fortiguard-category
  • address
  • address6
  • wildcard-fqdn
  • regex

Type of address object (IPv4 or IPv6) or FortiGuard category.

wildcard-fqdn

string

Exempt servers by wildcard FQDN.

ssl-exemptions-log

string

  • disable
  • enable

Enable/disable logging SSL exemptions.

ssl-server

list / elements=string

no description

ftps-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during the FTPS handshake.

https-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during the HTTPS handshake.

id

integer

SSL server ID.

imaps-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during the IMAPS handshake.

ip

string

IPv4 address of the SSL server.

pop3s-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during the POP3S handshake.

smtps-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during the SMTPS handshake.

ssl-other-client-cert-request

string

  • bypass
  • inspect
  • block

Action based on client certificate request during an SSL protocol handshake.

untrusted-caname

string

Untrusted CA certificate used by SSL Inspection.

use-ssl-server

string

  • disable
  • enable

Enable/disable the use of SSL server table for SSL offloading.

whitelist

string

  • disable
  • enable

Enable/disable exempting servers by FortiGuard whitelist.

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

  • present
  • absent

the directive to create, update or delete an object

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

Default:

300

the maximum time in seconds to wait for other user to release the workspace lock



Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state present directive.
  • To delete an object, use state absent directive.
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded


Examples

- 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: Configure SSL/SSH protocol options.
     fmgr_firewall_sslsshprofile:
        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]>
        firewall_sslsshprofile:
           caname: <value of string>
           comment: <value of string>
           mapi-over-https: <value in [disable, enable]>
           name: <value of string>
           rpc-over-https: <value in [disable, enable]>
           server-cert: <value of string>
           server-cert-mode: <value in [re-sign, replace]>
           ssl-anomalies-log: <value in [disable, enable]>
           ssl-exempt:
             -
                 address: <value of string>
                 address6: <value of string>
                 fortiguard-category: <value of string>
                 id: <value of integer>
                 regex: <value of string>
                 type: <value in [fortiguard-category, address, address6, ...]>
                 wildcard-fqdn: <value of string>
           ssl-exemptions-log: <value in [disable, enable]>
           ssl-server:
             -
                 ftps-client-cert-request: <value in [bypass, inspect, block]>
                 https-client-cert-request: <value in [bypass, inspect, block]>
                 id: <value of integer>
                 imaps-client-cert-request: <value in [bypass, inspect, block]>
                 ip: <value of string>
                 pop3s-client-cert-request: <value in [bypass, inspect, block]>
                 smtps-client-cert-request: <value in [bypass, inspect, block]>
                 ssl-other-client-cert-request: <value in [bypass, inspect, block]>
           untrusted-caname: <value of string>
           use-ssl-server: <value in [disable, enable]>
           whitelist: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • 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_firewall_sslsshprofile_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr_firewall_sslsshprofile_module&oldid=63557"
Powered by MediaWiki