drmofu.fortianalyzer.faz_cli_fmupdate_fdssetting_updateschedule (1.3.0) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0

Add to requirements.yml

  collections:
    - name: drmofu.fortianalyzer
      version: 1.3.0

Description

This module is able to configure a FortiAnalyzer device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- collections:
    - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer_inventory
  tasks:
    - faz_cli_fmupdate_fdssetting_updateschedule:
        cli_fmupdate_fdssetting_updateschedule:
          day: Sunday
          frequency: weekly
          status: enable
          time: "0:0"
      name:
        Configure the schedule when built-in FortiGuard retrieves antivirus and
        IPS updates.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Inputs

    
log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - The path to save log. Used if enable_log is true.
    - Please use absolute path instead of relative path.
    - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
    required: false
    type: str

rc_failed:
    description: the rc codes list with which the conditions to fail will be overriden
    elements: int
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: the rc codes list with which the conditions to succeed will be overriden
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - set
    - update
    - add
    description: The overridden method for the underlying Json RPC request
    required: false
    type: str

bypass_validation:
    default: false
    description: only set to True when module schema diffs with FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

cli_fmupdate_fdssetting_updateschedule:
    description: the top level parameters set
    required: false
    suboptions:
      day:
        choices:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
        description:
        - Configure the day the update will occur, if the freqnecy is weekly (Sunday -
          Saturday, default = Monday).
        - Sunday - Update every Sunday.
        - Monday - Update every Monday.
        - Tuesday - Update every Tuesday.
        - Wednesday - Update every Wednesday.
        - Thursday - Update every Thursday.
        - Friday - Update every Friday.
        - Saturday - Update every Saturday.
        type: str
      frequency:
        choices:
        - every
        - daily
        - weekly
        description:
        - 'Configure update frequency: every - time interval, daily - once a day, weekly
          - once a week (default = every).'
        - every - Time interval.
        - daily - Every day.
        - weekly - Every week.
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable scheduled updates.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      time:
        description: no description
        type: str
    type: dict

Outputs

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 fortianalyzer version.
  returned: complex
  type: list