drmofu.fortimanager.fmgr_pkg_firewall_explicitproxypolicy (2.2.2) — module

Configure Explicit proxy policies.

| "added in version" 2.2.0 of drmofu.fortimanager"

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

preview | supported by community

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

  • 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: Configure Explicit proxy policies.
      fmgr_pkg_firewall_explicitproxypolicy:
         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>
         pkg: <your own value>
         state: <value in [present, absent]>
         pkg_firewall_explicitproxypolicy:
            action: <value in [deny, accept]>
            active-auth-method: <value in [ntlm, basic, digest, ...]>
            application-list: <value of string>
            av-profile: <value of string>
            casi-profile: <value of string>
            comments: <value of string>
            disclaimer: <value in [disable, domain, policy, ...]>
            dlp-sensor: <value of string>
            dstaddr: <value of string>
            dstaddr-negate: <value in [disable, enable]>
            dstaddr6: <value of string>
            dstintf: <value of string>
            global-label: <value of string>
            icap-profile: <value of string>
            identity-based: <value in [disable, enable]>
            identity-based-policy:
              -
                  application-list: <value of string>
                  av-profile: <value of string>
                  casi-profile: <value of string>
                  disclaimer: <value in [disable, domain, policy, ...]>
                  dlp-sensor: <value of string>
                  groups: <value of string>
                  icap-profile: <value of string>
                  id: <value of integer>
                  ips-sensor: <value of string>
                  logtraffic: <value in [disable, all, utm]>
                  logtraffic-start: <value in [disable, enable]>
                  mms-profile: <value of string>
                  profile-group: <value of string>
                  profile-protocol-options: <value of string>
                  profile-type: <value in [single, group]>
                  replacemsg-override-group: <value of string>
                  scan-botnet-connections: <value in [disable, block, monitor]>
                  schedule: <value of string>
                  spamfilter-profile: <value of string>
                  ssl-ssh-profile: <value of string>
                  users: <value of string>
                  utm-status: <value in [disable, enable]>
                  waf-profile: <value of string>
                  webfilter-profile: <value of string>
            ip-based: <value in [disable, enable]>
            ips-sensor: <value of string>
            label: <value of string>
            logtraffic: <value in [disable, all, utm]>
            logtraffic-start: <value in [disable, enable]>
            mms-profile: <value of string>
            policyid: <value of integer>
            profile-group: <value of string>
            profile-protocol-options: <value of string>
            profile-type: <value in [single, group]>
            proxy: <value in [web, ftp, wanopt]>
            replacemsg-override-group: <value of string>
            require-tfa: <value in [disable, enable]>
            scan-botnet-connections: <value in [disable, block, monitor]>
            schedule: <value of string>
            service: <value of string>
            service-negate: <value in [disable, enable]>
            spamfilter-profile: <value of string>
            srcaddr: <value of string>
            srcaddr-negate: <value in [disable, enable]>
            srcaddr6: <value of string>
            ssl-ssh-profile: <value of string>
            sso-auth-method: <value in [fsso, rsso, none]>
            status: <value in [disable, enable]>
            tags: <value of string>
            transaction-based: <value in [disable, enable]>
            transparent: <value in [disable, enable]>
            utm-status: <value in [disable, enable]>
            uuid: <value of string>
            waf-profile: <value of string>
            web-auth-cookie: <value in [disable, enable]>
            webcache: <value in [disable, enable]>
            webcache-https: <value in [disable, any, enable]>
            webfilter-profile: <value of string>
            webproxy-forward-server: <value of string>
            webproxy-profile: <value of string>

Inputs

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

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

pkg_firewall_explicitproxypolicy:
    description: the top level parameters set
    required: false
    suboptions:
      action:
        choices:
        - deny
        - accept
        description: Policy action.
        type: str
      active-auth-method:
        choices:
        - ntlm
        - basic
        - digest
        - form
        - none
        - negotiate
        description: Active authentication method.
        type: str
      application-list:
        description: Application list.
        type: str
      av-profile:
        description: Antivirus profile.
        type: str
      casi-profile:
        description: CASI profile.
        type: str
      comments:
        description: Comment.
        type: str
      disclaimer:
        choices:
        - disable
        - domain
        - policy
        - user
        description: Web proxy disclaimer setting.
        type: str
      dlp-sensor:
        description: DLP sensor.
        type: str
      dstaddr:
        description: Destination address name.
        type: str
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: Enable/disable negated destination address match.
        type: str
      dstaddr6:
        description: IPv6 destination address
        type: str
      dstintf:
        description: Destination interface name.
        type: str
      global-label:
        description: Label for global view.
        type: str
      icap-profile:
        description: ICAP profile.
        type: str
      identity-based:
        choices:
        - disable
        - enable
        description: Enable/disable identity-based policy.
        type: str
      identity-based-policy:
        description: description
        elements: dict
        suboptions:
          application-list:
            description: Application list.
            type: str
          av-profile:
            description: Antivirus profile.
            type: str
          casi-profile:
            description: CASI profile.
            type: str
          disclaimer:
            choices:
            - disable
            - domain
            - policy
            - user
            description: Web proxy disclaimer setting.
            type: str
          dlp-sensor:
            description: DLP sensor.
            type: str
          groups:
            description: Group name.
            type: str
          icap-profile:
            description: ICAP profile.
            type: str
          id:
            description: ID.
            type: int
          ips-sensor:
            description: IPS sensor.
            type: str
          logtraffic:
            choices:
            - disable
            - all
            - utm
            description: Enable/disable policy log traffic.
            type: str
          logtraffic-start:
            choices:
            - disable
            - enable
            description: Enable/disable policy log traffic start.
            type: str
          mms-profile:
            description: mms profile
            type: str
          profile-group:
            description: profile group
            type: str
          profile-protocol-options:
            description: Profile protocol options.
            type: str
          profile-type:
            choices:
            - single
            - group
            description: profile type
            type: str
          replacemsg-override-group:
            description: Specify authentication replacement message override group.
            type: str
          scan-botnet-connections:
            choices:
            - disable
            - block
            - monitor
            description: Enable/disable scanning of connections to Botnet servers.
            type: str
          schedule:
            description: Schedule name.
            type: str
          spamfilter-profile:
            description: Spam filter profile.
            type: str
          ssl-ssh-profile:
            description: SSL SSH Profile.
            type: str
          users:
            description: User name.
            type: str
          utm-status:
            choices:
            - disable
            - enable
            description: Enable AV/web/IPS protection profile.
            type: str
          waf-profile:
            description: Web application firewall profile.
            type: str
          webfilter-profile:
            description: Web filter profile.
            type: str
        type: list
      ip-based:
        choices:
        - disable
        - enable
        description: Enable/disable IP-based authentication.
        type: str
      ips-sensor:
        description: IPS sensor.
        type: str
      label:
        description: Label for section view.
        type: str
      logtraffic:
        choices:
        - disable
        - all
        - utm
        description: Enable/disable policy log traffic.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Enable/disable policy log traffic start.
        type: str
      mms-profile:
        description: mms profile
        type: str
      policyid:
        description: Policy ID.
        type: int
      profile-group:
        description: profile group
        type: str
      profile-protocol-options:
        description: Profile protocol options.
        type: str
      profile-type:
        choices:
        - single
        - group
        description: profile type
        type: str
      proxy:
        choices:
        - web
        - ftp
        - wanopt
        description: Explicit proxy type.
        type: str
      replacemsg-override-group:
        description: Specify authentication replacement message override group.
        type: str
      require-tfa:
        choices:
        - disable
        - enable
        description: Enable/disable requirement of 2-factor authentication.
        type: str
      scan-botnet-connections:
        choices:
        - disable
        - block
        - monitor
        description: Enable/disable scanning of connections to Botnet servers.
        type: str
      schedule:
        description: Schedule name.
        type: str
      service:
        description: Service name.
        type: str
      service-negate:
        choices:
        - disable
        - enable
        description: Enable/disable negated service match.
        type: str
      spamfilter-profile:
        description: Spam filter profile.
        type: str
      srcaddr:
        description: Source address name.
        type: str
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: Enable/disable negated source address match.
        type: str
      srcaddr6:
        description: IPv6 source address
        type: str
      ssl-ssh-profile:
        description: SSL SSH Profile.
        type: str
      sso-auth-method:
        choices:
        - fsso
        - rsso
        - none
        description: SSO authentication method.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable policy status.
        type: str
      tags:
        description: Applied object tags.
        type: str
      transaction-based:
        choices:
        - disable
        - enable
        description: Enable/disable transaction based authentication.
        type: str
      transparent:
        choices:
        - disable
        - enable
        description: Use IP address of client to connect to server.
        type: str
      utm-status:
        choices:
        - disable
        - enable
        description: Enable AV/web/IPS protection profile.
        type: str
      uuid:
        description: Universally Unique IDentifier.
        type: str
      waf-profile:
        description: Web application firewall profile.
        type: str
      web-auth-cookie:
        choices:
        - disable
        - enable
        description: Enable/disable Web authentication cookie.
        type: str
      webcache:
        choices:
        - disable
        - enable
        description: Enable/disable web cache.
        type: str
      webcache-https:
        choices:
        - disable
        - any
        - enable
        description: Enable/disable web cache for HTTPS.
        type: str
      webfilter-profile:
        description: Web filter profile.
        type: str
      webproxy-forward-server:
        description: Web proxy forward server.
        type: str
      webproxy-profile:
        description: Web proxy profile.
        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