- source
fmgr_devprof_log_fortianalyzercloud_setting.py
- orphan
2.1.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.2.1 -> v6.2.5
, v6.2.7 -> v6.4.1
, v6.4.3 -> latest
- 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
- 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
- adom - The parameter in requested url type: str required: true
- devprof - The parameter in requested url type: str required: true
- devprof_log_fortianalyzercloud_setting - Global FortiAnalyzer Cloud settings. type: dict
- __change_ip Hidden attribute. type: int
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- access_config (Alias name: access-config) Enable/disable fortianalyzer access to configuration and data. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- certificate Certificate used to communicate with fortianalyzer. type: str
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- conn_timeout (Alias name: conn-timeout) Fortianalyzer connection time-out in seconds (for status and log buffer). type: int
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- enc_algorithm (Alias name: enc-algorithm) Configure the level of ssl protection for secure communication with fortianalyzer. type: str choices: [high, low, high-medium, low-medium]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- hmac_algorithm (Alias name: hmac-algorithm) Fortianalyzer ipsec tunnel hmac algorithm. type: str choices: [sha256, sha1]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- ips_archive (Alias name: ips-archive) Enable/disable ips packet archive logging. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- monitor_failure_retry_period (Alias name: monitor-failure-retry-period) Time between fortianalyzer connection retries in seconds (for status and log buffer). type: int
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- monitor_keepalive_period (Alias name: monitor-keepalive-period) Time between oftp keepalives in seconds (for status and log buffer). type: int
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- source_ip (Alias name: source-ip) Source ipv4 or ipv6 address used to communicate with fortianalyzer. type: str
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> 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-1, TLSv1-2, SSLv3, TLSv1, TLSv1-3]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- status Enable/disable logging to fortianalyzer. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- upload_day (Alias name: upload-day) Day of week (month) to upload logs. type: str
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- upload_interval (Alias name: upload-interval) Frequency to upload log files to fortianalyzer. type: str choices: [daily, weekly, monthly]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- upload_option (Alias name: upload-option) Enable/disable logging to hard disk and then uploading to fortianalyzer. type: str choices: [store-and-upload, realtime, 1-minute, 5-minute]
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- upload_time (Alias name: upload-time) Time to upload logs (hh:mm). type: str
more...
Supported Version Ranges:
v6.2.1 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- max_log_rate (Alias name: max-log-rate) Fortianalyzer maximum log rate in mbps (0 = unlimited). type: int
more...
Supported Version Ranges:
v6.2.2 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- priority Set log transmission priority. type: str choices: [low, default]
more...
Supported Version Ranges:
v6.2.2 -> v6.2.5
,v6.2.7 -> v6.4.1
,v6.4.3 -> latest
- interface Specify outgoing interface to reach server. type: str
more...
Supported Version Ranges:
v6.2.7 -> v6.2.12
,v6.4.3 -> 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:
v6.2.7 -> v6.2.12
,v6.4.3 -> latest
- preshared_key (Alias name: preshared-key) Preshared-key used for auto-authorization on fortianalyzer. type: str
more...
Supported Version Ranges:
v7.0.0 -> latest
- certificate_verification (Alias name: certificate-verification) Enable/disable identity verification of fortianalyzer by use of certificate. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.3 -> latest
- serial type: list
more...
Supported Version Ranges:
v7.0.3 -> latest
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
- 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: Global FortiAnalyzer Cloud settings.
fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting:
# 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>
devprof: <your own value>
devprof_log_fortianalyzercloud_setting:
__change_ip: <integer>
access_config: <value in [disable, enable]>
certificate: <string>
conn_timeout: <integer>
enc_algorithm: <value in [high, low, high-medium, ...]>
hmac_algorithm: <value in [sha256, sha1]>
ips_archive: <value in [disable, enable]>
monitor_failure_retry_period: <integer>
monitor_keepalive_period: <integer>
source_ip: <string>
ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
status: <value in [disable, enable]>
upload_day: <string>
upload_interval: <value in [daily, weekly, monthly]>
upload_option: <value in [store-and-upload, realtime, 1-minute, ...]>
upload_time: <string>
max_log_rate: <integer>
priority: <value in [low, default]>
interface: <string>
interface_select_method: <value in [auto, sdwan, specify]>
preshared_key: <string>
certificate_verification: <value in [disable, enable]>
serial: <list or string>
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:
- 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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)