fmgr_firewall_casbprofile.rst

source

fmgr_firewall_casbprofile.py

orphan

fmgr_firewall_casbprofile -- Firewall casb profile.

2.3.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.

Synopsis

• 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.

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.1 -> v7.4.1

Parameters

• 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
• state - The directive to create, update or delete an object type: str required: true choices: present, absent
• 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
• firewall_casbprofile - Firewall casb profile type: dict
• name type: str more...

  Supported Version Ranges: v7.4.1 -> v7.4.1

• saas_application (Alias name: saas-application) type: list more...

  Supported Version Ranges: v7.4.1 -> v7.4.1

  • access_rule (Alias name: access-rule) type: list more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

    • action type: str choices: [block, monitor, bypass] more...

      Supported Version Ranges: v7.4.1 -> v7.4.1

    • bypass type: list choices: [av, dlp, web-filter, file-filter, video-filter] more...

      Supported Version Ranges: v7.4.1 -> v7.4.1

    • name type: str more...

      Supported Version Ranges: v7.4.1 -> v7.4.1

  • custom_control (Alias name: custom-control) type: list more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

    • name type: str more...

      Supported Version Ranges: v7.4.1 -> v7.4.1

    • option type: list more...

      Supported Version Ranges: v7.4.1 -> v7.4.1

      • name type: str more...

        Supported Version Ranges: v7.4.1 -> v7.4.1

      • user_input (Alias name: user-input) type: list more...

        Supported Version Ranges: v7.4.1 -> v7.4.1

  • domain_control (Alias name: domain-control) type: str choices: [disable, enable] more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • domain_control_domains (Alias name: domain-control-domains) type: list more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • log type: str choices: [disable, enable] more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • name type: str more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • safe_search (Alias name: safe-search) type: str choices: [disable, enable] more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • safe_search_control (Alias name: safe-search-control) type: list more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • tenant_control (Alias name: tenant-control) type: str choices: [disable, enable] more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

  • tenant_control_tenants (Alias name: tenant-control-tenants) type: list more...

    Supported Version Ranges: v7.4.1 -> v7.4.1

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

- 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: Firewall casb profile
      fortinet.fortimanager.fmgr_firewall_casbprofile:
        # 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>
        state: present # <value in [present, absent]>
        firewall_casbprofile:
          name: <string>
          saas_application:
            -
              access_rule:
                -
                  action: <value in [block, monitor, bypass]>
                  bypass:
                    - av
                    - dlp
                    - web-filter
                    - file-filter
                    - video-filter
                  name: <string>
              custom_control:
                -
                  name: <string>
                  option:
                    -
                      name: <string>
                      user_input: <list or string>
              domain_control: <value in [disable, enable]>
              domain_control_domains: <list or string>
              log: <value in [disable, enable]>
              name: <string>
              safe_search: <value in [disable, enable]>
              safe_search_control: <list or string>
              tenant_control: <value in [disable, enable]>
              tenant_control_tenants: <list or string>

Return Values

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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

• Xinwei Du (@dux-fortinet)
• Xing Li (@lix-fortinet)
• Jie Xue (@JieX19)
• Link Zheng (@chillancezen)
• Frank Shen (@fshen01)
• Hongbin Lu (@fgtdev-hblu)