fortinet.fortimanager.fmgr_firewall_casbprofile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

Usage examples

Scanned by Steampunk Spotter

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

- 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: No description
      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>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

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

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

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

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

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

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

firewall_casbprofile:
    description: The top level parameters set.
    required: false
    suboptions:
      name:
        description: No description.
        required: true
        type: str
      saas-application:
        description: Deprecated, please rename it to saas_application.
        elements: dict
        suboptions:
          access-rule:
            description: Deprecated, please rename it to access_rule.
            elements: dict
            suboptions:
              action:
                choices:
                - block
                - monitor
                - bypass
                description: No description.
                type: str
              bypass:
                choices:
                - av
                - dlp
                - web-filter
                - file-filter
                - video-filter
                description: No description.
                elements: str
                type: list
              name:
                description: No description.
                type: str
            type: list
          custom-control:
            description: Deprecated, please rename it to custom_control.
            elements: dict
            suboptions:
              name:
                description: No description.
                type: str
              option:
                description: No description.
                elements: dict
                suboptions:
                  name:
                    description: No description.
                    type: str
                  user-input:
                    description: Deprecated, please rename it to user_input.
                    elements: str
                    type: list
                type: list
            type: list
          domain-control:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to domain_control.
            type: str
          domain-control-domains:
            description: Deprecated, please rename it to domain_control_domains.
            elements: str
            type: list
          log:
            choices:
            - disable
            - enable
            description: No description.
            type: str
          name:
            description: No description.
            type: str
          safe-search:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to safe_search.
            type: str
          safe-search-control:
            description: Deprecated, please rename it to safe_search_control.
            elements: str
            type: list
          tenant-control:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to tenant_control.
            type: str
          tenant-control-tenants:
            description: Deprecated, please rename it to tenant_control_tenants.
            elements: str
            type: list
        type: list
    type: dict

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

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

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