drmofu.fortimanager.fmgr_webfilter_profile_override (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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.

 - 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: Web Filter override settings.
      fmgr_webfilter_profile_override:
         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>
         profile: <your own value>
         webfilter_profile_override:
            ovrd-cookie: <value in [deny, allow]>
            ovrd-dur: <value of string>
            ovrd-dur-mode: <value in [constant, ask]>
            ovrd-scope: <value in [user, user-group, ip, ...]>
            ovrd-user-group: <value of string>
            profile: <value of string>
            profile-attribute: <value in [User-Name, User-Password, CHAP-Password, ...]>
            profile-type: <value in [list, radius]>

Inputs

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

profile:
    description: the parameter (profile) in requested url
    required: true
    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:
    - update
    - set
    - 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 FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

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

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

webfilter_profile_override:
    description: the top level parameters set
    required: false
    suboptions:
      ovrd-cookie:
        choices:
        - deny
        - allow
        description: Allow/deny browser-based
        type: str
      ovrd-dur:
        description: Override duration.
        type: str
      ovrd-dur-mode:
        choices:
        - constant
        - ask
        description: Override duration mode.
        type: str
      ovrd-scope:
        choices:
        - user
        - user-group
        - ip
        - ask
        - browser
        description: Override scope.
        type: str
      ovrd-user-group:
        description: User groups with permission to use the override.
        type: str
      profile:
        description: Web filter profile with permission to create overrides.
        type: str
      profile-attribute:
        choices:
        - User-Name
        - User-Password
        - CHAP-Password
        - NAS-IP-Address
        - NAS-Port
        - Service-Type
        - Framed-Protocol
        - Framed-IP-Address
        - Framed-IP-Netmask
        - Framed-Routing
        - Filter-Id
        - Framed-MTU
        - Framed-Compression
        - Login-IP-Host
        - Login-Service
        - Login-TCP-Port
        - Reply-Message
        - Callback-Number
        - Callback-Id
        - Framed-Route
        - Framed-IPX-Network
        - State
        - Class
        - Vendor-Specific
        - Session-Timeout
        - Idle-Timeout
        - Termination-Action
        - Called-Station-Id
        - Calling-Station-Id
        - NAS-Identifier
        - Proxy-State
        - Login-LAT-Service
        - Login-LAT-Node
        - Login-LAT-Group
        - Framed-AppleTalk-Link
        - Framed-AppleTalk-Network
        - Framed-AppleTalk-Zone
        - Acct-Status-Type
        - Acct-Delay-Time
        - Acct-Input-Octets
        - Acct-Output-Octets
        - Acct-Session-Id
        - Acct-Authentic
        - Acct-Session-Time
        - Acct-Input-Packets
        - Acct-Output-Packets
        - Acct-Terminate-Cause
        - Acct-Multi-Session-Id
        - Acct-Link-Count
        - CHAP-Challenge
        - NAS-Port-Type
        - Port-Limit
        - Login-LAT-Port
        description: Profile attribute to retrieve from the RADIUS server.
        type: str
      profile-type:
        choices:
        - list
        - radius
        description: Override profile type.
        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 FortiManager version.
  returned: complex
  type: list