Try SpotterADOM table, most attributes are read-only and can only be changed internally.
| "added in version" 2.0.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: ADOM table, most attributes are read-only and can only be changed internally.
fortinet.fortimanager.fmgr_dvmdb_adom:
# 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, ...]
state: present # <value in [present, absent]>
dvmdb_adom:
desc: <string>
flags:
- migration
- db_export
- no_vpn_console
- backup
- other_devices
- central_sdwan
- is_autosync
- per_device_wtp
- policy_check_on_install
- install_on_policy_check_fail
- auto_push_cfg
- per_device_fsw
- install_deselect_all
log_db_retention_hours: <integer>
log_disk_quota: <integer>
log_disk_quota_alert_thres: <integer>
log_disk_quota_split_ratio: <integer>
log_file_retention_hours: <integer>
meta_fields: <dict>
mig_mr: <integer>
mig_os_ver: <value in [unknown, 0.0, 1.0, ...]>
mode: <value in [ems, gms, provider]>
mr: <integer>
name: <string>
os_ver: <value in [unknown, 0.0, 1.0, ...]>
restricted_prds: # <list or string>
- fos
- foc
- fml
- fch
- fwb
- log
- fct
- faz
- fsa
- fsw
- fmg
- fdd
- fac
- fpx
- fna
- fdc
- ffw
- fsr
- fad
- fap
- fxt
- fts
- fai
- fwc
- fis
- fed
- fabric
- fpa
- fca
- ftc
state: <integer>
uuid: <string>
create_time: <integer>
workspace_mode: <integer>
tz: <integer>
lock_override: <integer>
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
dvmdb_adom:
description: The top level parameters set.
required: false
suboptions:
create_time:
description: Create_Time.
type: int
desc:
description: Desc.
type: str
flags:
choices:
- migration
- db_export
- no_vpn_console
- backup
- other_devices
- central_sdwan
- is_autosync
- per_device_wtp
- policy_check_on_install
- install_on_policy_check_fail
- auto_push_cfg
- per_device_fsw
- install_deselect_all
description: Flags.
elements: str
type: list
lock_override:
description: No description.
type: int
log_db_retention_hours:
description: Log_Db_Retention_Hours.
type: int
log_disk_quota:
description: Log_Disk_Quota.
type: int
log_disk_quota_alert_thres:
description: Log_Disk_Quota_Alert_Thres.
type: int
log_disk_quota_split_ratio:
description: Log_Disk_Quota_Split_Ratio.
type: int
log_file_retention_hours:
description: Log_File_Retention_Hours.
type: int
meta fields:
description: Deprecated, please rename it to meta_fields. Default metafields
type: dict
mig_mr:
description: Mig_Mr.
type: int
mig_os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
- '9.0'
description: Mig_Os_Ver.
type: str
mode:
choices:
- ems
- gms
- provider
description:
- ems -
- provider - Global database.
type: str
mr:
description: Mr.
type: int
name:
description: Name.
required: true
type: str
os_ver:
choices:
- unknown
- '0.0'
- '1.0'
- '2.0'
- '3.0'
- '4.0'
- '5.0'
- '6.0'
- '7.0'
- '8.0'
- '9.0'
description: Os_Ver.
type: str
restricted_prds:
choices:
- fos
- foc
- fml
- fch
- fwb
- log
- fct
- faz
- fsa
- fsw
- fmg
- fdd
- fac
- fpx
- fna
- fdc
- ffw
- fsr
- fad
- fap
- fxt
- fts
- fai
- fwc
- fis
- fed
- fabric
- fpa
- fca
- ftc
description: (list or str) Restricted_Prds.
type: raw
state:
description: State.
type: int
tz:
description: No description.
type: int
uuid:
description: Uuid.
type: str
workspace_mode:
description: Workspace_Mode.
type: int
type: dict
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
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