:source: fmgd_user_ldap.py
:orphan:
.. _fmgd_user_ldap:
fmgd_user_ldap -- Configure LDAP server entries.
++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- user_ldap - Configure LDAP server entries. type: dict
- account_key_filter (Alias name: account-key-filter) Account key filter, using the upn as the search filter. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_processing (Alias name: account-key-processing) Account key processing operation. type: str choices: [same, strip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_upn_san (Alias name: account-key-upn-san) Define san in certificate for user principle name matching. type: str choices: [othername, rfc822name, dnsname]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- antiphish Enable/disable antiphishing credential backend. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ca_cert (Alias name: ca-cert) Ca certificate name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert (Alias name: client-cert) Client certificate name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert_auth (Alias name: client-cert-auth) Enable/disable using client certificate for tls authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- cnid Common name identifier for the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dn Distinguished name used to look up entries on the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dynamic_mapping Dynamic mapping. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- _scope Scope. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- vdom Vdom. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_cert_field (Alias name: account-key-cert-field) Define subject identity field in certificate for user access right checking. type: str choices: [othername, rfc822name, dnsname, cn]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_filter (Alias name: account-key-filter) Account key filter, using the upn as the search filter. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_name (Alias name: account-key-name) Account key name, using the upn as the search filter. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_processing (Alias name: account-key-processing) Account key processing operation. type: str choices: [same, strip]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_upn_san (Alias name: account-key-upn-san) Define san in certificate for user principle name matching. type: str choices: [othername, rfc822name, dnsname]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- antiphish Enable/disable antiphishing credential backend. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ca_cert (Alias name: ca-cert) Ca certificate name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert (Alias name: client-cert) Client certificate name. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- client_cert_auth (Alias name: client-cert-auth) Enable/disable using client certificate for tls authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- cnid Common name identifier for the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- dn Distinguished name used to look up entries on the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- filter Filter. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group Group. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_filter (Alias name: group-filter) Filter used for group matching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_member_check (Alias name: group-member-check) Group member checking methods. type: str choices: [user-attr, group-object, posix-group-object]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_object_filter (Alias name: group-object-filter) Filter used for group searching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_object_search_base (Alias name: group-object-search-base) Group object search base. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_search_base (Alias name: group-search-base) Search base used for group searching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_connections (Alias name: max-connections) Max connections. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- member_attr (Alias name: member-attr) Name of attribute from which to get group membership. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- obtain_user_info (Alias name: obtain-user-info) Enable/disable obtaining of user information. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password Password for initial binding. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_attr (Alias name: password-attr) Name of attribute to get password hash. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_expiry_warning (Alias name: password-expiry-warning) Enable/disable password expiry warnings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_renewal (Alias name: password-renewal) Enable/disable online password renewal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- port Port to be used for communication with the ldap server (default = 389). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- retrieve_protection_profile (Alias name: retrieve-protection-profile) Retrieve protection profile. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- search_type (Alias name: search-type) Search type. type: list choices: [recursive, nested]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_server (Alias name: secondary-server) Secondary ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secure Port to be used for authentication. type: str choices: [disable, starttls, ldaps]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server_identity_check (Alias name: server-identity-check) Enable/disable ldap server identity check (verify server domain name/ip address against the server certificate). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Fortigate ip address to be used for communication with the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_port (Alias name: source-port) Source port to be used for communication with the ldap server. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_max_proto_version (Alias name: ssl-max-proto-version) Ssl max proto version. type: str choices: [TLSv1-1, TLSv1-2, SSLv3, TLSv1, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_min_proto_version (Alias name: ssl-min-proto-version) Minimum supported protocol version for ssl/tls connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status_ttl (Alias name: status-ttl) Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this period of time (0 = cache disabled, default = 300). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_server (Alias name: tertiary-server) Tertiary ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor (Alias name: two-factor) Enable/disable two-factor authentication. type: str choices: [disable, fortitoken-cloud]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_authentication (Alias name: two-factor-authentication) Authentication method by fortitoken cloud. type: str choices: [fortitoken, email, sms]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_filter (Alias name: two-factor-filter) Filter used to synchronize users to fortitoken cloud. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_notification (Alias name: two-factor-notification) Notification method for user activation by fortitoken cloud. type: str choices: [email, sms]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- type Authentication type for ldap searches. type: str choices: [simple, anonymous, regular]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- user_info_exchange_server (Alias name: user-info-exchange-server) Ms exchange server from which to fetch user information. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- username Username (full dn) for initial binding. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip_interface (Alias name: source-ip-interface) Source interface for communication with the ldap server. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- validate_server_certificate (Alias name: validate-server-certificate) Validate server certificate. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- group_filter (Alias name: group-filter) Filter used for group matching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_member_check (Alias name: group-member-check) Group member checking methods. type: str choices: [user-attr, group-object, posix-group-object]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_object_filter (Alias name: group-object-filter) Filter used for group searching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- group_search_base (Alias name: group-search-base) Search base used for group searching. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- max_connections (Alias name: max-connections) Max connections. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- member_attr (Alias name: member-attr) Name of attribute from which to get group membership. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- name Ldap server entry name. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- obtain_user_info (Alias name: obtain-user-info) Enable/disable obtaining of user information. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password Password for initial binding. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_attr (Alias name: password-attr) Name of attribute to get password hash. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_expiry_warning (Alias name: password-expiry-warning) Enable/disable password expiry warnings. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- password_renewal (Alias name: password-renewal) Enable/disable online password renewal. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- port Port to be used for communication with the ldap server (default = 389). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- search_type (Alias name: search-type) Search type. type: list choices: [recursive]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secondary_server (Alias name: secondary-server) Secondary ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- secure Port to be used for authentication. type: str choices: [disable, starttls, ldaps]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server Ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- server_identity_check (Alias name: server-identity-check) Enable/disable ldap server identity check (verify server domain name/ip address against the server certificate). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_ip (Alias name: source-ip) Fortigate ip address to be used for communication with the ldap server. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- source_port (Alias name: source-port) Source port to be used for communication with the ldap server. type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_max_proto_version (Alias name: ssl-max-proto-version) Ssl max proto version. type: str choices: [TLSv1-1, TLSv1-2, SSLv3, TLSv1, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- ssl_min_proto_version (Alias name: ssl-min-proto-version) Minimum supported protocol version for ssl/tls connections (default is to follow system global setting). type: str choices: [default, TLSv1, TLSv1-1, TLSv1-2, SSLv3, TLSv1-3]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- tertiary_server (Alias name: tertiary-server) Tertiary ldap server cn domain name or ip. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor (Alias name: two-factor) Enable/disable two-factor authentication. type: str choices: [disable, fortitoken-cloud]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_authentication (Alias name: two-factor-authentication) Authentication method by fortitoken cloud. type: str choices: [fortitoken, email, sms]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_filter (Alias name: two-factor-filter) Filter used to synchronize users to fortitoken cloud. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- two_factor_notification (Alias name: two-factor-notification) Notification method for user activation by fortitoken cloud. type: str choices: [email, sms]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- type Authentication type for ldap searches. type: str choices: [simple, anonymous, regular]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- user_info_exchange_server (Alias name: user-info-exchange-server) Ms exchange server from which to fetch user information. type: list
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- username Username (full dn) for initial binding. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- status_ttl (Alias name: status-ttl) Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this period of time (0 = cache disabled, default = 300). type: int
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_cert_field (Alias name: account-key-cert-field) Define subject identity field in certificate for user access right checking. type: str choices: [othername, rfc822name, dnsname, cn]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- account_key_name (Alias name: account-key-name) Account key name, using the upn as the search filter. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- validate_server_certificate (Alias name: validate-server-certificate) Validate server certificate. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> v7.6.4
- source_ip_interface (Alias name: source-ip-interface) Source interface for communication with the ldap server. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure LDAP server entries.
fortinet.fmgdevice.fmgd_user_ldap:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
user_ldap:
name: "your value" # Required variable, string
# account_key_filter:
# account_key_processing:
# account_key_upn_san:
# antiphish:
# ca_cert:
# client_cert:
# client_cert_auth:
# cnid:
# dn:
# dynamic_mapping:
# - _scope:
# - name:
# vdom:
# account_key_cert_field:
# account_key_filter:
# account_key_name:
# account_key_processing:
# account_key_upn_san:
# antiphish:
# ca_cert:
# client_cert:
# client_cert_auth:
# cnid:
# dn:
# filter:
# group:
# group_filter:
# group_member_check:
# group_object_filter:
# group_object_search_base:
# group_search_base:
# interface:
# interface_select_method:
# max_connections:
# member_attr:
# obtain_user_info:
# password:
# password_attr:
# password_expiry_warning:
# password_renewal:
# port:
# retrieve_protection_profile:
# search_type:
# - "recursive"
# - "nested"
# secondary_server:
# secure:
# server:
# server_identity_check:
# source_ip:
# source_port:
# ssl_max_proto_version:
# ssl_min_proto_version:
# status_ttl:
# tertiary_server:
# two_factor:
# two_factor_authentication:
# two_factor_filter:
# two_factor_notification:
# type:
# user_info_exchange_server:
# username:
# source_ip_interface:
# validate_server_certificate:
# vrf_select:
# group_filter:
# group_member_check:
# group_object_filter:
# group_search_base:
# interface:
# interface_select_method:
# max_connections:
# member_attr:
# obtain_user_info:
# password:
# password_attr:
# password_expiry_warning:
# password_renewal:
# port:
# search_type:
# - "recursive"
# secondary_server:
# secure:
# server:
# server_identity_check:
# source_ip:
# source_port:
# ssl_max_proto_version:
# ssl_min_proto_version:
# tertiary_server:
# two_factor:
# two_factor_authentication:
# two_factor_filter:
# two_factor_notification:
# type:
# user_info_exchange_server:
# username:
# status_ttl:
# account_key_cert_field:
# account_key_name:
# validate_server_certificate:
# source_ip_interface:
# vrf_select:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)