fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting – Global FortiAnalyzer Cloud settings.  Note This plugin is part of the fortinet.fortimanager collection (version 2.1.3). You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list. To install it, use: ansible-galaxy collection install fortinet.fortimanager. To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_log_fortianalyzercloud_setting.   New in version 2.10: of fortinet.fortimanager   Synopsis Parameters Notes Examples Return Values  Synopsis  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.  Parameters   Parameter Choices/Defaults Comments    adom  string / required      the parameter (adom) in requested url     bypass_validation  boolean    
Choices: 
no ← yes    only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters     devprof  string / required      the parameter (devprof) in requested url     devprof_log_fortianalyzercloud_setting  dictionary      the top level parameters set      __change_ip  integer      Hidden attribute.      access-config  string    
Choices: disable enable    Enable/disable FortiAnalyzer access to configuration and data.      certificate  string      Certificate used to communicate with FortiAnalyzer.      conn-timeout  integer      FortiAnalyzer connection time-out in seconds (for status and log buffer).      enc-algorithm  string    
Choices: high low high-medium    Configure the level of SSL protection for secure communication with FortiAnalyzer.      hmac-algorithm  string    
Choices: sha256 sha1    FortiAnalyzer IPsec tunnel HMAC algorithm.      interface  string      Specify outgoing interface to reach server.      interface-select-method  string    
Choices: auto sdwan specify    Specify how to select outgoing interface to reach server.      ips-archive  string    
Choices: disable enable    Enable/disable IPS packet archive logging.      max-log-rate  integer      FortiAnalyzer maximum log rate in MBps (0 = unlimited).      monitor-failure-retry-period  integer      Time between FortiAnalyzer connection retries in seconds (for status and log buffer).      monitor-keepalive-period  integer      Time between OFTP keepalives in seconds (for status and log buffer).      preshared-key  string      Preshared-key used for auto-authorization on FortiAnalyzer.      priority  string    
Choices: low default    Set log transmission priority.      source-ip  string      Source IPv4 or IPv6 address used to communicate with FortiAnalyzer.      ssl-min-proto-version  string    
Choices: default TLSv1-1 TLSv1-2 SSLv3 TLSv1    Minimum supported protocol version for SSL/TLS connections (default is to follow system global setting).      status  string    
Choices: disable enable    Enable/disable logging to FortiAnalyzer.      upload-day  string      Day of week (month) to upload logs.      upload-interval  string    
Choices: daily weekly monthly    Frequency to upload log files to FortiAnalyzer.      upload-option  string    
Choices: store-and-upload realtime 1-minute 5-minute    Enable/disable logging to hard disk and then uploading to FortiAnalyzer.      upload-time  string      Time to upload logs (hh:mm).     enable_log  boolean    
Choices: 
no ← yes    Enable/Disable logging for task     proposed_method  string    
Choices: update set add    The overridden method for the underlying Json RPC request     rc_failed  list / elements=string      the rc codes list with which the conditions to fail will be overriden     rc_succeeded  list / elements=string      the rc codes list with which the conditions to succeed will be overriden     state  string / required    
Choices: present absent    the directive to create, update or delete an object     workspace_locking_adom  string      the adom to lock for FortiManager running in workspace mode, the value can be global and others including root     workspace_locking_timeout  integer    Default:300   the maximum time in seconds to wait for other user to release the workspace lock     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 - hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Global FortiAnalyzer Cloud settings.
     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: <value of integer>
           access-config: <value in [disable, enable]>
           certificate: <value of string>
           conn-timeout: <value of 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: <value of integer>
           monitor-keepalive-period: <value of integer>
           source-ip: <value of string>
           ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
           status: <value in [disable, enable]>
           upload-day: <value of string>
           upload-interval: <value in [daily, weekly, monthly]>
           upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
           upload-time: <value of string>
           max-log-rate: <value of integer>
           priority: <value in [low, default]>
           interface: <value of string>
           interface-select-method: <value in [auto, sdwan, specify]>
           preshared-key: <value of string>
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    request_url  string   always  The full url requested  Sample: /sys/login/user     response_code  integer   always  The status of api request      response_message  string   always  The descriptive message of the api response  Sample: OK.     Authors  Link Zheng (@chillancezen) Jie Xue (@JieX19) Frank Shen (@fshen01) Hongbin Lu (@fgtdev-hblu) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible/collections/fortinet/fortimanager/fmgr_devprof_log_fortianalyzercloud_setting_module.html', 'source': 'DevDocs.IO'}