#!/usr/bin/python from __future__ import absolute_import, division, print_function # Copyright 2019-2024 Fortinet, Inc. # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) __metaclass__ = type ANSIBLE_METADATA = {'status': ['preview'], 'supported_by': 'community', 'metadata_version': '1.1'} DOCUMENTATION = ''' --- module: fmgr_system_global short_description: Global range attributes. description: - 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. version_added: "1.0.0" author: - Xinwei Du (@dux-fortinet) - Xing Li (@lix-fortinet) - Jie Xue (@JieX19) - Link Zheng (@chillancezen) - Frank Shen (@fshen01) - Hongbin Lu (@fgtdev-hblu) notes: - Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as "var-name" to "var_name". Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg. - 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. - 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 options: access_token: description: The token to access FortiManager without using username and password. type: str bypass_validation: description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool default: false enable_log: description: Enable/Disable logging for task. type: bool default: false forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str proposed_method: description: The overridden method for the underlying Json RPC request. type: str choices: - update - set - add rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. type: list elements: int rc_failed: description: The rc codes list with which the conditions to fail will be overriden. type: list elements: int 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 workspace_locking_timeout: description: The maximum time in seconds to wait for other user to release the workspace lock. type: int default: 300 system_global: description: The top level parameters set. required: false type: dict suboptions: admin_lockout_duration: aliases: ['admin-lockout-duration'] type: int description: Lockout duration admin_lockout_threshold: aliases: ['admin-lockout-threshold'] type: int description: Lockout threshold for administration. adom_mode: aliases: ['adom-mode'] type: str description: - ADOM mode. - normal - Normal ADOM mode. - advanced - Advanced ADOM mode. choices: - 'normal' - 'advanced' adom_rev_auto_delete: aliases: ['adom-rev-auto-delete'] type: str description: - Auto delete features for old ADOM revisions. - disable - Disable auto delete function for ADOM revision. - by-revisions - Auto delete ADOM revisions by maximum number of revisions. - by-days - Auto delete ADOM revisions by maximum days. choices: - 'disable' - 'by-revisions' - 'by-days' adom_rev_max_backup_revisions: aliases: ['adom-rev-max-backup-revisions'] type: int description: Maximum number of ADOM revisions to backup. adom_rev_max_days: aliases: ['adom-rev-max-days'] type: int description: Number of days to keep old ADOM revisions. adom_rev_max_revisions: aliases: ['adom-rev-max-revisions'] type: int description: Maximum number of ADOM revisions to keep. adom_select: aliases: ['adom-select'] type: str description: - Enable/disable select ADOM after login. - disable - Disable select ADOM after login. - enable - Enable select ADOM after login. choices: - 'disable' - 'enable' adom_status: aliases: ['adom-status'] type: str description: - ADOM status. - disable - Disable ADOM mode. - enable - Enable ADOM mode. choices: - 'disable' - 'enable' clt_cert_req: aliases: ['clt-cert-req'] type: str description: - Require client certificate for GUI login. - disable - Disable setting. - enable - Require client certificate for GUI login. - optional - Optional client certificate for GUI login. choices: - 'disable' - 'enable' - 'optional' console_output: aliases: ['console-output'] type: str description: - Console output mode. - standard - Standard output. - more - More page output. choices: - 'standard' - 'more' country_flag: aliases: ['country-flag'] type: str description: - Country flag Status. - disable - Disable country flag icon beside ip address. - enable - Enable country flag icon beside ip address. choices: - 'disable' - 'enable' create_revision: aliases: ['create-revision'] type: str description: - Enable/disable create revision by default. - disable - Disable create revision by default. - enable - Enable create revision by default. choices: - 'disable' - 'enable' daylightsavetime: type: str description: - Enable/disable daylight saving time. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' default_disk_quota: aliases: ['default-disk-quota'] type: int description: Default disk quota for registered device detect_unregistered_log_device: aliases: ['detect-unregistered-log-device'] type: str description: - Detect unregistered logging device from log message. - disable - Disable attribute function. - enable - Enable attribute function. choices: - 'disable' - 'enable' device_view_mode: aliases: ['device-view-mode'] type: str description: - Set devices/groups view mode. - regular - Regular view mode. - tree - Tree view mode. choices: - 'regular' - 'tree' dh_params: aliases: ['dh-params'] type: str description: - Minimum size of Diffie-Hellman prime for SSH/HTTPS - 1024 - 1024 bits. - 1536 - 1536 bits. - 2048 - 2048 bits. - 3072 - 3072 bits. - 4096 - 4096 bits. - 6144 - 6144 bits. - 8192 - 8192 bits. choices: - '1024' - '1536' - '2048' - '3072' - '4096' - '6144' - '8192' disable_module: aliases: ['disable-module'] type: list elements: str description: - Disable module list. - fortiview-noc - FortiView/NOC-SOC module. choices: - 'fortiview-noc' - 'none' - 'fortirecorder' - 'siem' - 'soc' - 'ai' - 'safeguard-mv' enc_algorithm: aliases: ['enc-algorithm'] type: str description: - SSL communication encryption algorithms. - low - SSL communication using all available encryption algorithms. - medium - SSL communication using high and medium encryption algorithms. - high - SSL communication using high encryption algorithms. choices: - 'low' - 'medium' - 'high' - 'custom' faz_status: aliases: ['faz-status'] type: str description: - FAZ status. - disable - Disable FAZ feature. - enable - Enable FAZ feature. choices: - 'disable' - 'enable' fgfm_local_cert: aliases: ['fgfm-local-cert'] type: str description: Set the fgfm local certificate. fgfm_ssl_protocol: aliases: ['fgfm-ssl-protocol'] type: str description: - set the lowest SSL protocols for fgfmsd. - sslv3 - set SSLv3 as the lowest version. - tlsv1. - tlsv1. - tlsv1. choices: - 'sslv3' - 'tlsv1.0' - 'tlsv1.1' - 'tlsv1.2' - 'tlsv1.3' - 'follow-global-ssl-protocol' ha_member_auto_grouping: aliases: ['ha-member-auto-grouping'] type: str description: - Enable/disable automatically group HA members feature - disable - Disable automatically grouping HA members feature. - enable - Enable automatically grouping HA members only when group name is unique in your network. choices: - 'disable' - 'enable' hitcount_concurrent: type: int description: The number of FortiGates that FortiManager polls at one time hitcount_interval: type: int description: The interval for getting hit count from managed FortiGate devices, in seconds hostname: type: str description: System hostname. import_ignore_addr_cmt: aliases: ['import-ignore-addr-cmt'] type: str description: - Enable/Disable import ignore of address comments. - disable - Disable import ignore of address comments. - enable - Enable import ignore of address comments. choices: - 'disable' - 'enable' language: type: str description: - System global language. - english - English - simch - Simplified Chinese - japanese - Japanese - korean - Korean - spanish - Spanish - trach - Traditional Chinese choices: - 'english' - 'simch' - 'japanese' - 'korean' - 'spanish' - 'trach' latitude: type: str description: Fmg location latitude ldap_cache_timeout: aliases: ['ldap-cache-timeout'] type: int description: LDAP browser cache timeout ldapconntimeout: type: int description: LDAP connection timeout lock_preempt: aliases: ['lock-preempt'] type: str description: - Enable/disable ADOM lock override. - disable - Disable lock preempt. - enable - Enable lock preempt. choices: - 'disable' - 'enable' log_checksum: aliases: ['log-checksum'] type: str description: - Record log file hash value, timestamp, and authentication code at transmission or rolling. - none - No record log file checksum. - md5 - Record log files MD5 hash value only. - md5-auth - Record log files MD5 hash value and authentication code. choices: - 'none' - 'md5' - 'md5-auth' log_forward_cache_size: aliases: ['log-forward-cache-size'] type: int description: Log forwarding disk cache size longitude: type: str description: Fmg location longitude max_log_forward: aliases: ['max-log-forward'] type: int description: Maximum number of log-forward and aggregation settings. max_running_reports: aliases: ['max-running-reports'] type: int description: Maximum number of reports generating at one time. oftp_ssl_protocol: aliases: ['oftp-ssl-protocol'] type: str description: - set the lowest SSL protocols for oftpd. - sslv3 - set SSLv3 as the lowest version. - tlsv1. - tlsv1. - tlsv1. choices: - 'sslv3' - 'tlsv1.0' - 'tlsv1.1' - 'tlsv1.2' - 'tlsv1.3' partial_install: aliases: ['partial-install'] type: str description: - Enable/Disable partial install - disable - Disable partial install function. - enable - Enable partial install function. choices: - 'disable' - 'enable' partial_install_force: aliases: ['partial-install-force'] type: str description: - Enable/Disable partial install when devdb is modified. - disable - Disable partial install when devdb is modified. - enable - Enable partial install when devdb is modified. choices: - 'disable' - 'enable' partial_install_rev: aliases: ['partial-install-rev'] type: str description: - Enable/Disable auto creating adom revision for partial install. - disable - Disable partial install revision. - enable - Enable partial install revision. choices: - 'disable' - 'enable' perform_improve_by_ha: aliases: ['perform-improve-by-ha'] type: str description: - Enable/Disable performance improvement by distributing tasks to HA slaves. - disable - Disable performance improvement by HA. - enable - Enable performance improvement by HA. choices: - 'disable' - 'enable' policy_hit_count: aliases: ['policy-hit-count'] type: str description: - show policy hit count. - disable - Disable policy hit count. - enable - Enable policy hit count. choices: - 'disable' - 'enable' policy_object_in_dual_pane: aliases: ['policy-object-in-dual-pane'] type: str description: - show policies and objects in dual pane. - disable - Disable polices and objects in dual pane. - enable - Enable polices and objects in dual pane. choices: - 'disable' - 'enable' pre_login_banner: aliases: ['pre-login-banner'] type: str description: - Enable/disable pre-login banner. - disable - Disable pre-login banner. - enable - Enable pre-login banner. choices: - 'disable' - 'enable' pre_login_banner_message: aliases: ['pre-login-banner-message'] type: str description: Pre-login banner message. remoteauthtimeout: type: int description: Remote authentication search_all_adoms: aliases: ['search-all-adoms'] type: str description: - Enable/Disable Search all ADOMs for where-used query. - disable - Disable search all ADOMs for where-used queries. - enable - Enable search all ADOMs for where-used queries. choices: - 'disable' - 'enable' ssl_low_encryption: aliases: ['ssl-low-encryption'] type: str description: - SSL low-grade encryption. - disable - Disable SSL low-grade encryption. - enable - Enable SSL low-grade encryption. choices: - 'disable' - 'enable' ssl_protocol: aliases: ['ssl-protocol'] type: list elements: str description: - SSL protocols. - tlsv1. - tlsv1. - tlsv1. - sslv3 - Enable SSLv3. choices: - 'tlsv1.2' - 'tlsv1.1' - 'tlsv1.0' - 'sslv3' - 'tlsv1.3' ssl_static_key_ciphers: aliases: ['ssl-static-key-ciphers'] type: str description: - Enable/disable SSL static key ciphers. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' task_list_size: aliases: ['task-list-size'] type: int description: Maximum number of completed tasks to keep. tftp: type: str description: - Enable/disable TFTP in `exec restore image` command - disable - Disable TFTP - enable - Enable TFTP choices: - 'disable' - 'enable' timezone: type: str description: - Time zone. - 00 - - 01 - - 02 - - 03 - - 04 - - 05 - - 06 - - 07 - - 08 - - 09 - - 10 - - 11 - - 12 - - 13 - - 14 - - 15 - - 16 - - 17 - - 18 - - 19 - - 20 - - 21 - - 22 - - 23 - - 24 - - 25 - - 26 - - 27 - - 28 - - 29 - - 30 - - 31 - - 32 - - 33 - - 34 - - 35 - - 36 - - 37 - - 38 - - 39 - - 40 - - 41 - - 42 - - 43 - - 44 - - 45 - - 46 - - 47 - - 48 - - 49 - - 50 - - 51 - - 52 - - 53 - - 54 - - 55 - - 56 - - 57 - - 58 - - 59 - - 60 - - 61 - - 62 - - 63 - - 64 - - 65 - - 66 - - 67 - - 68 - - 69 - - 70 - - 71 - - 72 - - 73 - - 74 - - 75 - - 76 - - 77 - - 78 - - 79 - - 80 - - 81 - - 82 - - 83 - - 84 - - 85 - - 86 - - 87 - - 88 - - 89 - choices: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '62' - '63' - '64' - '65' - '66' - '67' - '68' - '69' - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '84' - '85' - '86' - '87' - '88' - '89' - '90' - '91' tunnel_mtu: aliases: ['tunnel-mtu'] type: int description: Maximum transportation unit usg: type: str description: - Enable/disable Fortiguard server restriction. - disable - Contact any Fortiguard server - enable - Contact Fortiguard server in USA only choices: - 'disable' - 'enable' vdom_mirror: aliases: ['vdom-mirror'] type: str description: - VDOM mirror. - disable - Disable VDOM mirror function. - enable - Enable VDOM mirror function. choices: - 'disable' - 'enable' webservice_proto: aliases: ['webservice-proto'] type: list elements: str description: - Web Service connection support SSL protocols. - tlsv1. - tlsv1. - tlsv1. - sslv3 - Web Service connection using SSLv3 protocol. - sslv2 - Web Service connection using SSLv2 protocol. choices: - 'tlsv1.2' - 'tlsv1.1' - 'tlsv1.0' - 'sslv3' - 'sslv2' - 'tlsv1.3' workflow_max_sessions: aliases: ['workflow-max-sessions'] type: int description: Maximum number of workflow sessions per ADOM workspace_mode: aliases: ['workspace-mode'] type: str description: - Set workspace mode - disabled - Workspace disabled. - normal - Workspace lock mode. - workflow - Workspace workflow mode. choices: - 'disabled' - 'normal' - 'workflow' - 'per-adom' clone_name_option: aliases: ['clone-name-option'] type: str description: - set the clone object names option. - default - Add a prefix of Clone of to the clone name. - keep - Keep the original name for user to edit. choices: - 'default' - 'keep' fgfm_ca_cert: aliases: ['fgfm-ca-cert'] type: str description: Set the extra fgfm CA certificates. mc_policy_disabled_adoms: aliases: ['mc-policy-disabled-adoms'] type: list elements: dict description: Mc policy disabled adoms. suboptions: adom_name: aliases: ['adom-name'] type: str description: Adom names. policy_object_icon: aliases: ['policy-object-icon'] type: str description: - show icons of policy objects. - disable - Disable icon of policy objects. - enable - Enable icon of policy objects. choices: - 'disable' - 'enable' private_data_encryption: aliases: ['private-data-encryption'] type: str description: - Enable/disable private data encryption using an AES 128-bit key. - disable - Disable private data encryption using an AES 128-bit key. - enable - Enable private data encryption using an AES 128-bit key. choices: - 'disable' - 'enable' per_policy_lock: aliases: ['per-policy-lock'] type: str description: - Enable/Disable per policy lock. - disable - Disable per policy lock. - enable - Enable per policy lock. choices: - 'disable' - 'enable' multiple_steps_upgrade_in_autolink: aliases: ['multiple-steps-upgrade-in-autolink'] type: str description: - Enable/disable multiple steps upgade in autolink process - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' object_revision_db_max: aliases: ['object-revision-db-max'] type: int description: Maximum revisions for a single database object_revision_mandatory_note: aliases: ['object-revision-mandatory-note'] type: str description: - Enable/disable mandatory note when create revision. - disable - Disable object revision. - enable - Enable object revision. choices: - 'disable' - 'enable' object_revision_object_max: aliases: ['object-revision-object-max'] type: int description: Maximum revisions for a single object object_revision_status: aliases: ['object-revision-status'] type: str description: - Enable/disable create revision when modify objects. - disable - Disable object revision. - enable - Enable object revision. choices: - 'disable' - 'enable' normalized_intf_zone_only: aliases: ['normalized-intf-zone-only'] type: str description: - allow normalized interface to be zone only. - disable - Disable SSL low-grade encryption. - enable - Enable SSL low-grade encryption. choices: - 'disable' - 'enable' ssl_cipher_suites: aliases: ['ssl-cipher-suites'] type: list elements: dict description: Ssl cipher suites. suboptions: cipher: type: str description: Cipher name priority: type: int description: SSL/TLS cipher suites priority. version: type: str description: - SSL/TLS version the cipher suite can be used with. - tls1. - tls1. choices: - 'tls1.2-or-below' - 'tls1.3' gui_curl_timeout: aliases: ['gui-curl-timeout'] type: int description: GUI curl timeout in seconds fgfm_cert_exclusive: aliases: ['fgfm-cert-exclusive'] type: str description: - set if the local or CA certificates should be used exclusively. - disable - Used certificate best-effort. - enable - Used certificate exclusive. choices: - 'disable' - 'enable' fgfm_deny_unknown: aliases: ['fgfm-deny-unknown'] type: str description: - set if allow devices with unknown SN actively register as an unauthorized device. - disable - Allow devices with unknown SN to actively register as an unauthorized device. - enable - Deny devices with unknown SN to actively register as an unauthorized device. choices: - 'disable' - 'enable' fgfm_peercert_withoutsn: aliases: ['fgfm-peercert-withoutsn'] type: str description: - set if the subject CN or SAN of peers SSL certificate sent in FGFM should include the serial number of the device. - disable - Peers certificate must include serial number in subject CN or SAN. - enable - Peers certificate might not include serial number in subject CN or SAN. choices: - 'disable' - 'enable' table_entry_blink: aliases: ['table-entry-blink'] type: str description: - Enable/disable table entry blink in GUI - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' contentpack_fgt_install: aliases: ['contentpack-fgt-install'] type: str description: - Enable/disable outbreak alert auto install for FGT ADOMS . - disable - Disable the sql report auto outbreak auto install. - enable - Enable the sql report auto outbreak auto install. choices: - 'disable' - 'enable' gui_polling_interval: aliases: ['gui-polling-interval'] type: int description: GUI polling interval in seconds no_copy_permission_check: aliases: ['no-copy-permission-check'] type: str description: - Do not perform permission check to block object changes in different adom during copy and install. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' ssh_enc_algo: aliases: ['ssh-enc-algo'] type: list elements: str description: - Select one or more SSH ciphers. - chacha20-poly1305@openssh. - aes128-ctr - aes192-ctr - aes256-ctr - arcfour256 - arcfour128 - aes128-cbc - 3des-cbc - blowfish-cbc - cast128-cbc - aes192-cbc - aes256-cbc - arcfour - rijndael-cbc@lysator. - aes128-gcm@openssh. - aes256-gcm@openssh. choices: - 'chacha20-poly1305@openssh.com' - 'aes128-ctr' - 'aes192-ctr' - 'aes256-ctr' - 'arcfour256' - 'arcfour128' - 'aes128-cbc' - '3des-cbc' - 'blowfish-cbc' - 'cast128-cbc' - 'aes192-cbc' - 'aes256-cbc' - 'arcfour' - 'rijndael-cbc@lysator.liu.se' - 'aes128-gcm@openssh.com' - 'aes256-gcm@openssh.com' ssh_hostkey_algo: aliases: ['ssh-hostkey-algo'] type: list elements: str description: - Select one or more SSH hostkey algorithms. - ssh-rsa - ecdsa-sha2-nistp521 - rsa-sha2-256 - rsa-sha2-512 - ssh-ed25519 choices: - 'ssh-rsa' - 'ecdsa-sha2-nistp521' - 'rsa-sha2-256' - 'rsa-sha2-512' - 'ssh-ed25519' ssh_kex_algo: aliases: ['ssh-kex-algo'] type: list elements: str description: - Select one or more SSH kex algorithms. - diffie-hellman-group1-sha1 - diffie-hellman-group14-sha1 - diffie-hellman-group14-sha256 - diffie-hellman-group16-sha512 - diffie-hellman-group18-sha512 - diffie-hellman-group-exchange-sha1 - diffie-hellman-group-exchange-sha256 - curve25519-sha256@libssh. - ecdh-sha2-nistp256 - ecdh-sha2-nistp384 - ecdh-sha2-nistp521 choices: - 'diffie-hellman-group1-sha1' - 'diffie-hellman-group14-sha1' - 'diffie-hellman-group14-sha256' - 'diffie-hellman-group16-sha512' - 'diffie-hellman-group18-sha512' - 'diffie-hellman-group-exchange-sha1' - 'diffie-hellman-group-exchange-sha256' - 'curve25519-sha256@libssh.org' - 'ecdh-sha2-nistp256' - 'ecdh-sha2-nistp384' - 'ecdh-sha2-nistp521' ssh_mac_algo: aliases: ['ssh-mac-algo'] type: list elements: str description: - Select one or more SSH MAC algorithms. - hmac-md5 - hmac-md5-etm@openssh. - hmac-md5-96 - hmac-md5-96-etm@openssh. - hmac-sha1 - hmac-sha1-etm@openssh. - hmac-sha2-256 - hmac-sha2-256-etm@openssh. - hmac-sha2-512 - hmac-sha2-512-etm@openssh. - hmac-ripemd160 - hmac-ripemd160@openssh. - hmac-ripemd160-etm@openssh. - umac-64@openssh. - umac-128@openssh. - umac-64-etm@openssh. - umac-128-etm@openssh. choices: - 'hmac-md5' - 'hmac-md5-etm@openssh.com' - 'hmac-md5-96' - 'hmac-md5-96-etm@openssh.com' - 'hmac-sha1' - 'hmac-sha1-etm@openssh.com' - 'hmac-sha2-256' - 'hmac-sha2-256-etm@openssh.com' - 'hmac-sha2-512' - 'hmac-sha2-512-etm@openssh.com' - 'hmac-ripemd160' - 'hmac-ripemd160@openssh.com' - 'hmac-ripemd160-etm@openssh.com' - 'umac-64@openssh.com' - 'umac-128@openssh.com' - 'umac-64-etm@openssh.com' - 'umac-128-etm@openssh.com' ssh_strong_crypto: aliases: ['ssh-strong-crypto'] type: str description: - Only allow strong ciphers for SSH when enabled. - disable - Disable strong crypto for SSH. - enable - Enable strong crypto for SSH. choices: - 'disable' - 'enable' admin_lockout_method: aliases: ['admin-lockout-method'] type: str description: - Lockout method for administration. - ip - Lockout by IP - user - Lockout by user choices: - 'ip' - 'user' workspace_unlock_after_install: aliases: ['workspace-unlock-after-install'] type: str description: - Enable/disable ADOM auto-unlock after device installation. - disable - Disable automatically unlock adom after device installation. - enable - Enable automatically unlock adom after device installation. choices: - 'disable' - 'enable' log_checksum_upload: aliases: ['log-checksum-upload'] type: str description: - Enable/disable upload log checksum with log files. - disable - Disable attribute function. - enable - Enable attribute function. choices: - 'disable' - 'enable' apache_mode: aliases: ['apache-mode'] type: str description: - Set apache mode. - event - Apache event mode. - prefork - Apache prefork mode. choices: - 'event' - 'prefork' no_vip_value_check: aliases: ['no-vip-value-check'] type: str description: - Enable/disable skipping policy instead of throwing error when vip has no default or dynamic mapping during policy copy - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' fortiservice_port: aliases: ['fortiservice-port'] type: int description: FortiService port management_ip: aliases: ['management-ip'] type: str description: Management IP address of this FortiGate. management_port: aliases: ['management-port'] type: int description: Overriding port for management connection save_last_hit_in_adomdb: aliases: ['save-last-hit-in-adomdb'] type: str description: - Enable/Disable save last-hit value in adomdb. - disable - Disable save last-hit value in adomdb. - enable - Enable save last-hit value in adomdb. choices: - 'disable' - 'enable' api_ip_binding: aliases: ['api-ip-binding'] type: str description: - Enable/disable source IP check for JSON API request. - disable - Disable setting. - enable - Enable setting. choices: - 'disable' - 'enable' admin_host: aliases: ['admin-host'] type: str description: Administrative host for HTTP and HTTPs. admin_ssh_grace_time: aliases: ['admin-ssh-grace-time'] type: int description: Maximum time in seconds permitted between making an SSH connection to the FortiManager unit and authenticating fabric_storage_pool_quota: aliases: ['fabric-storage-pool-quota'] type: int description: Disk quota for Fabric fabric_storage_pool_size: aliases: ['fabric-storage-pool-size'] type: int description: Max storage pooll size fcp_cfg_service: aliases: ['fcp-cfg-service'] type: str description: - Enable/disable FCP service processing configuration requests - disable - FCP service doesn't process configuration requests from web - enable - FCP service processes configuration requests from web. choices: - 'disable' - 'enable' jsonapi_log: aliases: ['jsonapi-log'] type: str description: - enable jsonapi log. - disable - disable jsonapi log. - request - logging jsonapi request. - response - logging jsonapi response. - all - logging both jsonapi request & response. choices: - 'disable' - 'request' - 'response' - 'all' global_ssl_protocol: aliases: ['global-ssl-protocol'] type: str description: - set the lowest SSL protocol version for all SSL connections. - sslv3 - set SSLv3 as the lowest version. - tlsv1. - tlsv1. - tlsv1. - tlsv1. choices: - 'sslv3' - 'tlsv1.0' - 'tlsv1.1' - 'tlsv1.2' - 'tlsv1.3' httpd_ssl_protocol: aliases: ['httpd-ssl-protocol'] type: list elements: str description: - set SSL protocols for apache daemon - sslv3 - Enable SSLv3. - tlsv1. - tlsv1. - tlsv1. - tlsv1. choices: - 'sslv3' - 'tlsv1.0' - 'tlsv1.1' - 'tlsv1.2' - 'tlsv1.3' mapclient_ssl_protocol: aliases: ['mapclient-ssl-protocol'] type: str description: - set the lowest SSL protocol version for connection to mapserver. - follow-global-ssl-protocol - Follow system. - sslv3 - set SSLv3 as the lowest version. - tlsv1. - tlsv1. - tlsv1. - tlsv1. choices: - 'follow-global-ssl-protocol' - 'sslv3' - 'tlsv1.0' - 'tlsv1.1' - 'tlsv1.2' - 'tlsv1.3' apache_wsgi_processes: aliases: ['apache-wsgi-processes'] type: int description: Apache wsgi processes. fmg_fabric_port: aliases: ['fmg-fabric-port'] type: int description: Fmg fabric port. gui_feature_visibility_mode: aliases: ['gui-feature-visibility-mode'] type: str description: Gui feature visibility mode. choices: - 'per-adom' - 'per-admin' storage_age_limit: aliases: ['storage-age-limit'] type: int description: Storage age limit. ''' EXAMPLES = ''' - name: Example playbook hosts: fortimanagers connection: httpapi vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Enable workspace mode fortinet.fortimanager.fmgr_system_global: system_global: adom-status: enable workspace-mode: normal - name: Script table. fortinet.fortimanager.fmgr_dvmdb_script: bypass_validation: false adom: root state: present workspace_locking_adom: "root" dvmdb_script: content: "ansiblt-test" name: "fooscript000" target: device_database type: cli - name: Verify script table fortinet.fortimanager.fmgr_fact: facts: selector: "dvmdb_script" params: adom: "root" script: "fooscript000" register: info failed_when: info.meta.response_code != 0 - name: Restore workspace mode fortinet.fortimanager.fmgr_system_global: system_global: adom-status: enable workspace-mode: disabled ''' RETURN = ''' meta: description: The result of the request. type: dict returned: always contains: request_url: description: The full url requested. returned: always type: str sample: /sys/login/user response_code: description: The status of api request. returned: always type: int sample: 0 response_data: description: The api response. type: list returned: always response_message: description: The descriptive message of the api response. type: str returned: always sample: OK. system_information: description: The information of the target system. type: dict returned: always rc: description: The status the request. type: int returned: always sample: 0 version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. type: list returned: complex ''' from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.connection import Connection from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager, check_galaxy_version, check_parameter_bypass from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec def main(): urls_list = [ '/cli/global/system/global' ] url_params = [] module_primary_key = None module_arg_spec = { 'system_global': { 'type': 'dict', 'v_range': [['6.0.0', '']], 'options': { 'admin-lockout-duration': {'type': 'int'}, 'admin-lockout-threshold': {'type': 'int'}, 'adom-mode': {'choices': ['normal', 'advanced'], 'type': 'str'}, 'adom-rev-auto-delete': {'choices': ['disable', 'by-revisions', 'by-days'], 'type': 'str'}, 'adom-rev-max-backup-revisions': {'type': 'int'}, 'adom-rev-max-days': {'type': 'int'}, 'adom-rev-max-revisions': {'type': 'int'}, 'adom-select': {'choices': ['disable', 'enable'], 'type': 'str'}, 'adom-status': {'choices': ['disable', 'enable'], 'type': 'str'}, 'clt-cert-req': {'choices': ['disable', 'enable', 'optional'], 'type': 'str'}, 'console-output': {'choices': ['standard', 'more'], 'type': 'str'}, 'country-flag': {'choices': ['disable', 'enable'], 'type': 'str'}, 'create-revision': {'choices': ['disable', 'enable'], 'type': 'str'}, 'daylightsavetime': {'choices': ['disable', 'enable'], 'type': 'str'}, 'default-disk-quota': {'v_range': [['6.0.0', '6.2.0']], 'type': 'int'}, 'detect-unregistered-log-device': {'choices': ['disable', 'enable'], 'type': 'str'}, 'device-view-mode': {'choices': ['regular', 'tree'], 'type': 'str'}, 'dh-params': {'choices': ['1024', '1536', '2048', '3072', '4096', '6144', '8192'], 'type': 'str'}, 'disable-module': { 'type': 'list', 'choices': ['fortiview-noc', 'none', 'fortirecorder', 'siem', 'soc', 'ai', 'safeguard-mv'], 'elements': 'str' }, 'enc-algorithm': {'choices': ['low', 'medium', 'high', 'custom'], 'type': 'str'}, 'faz-status': {'choices': ['disable', 'enable'], 'type': 'str'}, 'fgfm-local-cert': {'type': 'str'}, 'fgfm-ssl-protocol': {'choices': ['sslv3', 'tlsv1.0', 'tlsv1.1', 'tlsv1.2', 'tlsv1.3', 'follow-global-ssl-protocol'], 'type': 'str'}, 'ha-member-auto-grouping': {'choices': ['disable', 'enable'], 'type': 'str'}, 'hitcount_concurrent': {'v_range': [['6.0.0', '6.4.2']], 'type': 'int'}, 'hitcount_interval': {'v_range': [['6.0.0', '6.4.2']], 'type': 'int'}, 'hostname': {'type': 'str'}, 'import-ignore-addr-cmt': {'choices': ['disable', 'enable'], 'type': 'str'}, 'language': {'choices': ['english', 'simch', 'japanese', 'korean', 'spanish', 'trach'], 'type': 'str'}, 'latitude': {'type': 'str'}, 'ldap-cache-timeout': {'type': 'int'}, 'ldapconntimeout': {'type': 'int'}, 'lock-preempt': {'choices': ['disable', 'enable'], 'type': 'str'}, 'log-checksum': {'choices': ['none', 'md5', 'md5-auth'], 'type': 'str'}, 'log-forward-cache-size': {'type': 'int'}, 'longitude': {'type': 'str'}, 'max-log-forward': {'type': 'int'}, 'max-running-reports': {'type': 'int'}, 'oftp-ssl-protocol': {'choices': ['sslv3', 'tlsv1.0', 'tlsv1.1', 'tlsv1.2', 'tlsv1.3'], 'type': 'str'}, 'partial-install': {'choices': ['disable', 'enable'], 'type': 'str'}, 'partial-install-force': {'choices': ['disable', 'enable'], 'type': 'str'}, 'partial-install-rev': {'choices': ['disable', 'enable'], 'type': 'str'}, 'perform-improve-by-ha': {'choices': ['disable', 'enable'], 'type': 'str'}, 'policy-hit-count': {'v_range': [['6.0.0', '6.4.2']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'policy-object-in-dual-pane': {'choices': ['disable', 'enable'], 'type': 'str'}, 'pre-login-banner': {'choices': ['disable', 'enable'], 'type': 'str'}, 'pre-login-banner-message': {'type': 'str'}, 'remoteauthtimeout': {'type': 'int'}, 'search-all-adoms': {'choices': ['disable', 'enable'], 'type': 'str'}, 'ssl-low-encryption': {'choices': ['disable', 'enable'], 'type': 'str'}, 'ssl-protocol': { 'v_range': [['6.0.0', '7.4.3'], ['7.6.0', '7.6.1']], 'type': 'list', 'choices': ['tlsv1.2', 'tlsv1.1', 'tlsv1.0', 'sslv3', 'tlsv1.3'], 'elements': 'str' }, 'ssl-static-key-ciphers': {'choices': ['disable', 'enable'], 'type': 'str'}, 'task-list-size': {'type': 'int'}, 'tftp': {'choices': ['disable', 'enable'], 'type': 'str'}, 'timezone': { 'choices': [ '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91' ], 'type': 'str' }, 'tunnel-mtu': {'type': 'int'}, 'usg': {'choices': ['disable', 'enable'], 'type': 'str'}, 'vdom-mirror': {'choices': ['disable', 'enable'], 'type': 'str'}, 'webservice-proto': {'type': 'list', 'choices': ['tlsv1.2', 'tlsv1.1', 'tlsv1.0', 'sslv3', 'sslv2', 'tlsv1.3'], 'elements': 'str'}, 'workflow-max-sessions': {'type': 'int'}, 'workspace-mode': {'choices': ['disabled', 'normal', 'workflow', 'per-adom'], 'type': 'str'}, 'clone-name-option': {'v_range': [['6.2.2', '']], 'choices': ['default', 'keep'], 'type': 'str'}, 'fgfm-ca-cert': {'v_range': [['6.2.3', '']], 'type': 'str'}, 'mc-policy-disabled-adoms': { 'v_range': [['6.2.3', '']], 'type': 'list', 'options': {'adom-name': {'v_range': [['6.2.3', '']], 'type': 'str'}}, 'elements': 'dict' }, 'policy-object-icon': {'v_range': [['6.2.2', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'private-data-encryption': {'v_range': [['6.2.5', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'per-policy-lock': {'v_range': [['6.4.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'multiple-steps-upgrade-in-autolink': {'v_range': [['6.4.5', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'object-revision-db-max': {'v_range': [['7.0.0', '']], 'type': 'int'}, 'object-revision-mandatory-note': {'v_range': [['7.0.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'object-revision-object-max': {'v_range': [['7.0.0', '']], 'type': 'int'}, 'object-revision-status': {'v_range': [['7.0.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'normalized-intf-zone-only': {'v_range': [['6.4.7', '6.4.15'], ['7.0.3', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'ssl-cipher-suites': { 'v_range': [['6.4.8', '6.4.15'], ['7.0.2', '']], 'type': 'list', 'options': { 'cipher': {'v_range': [['6.4.8', '6.4.15'], ['7.0.2', '']], 'type': 'str'}, 'priority': {'v_range': [['6.4.8', '6.4.15'], ['7.0.2', '']], 'type': 'int'}, 'version': {'v_range': [['6.4.8', '6.4.15'], ['7.0.2', '']], 'choices': ['tls1.2-or-below', 'tls1.3'], 'type': 'str'} }, 'elements': 'dict' }, 'gui-curl-timeout': {'v_range': [['6.4.11', '6.4.15'], ['7.0.7', '7.0.13'], ['7.2.2', '']], 'type': 'int'}, 'fgfm-cert-exclusive': { 'v_range': [['6.4.15', '6.4.15'], ['7.0.12', '7.0.13'], ['7.2.2', '']], 'choices': ['disable', 'enable'], 'type': 'str' }, 'fgfm-deny-unknown': { 'v_range': [['6.4.15', '6.4.15'], ['7.0.12', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.3', '']], 'choices': ['disable', 'enable'], 'type': 'str' }, 'fgfm-peercert-withoutsn': { 'v_range': [['6.4.15', '6.4.15'], ['7.0.12', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.3', '7.6.1']], 'choices': ['disable', 'enable'], 'type': 'str' }, 'table-entry-blink': {'v_range': [['7.0.4', '7.0.13'], ['7.2.1', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'contentpack-fgt-install': {'v_range': [['7.0.5', '7.0.13'], ['7.2.2', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'gui-polling-interval': {'v_range': [['7.0.5', '7.0.13'], ['7.2.1', '']], 'type': 'int'}, 'no-copy-permission-check': {'v_range': [['7.0.8', '7.0.13'], ['7.2.3', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'ssh-enc-algo': { 'v_range': [['7.0.11', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.2', '']], 'type': 'list', 'choices': [ 'chacha20-poly1305@openssh.com', 'aes128-ctr', 'aes192-ctr', 'aes256-ctr', 'arcfour256', 'arcfour128', 'aes128-cbc', '3des-cbc', 'blowfish-cbc', 'cast128-cbc', 'aes192-cbc', 'aes256-cbc', 'arcfour', 'rijndael-cbc@lysator.liu.se', 'aes128-gcm@openssh.com', 'aes256-gcm@openssh.com' ], 'elements': 'str' }, 'ssh-hostkey-algo': { 'v_range': [['7.0.11', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.2', '']], 'type': 'list', 'choices': ['ssh-rsa', 'ecdsa-sha2-nistp521', 'rsa-sha2-256', 'rsa-sha2-512', 'ssh-ed25519'], 'elements': 'str' }, 'ssh-kex-algo': { 'v_range': [['7.0.11', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.2', '']], 'type': 'list', 'choices': [ 'diffie-hellman-group1-sha1', 'diffie-hellman-group14-sha1', 'diffie-hellman-group14-sha256', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha1', 'diffie-hellman-group-exchange-sha256', 'curve25519-sha256@libssh.org', 'ecdh-sha2-nistp256', 'ecdh-sha2-nistp384', 'ecdh-sha2-nistp521' ], 'elements': 'str' }, 'ssh-mac-algo': { 'v_range': [['7.0.11', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.2', '']], 'type': 'list', 'choices': [ 'hmac-md5', 'hmac-md5-etm@openssh.com', 'hmac-md5-96', 'hmac-md5-96-etm@openssh.com', 'hmac-sha1', 'hmac-sha1-etm@openssh.com', 'hmac-sha2-256', 'hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512', 'hmac-sha2-512-etm@openssh.com', 'hmac-ripemd160', 'hmac-ripemd160@openssh.com', 'hmac-ripemd160-etm@openssh.com', 'umac-64@openssh.com', 'umac-128@openssh.com', 'umac-64-etm@openssh.com', 'umac-128-etm@openssh.com' ], 'elements': 'str' }, 'ssh-strong-crypto': { 'v_range': [['7.0.11', '7.0.13'], ['7.2.5', '7.2.9'], ['7.4.2', '']], 'choices': ['disable', 'enable'], 'type': 'str' }, 'admin-lockout-method': {'v_range': [['7.2.2', '']], 'choices': ['ip', 'user'], 'type': 'str'}, 'workspace-unlock-after-install': {'v_range': [['7.2.2', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'log-checksum-upload': {'v_range': [['7.2.3', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'apache-mode': {'v_range': [['7.2.4', '7.2.9'], ['7.4.1', '']], 'choices': ['event', 'prefork'], 'type': 'str'}, 'no-vip-value-check': {'v_range': [['7.2.4', '7.2.9'], ['7.4.1', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'fortiservice-port': {'v_range': [['7.4.1', '']], 'type': 'int'}, 'management-ip': {'v_range': [['7.4.1', '']], 'type': 'str'}, 'management-port': {'v_range': [['7.4.1', '']], 'type': 'int'}, 'save-last-hit-in-adomdb': {'v_range': [['7.4.1', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'api-ip-binding': {'v_range': [['7.4.2', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'admin-host': {'v_range': [['7.4.4', '']], 'type': 'str'}, 'admin-ssh-grace-time': {'v_range': [['7.2.6', '7.2.9'], ['7.4.4', '']], 'type': 'int'}, 'fabric-storage-pool-quota': {'v_range': [['7.6.0', '']], 'type': 'int'}, 'fabric-storage-pool-size': {'v_range': [['7.6.0', '']], 'type': 'int'}, 'fcp-cfg-service': {'v_range': [['7.2.6', '7.2.9'], ['7.4.4', '']], 'choices': ['disable', 'enable'], 'type': 'str'}, 'jsonapi-log': {'v_range': [['7.6.0', '']], 'choices': ['disable', 'request', 'response', 'all'], 'type': 'str'}, 'global-ssl-protocol': { 'v_range': [['7.4.4', '7.4.5'], ['7.6.2', '']], 'choices': ['sslv3', 'tlsv1.0', 'tlsv1.1', 'tlsv1.2', 'tlsv1.3'], 'type': 'str' }, 'httpd-ssl-protocol': { 'v_range': [['7.4.4', '7.4.5'], ['7.6.2', '']], 'type': 'list', 'choices': ['sslv3', 'tlsv1.0', 'tlsv1.1', 'tlsv1.2', 'tlsv1.3'], 'elements': 'str' }, 'mapclient-ssl-protocol': { 'v_range': [['7.4.4', '7.4.5'], ['7.6.2', '']], 'choices': ['follow-global-ssl-protocol', 'sslv3', 'tlsv1.0', 'tlsv1.1', 'tlsv1.2', 'tlsv1.3'], 'type': 'str' }, 'apache-wsgi-processes': {'v_range': [['7.6.2', '']], 'type': 'int'}, 'fmg-fabric-port': {'v_range': [['7.6.2', '']], 'type': 'int'}, 'gui-feature-visibility-mode': {'v_range': [['7.6.2', '']], 'choices': ['per-adom', 'per-admin'], 'type': 'str'}, 'storage-age-limit': {'v_range': [['7.6.2', '']], 'type': 'int'} } } } module_option_spec = get_module_arg_spec('partial crud') module_arg_spec.update(module_option_spec) params_validation_blob = [] check_galaxy_version(module_arg_spec) module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'system_global'), supports_check_mode=True) if not module._socket_path: module.fail_json(msg='MUST RUN IN HTTPAPI MODE') connection = Connection(module._socket_path) fmgr = NAPIManager('partial crud', module_arg_spec, urls_list, module_primary_key, url_params, module, connection, top_level_schema_name='data') fmgr.validate_parameters(params_validation_blob) fmgr.process_partial_crud() module.exit_json(meta=module.params) if __name__ == '__main__': main()