drmofu.fortimanager.fmgr_pkg_firewall_proxypolicy (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: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure proxy policies.
      fmgr_pkg_firewall_proxypolicy:
         bypass_validation: False
         adom: ansible
         pkg: ansible # package name
         state: present
         pkg_firewall_proxypolicy:
            action: accept #<value in [accept, deny, redirect]>
            comments: ansible-comment
            dstaddr: all
            dstintf: any
            policyid: 1
            schedule: always
            service: ALL
            srcaddr: all
            srcintf: any
            status: disable

Scanned by Steampunk Spotter

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

 - name: gathering fortimanager facts
   hosts: fortimanager00
   gather_facts: no
   connection: httpapi
   collections:
     - fortinet.fortimanager
   vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
   tasks:
    - name: retrieve all the proxy policies
      fmgr_fact:
        facts:
            selector: 'pkg_firewall_proxypolicy'
            params:
                adom: 'ansible'
                proxy-policy: 'your_value'
                pkg: 'ansible' # package name

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

pkg_firewall_proxypolicy:
    description: the top level parameters set
    required: false
    suboptions:
      access-proxy:
        description: Access Proxy.
        type: str
      access-proxy6:
        description: description
        type: str
      action:
        choices:
        - accept
        - deny
        - redirect
        description: Accept or deny traffic matching the policy parameters.
        type: str
      application-list:
        description: Name of an existing Application list.
        type: str
      av-profile:
        description: Name of an existing Antivirus profile.
        type: str
      block-notification:
        choices:
        - disable
        - enable
        description: Enable/disable block notification.
        type: str
      cifs-profile:
        description: Name of an existing CIFS profile.
        type: str
      comments:
        description: Optional comments.
        type: str
      decrypted-traffic-mirror:
        description: Decrypted traffic mirror.
        type: str
      device-ownership:
        choices:
        - disable
        - enable
        description: When enabled, the ownership enforcement will be done at policy level.
        type: str
      disclaimer:
        choices:
        - disable
        - domain
        - policy
        - user
        description: Web proxy disclaimer setting
        type: str
      dlp-profile:
        description: Name of an existing DLP profile.
        type: str
      dlp-sensor:
        description: Name of an existing DLP sensor.
        type: str
      dstaddr:
        description: Destination address objects.
        type: str
      dstaddr-negate:
        choices:
        - disable
        - enable
        description: When enabled, destination addresses match against any address EXCEPT
          the specified destination addresses.
        type: str
      dstaddr6:
        description: IPv6 destination address objects.
        type: str
      dstintf:
        description: Destination interface names.
        type: str
      emailfilter-profile:
        description: Name of an existing email filter profile.
        type: str
      file-filter-profile:
        description: Name of an existing file-filter profile.
        type: str
      global-label:
        description: Global web-based manager visible label.
        type: str
      groups:
        description: Names of group objects.
        type: str
      http-tunnel-auth:
        choices:
        - disable
        - enable
        description: Enable/disable HTTP tunnel authentication.
        type: str
      icap-profile:
        description: Name of an existing ICAP profile.
        type: str
      internet-service:
        choices:
        - disable
        - enable
        description: Enable/disable use of Internet Services for this policy.
        type: str
      internet-service-custom:
        description: Custom Internet Service name.
        type: str
      internet-service-custom-group:
        description: Custom Internet Service group name.
        type: str
      internet-service-group:
        description: Internet Service group name.
        type: str
      internet-service-id:
        description: Internet Service ID.
        type: str
      internet-service-name:
        description: Internet Service name.
        type: str
      internet-service-negate:
        choices:
        - disable
        - enable
        description: When enabled, Internet Services match against any internet service
          EXCEPT the selected Internet Service.
        type: str
      ips-sensor:
        description: Name of an existing IPS sensor.
        type: str
      label:
        description: VDOM-specific GUI visible label.
        type: str
      logtraffic:
        choices:
        - disable
        - all
        - utm
        description: Enable/disable logging traffic through the policy.
        type: str
      logtraffic-start:
        choices:
        - disable
        - enable
        description: Enable/disable policy log traffic start.
        type: str
      mms-profile:
        description: Name of an existing MMS profile.
        type: str
      name:
        description: Policy name.
        type: str
      policyid:
        description: Policy ID.
        type: int
      poolname:
        description: Name of IP pool object.
        type: str
      profile-group:
        description: Name of profile group.
        type: str
      profile-protocol-options:
        description: Name of an existing Protocol options profile.
        type: str
      profile-type:
        choices:
        - single
        - group
        description: Determine whether the firewall policy allows security profile groups
          or single profiles only.
        type: str
      proxy:
        choices:
        - explicit-web
        - transparent-web
        - ftp
        - wanopt
        - ssh
        - ssh-tunnel
        - access-proxy
        description: Type of explicit proxy.
        type: str
      redirect-url:
        description: Redirect URL for further explicit web proxy processing.
        type: str
      replacemsg-override-group:
        description: 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: Name of schedule object.
        type: str
      sctp-filter-profile:
        description: Name of an existing SCTP filter profile.
        type: str
      service:
        description: Name of service objects.
        type: str
      service-negate:
        choices:
        - disable
        - enable
        description: When enabled, services match against any service EXCEPT the specified
          destination services.
        type: str
      session-ttl:
        description: TTL in seconds for sessions accepted by this policy
        type: int
      spamfilter-profile:
        description: Name of an existing Spam filter profile.
        type: str
      srcaddr:
        description: Source address objects
        type: str
      srcaddr-negate:
        choices:
        - disable
        - enable
        description: When enabled, source addresses match against any address EXCEPT the
          specified source addresses.
        type: str
      srcaddr6:
        description: IPv6 source address objects.
        type: str
      srcintf:
        description: Source interface names.
        type: str
      ssh-filter-profile:
        description: Name of an existing SSH filter profile.
        type: str
      ssh-policy-redirect:
        choices:
        - disable
        - enable
        description: Redirect SSH traffic to matching transparent proxy policy.
        type: str
      ssl-ssh-profile:
        description: Name of an existing SSL SSH profile.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable the active status of the policy.
        type: str
      tags:
        description: Names of object-tags applied to address.
        type: str
      transparent:
        choices:
        - disable
        - enable
        description: Enable to use the IP address of the client to connect to the server.
        type: str
      users:
        description: Names of user objects.
        type: str
      utm-status:
        choices:
        - disable
        - enable
        description: Enable the use of UTM profiles/sensors/lists.
        type: str
      uuid:
        description: Universally Unique Identifier
        type: str
      videofilter-profile:
        description: Name of an existing VideoFilter profile.
        type: str
      voip-profile:
        description: Name of an existing VoIP profile.
        type: str
      waf-profile:
        description: Name of an existing Web application firewall profile.
        type: str
      webcache:
        choices:
        - disable
        - enable
        description: Enable/disable web caching.
        type: str
      webcache-https:
        choices:
        - disable
        - enable
        description: Enable/disable web caching for HTTPS
        type: str
      webfilter-profile:
        description: Name of an existing Web filter profile.
        type: str
      webproxy-forward-server:
        description: Name of web proxy forward server.
        type: str
      webproxy-profile:
        description: Name of web proxy profile.
        type: str
      ztna-ems-tag:
        description: ZTNA EMS Tag names.
        type: str
      ztna-tags-match-logic:
        choices:
        - or
        - and
        description: ZTNA tag matching logic.
        type: str
    type: dict

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

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