fortinet.fortimanager.fmgr_vpn_certificate_ca – CA certificate.

Note

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

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

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

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
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
vpn_certificate_ca
dictionary
the top level parameters set
_private_key
string
no description
auto-update-days
integer
Number of days to wait before requesting an updated CA certificate (0 - 4294967295, 0 = disabled).
auto-update-days-warning
integer
Number of days before an expiry-warning message is generated (0 - 4294967295, 0 = disabled).
ca
string
CA certificate as a PEM file.
last-updated
integer
Time at which CA was last updated.
name
string
Name.
range
string
    Choices:
  • global
  • vdom
Either global or VDOM IP address range for the CA certificate.
scep-url
string
URL of the SCEP server.
source
string
    Choices:
  • factory
  • user
  • bundle
  • fortiguard
CA certificate source type.
source-ip
string
Source IP address for communications to the SCEP server.
ssl-inspection-trusted
string
    Choices:
  • disable
  • enable
Enable/disable this CA as a trusted CA for SSL inspection.
trusted
string
    Choices:
  • disable
  • enable
Enable/disable as a trusted CA.
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: CA certificate.
     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: <value in [present, absent]>
        vpn_certificate_ca:
           _private_key: <value of string>
           auto-update-days: <value of integer>
           auto-update-days-warning: <value of integer>
           ca: <value of string>
           last-updated: <value of integer>
           name: <value of string>
           range: <value in [global, vdom]>
           scep-url: <value of string>
           source: <value in [factory, user, bundle, ...]>
           source-ip: <value of string>
           trusted: <value in [disable, enable]>
           ssl-inspection-trusted: <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)