Try SpotterAdd this device to a Security Fabric or set up a new Security Fabric on this device.
| "added in version" 2.3.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Add this device to a Security Fabric or set up a new Security Fabric on this device.
fortinet.fortimanager.fmgr_system_csf:
# 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, ...]
system_csf:
accept_auth_by_cert: <value in [disable, enable]>
authorization_request_type: <value in [certificate, serial]>
certificate: <string>
configuration_sync: <value in [default, local]>
downstream_access: <value in [disable, enable]>
downstream_accprofile: <string>
fabric_connector:
-
accprofile: <string>
configuration_write_access: <value in [disable, enable]>
serial: <string>
fabric_object_unification: <value in [local, default]>
fabric_workers: <integer>
file_mgmt: <value in [disable, enable]>
file_quota: <integer>
file_quota_warning: <integer>
fixed_key: <list or string>
forticloud_account_enforcement: <value in [disable, enable]>
group_name: <string>
group_password: <list or string>
log_unification: <value in [disable, enable]>
saml_configuration_sync: <value in [local, default]>
status: <value in [disable, enable]>
trusted_list:
-
action: <value in [accept, deny]>
authorization_type: <value in [serial, certificate]>
certificate: <string>
downstream_authorization: <value in [disable, enable]>
ha_members: <string>
index: <integer>
name: <string>
serial: <string>
upstream: <string>
upstream_port: <integer>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
system_csf:
description: The top level parameters set.
required: false
suboptions:
accept-auth-by-cert:
choices:
- disable
- enable
description:
- Deprecated, please rename it to accept_auth_by_cert.
- Accept connections with unknown certificates and ask admin for approval.
- disable - Do not accept SSL connections with unknown certificates.
- enable - Accept SSL connections without automatic certificate verification.
type: str
authorization-request-type:
choices:
- certificate
- serial
description:
- Deprecated, please rename it to authorization_request_type.
- Authorization request type.
- certificate - Request verification by certificate.
- serial - Request verification by serial number.
type: str
certificate:
description: Certificate.
type: str
configuration-sync:
choices:
- default
- local
description:
- Deprecated, please rename it to configuration_sync.
- Configuration sync mode.
- default - Synchronize configuration for IPAM, FortiAnalyzer, FortiSandbox, and
Central Management to root node.
- local - Do not synchronize configuration with root node.
type: str
downstream-access:
choices:
- disable
- enable
description:
- Deprecated, please rename it to downstream_access.
- Enable/disable downstream device access to this device's configuration
and data.
- disable - Disable downstream device access to this device's configuration
and data.
- enable - Enable downstream device access to this device's configuration
and data.
type: str
downstream-accprofile:
description: Deprecated, please rename it to downstream_accprofile. Default access
profile for requests from downstream devices.
type: str
fabric-connector:
description: Deprecated, please rename it to fabric_connector.
elements: dict
suboptions:
accprofile:
description: Override access profile.
type: str
configuration-write-access:
choices:
- disable
- enable
description:
- Deprecated, please rename it to configuration_write_access.
- Enable/disable downstream device write access to configuration.
- disable - Disable downstream device write access to configuration.
- enable - Enable downstream device write access to configuration.
type: str
serial:
description: Serial.
type: str
type: list
fabric-object-unification:
choices:
- local
- default
description:
- Deprecated, please rename it to fabric_object_unification.
- Fabric CMDB Object Unification.
- local - Global CMDB objects will not be synchronized to and from this device.
- default - Global CMDB objects will be synchronized in Security Fabric.
type: str
fabric-workers:
description: Deprecated, please rename it to fabric_workers. Number of worker
processes for Security Fabric daemon.
type: int
file-mgmt:
choices:
- disable
- enable
description:
- Deprecated, please rename it to file_mgmt.
- Enable/disable Security Fabric daemon file management.
- disable - Disable daemon file management.
- enable - Enable daemon file management.
type: str
file-quota:
description: Deprecated, please rename it to file_quota. Maximum amount of memory
that can be used by the daemon files
type: int
file-quota-warning:
description: Deprecated, please rename it to file_quota_warning. Warn when the
set percentage of quota has been used.
type: int
fixed-key:
description: Deprecated, please rename it to fixed_key.
elements: str
type: list
forticloud-account-enforcement:
choices:
- disable
- enable
description:
- Deprecated, please rename it to forticloud_account_enforcement.
- Fabric FortiCloud account unification.
- disable - Disable FortiCloud accound ID matching for Security Fabric.
- enable - Enable FortiCloud account ID matching for Security Fabric.
type: str
group-name:
description: Deprecated, please rename it to group_name. Security Fabric group
name.
type: str
group-password:
description: Deprecated, please rename it to group_password.
elements: str
type: list
log-unification:
choices:
- disable
- enable
description:
- Deprecated, please rename it to log_unification.
- Enable/disable broadcast of discovery messages for log unification.
- disable - Disable broadcast of discovery messages for log unification.
- enable - Enable broadcast of discovery messages for log unification.
type: str
saml-configuration-sync:
choices:
- local
- default
description:
- Deprecated, please rename it to saml_configuration_sync.
- SAML setting configuration synchronization.
- local - Do not apply SAML configuration generated by root.
- default - SAML setting for fabric members is created by fabric root.
type: str
status:
choices:
- disable
- enable
description:
- Enable/disable Security Fabric.
- disable - Disable Security Fabric.
- enable - Enable Security Fabric.
type: str
trusted-list:
description: Deprecated, please rename it to trusted_list.
elements: dict
suboptions:
action:
choices:
- accept
- deny
description:
- Security fabric authorization action.
- accept - Accept authorization request.
- deny - Deny authorization request.
type: str
authorization-type:
choices:
- serial
- certificate
description:
- Deprecated, please rename it to authorization_type.
- Authorization type.
- serial - Verify downstream by serial number.
- certificate - Verify downstream by certificate.
type: str
certificate:
description: Certificate.
type: str
downstream-authorization:
choices:
- disable
- enable
description:
- Deprecated, please rename it to downstream_authorization.
- Trust authorizations by this node's administrator.
- disable - Disable downstream authorization.
- enable - Enable downstream authorization.
type: str
ha-members:
description: Deprecated, please rename it to ha_members. HA members.
type: str
index:
description: Index of the downstream in tree.
type: int
name:
description: Name.
type: str
serial:
description: Serial.
type: str
type: list
upstream:
description: IP/FQDN of the FortiGate upstream from this FortiGate in the Security
Fabric.
type: str
upstream-port:
description: Deprecated, please rename it to upstream_port. The port number to
use to communicate with the FortiGate upstream from this...
type: int
type: dict
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list