fmgr_firewall_gtp_policy – Policy.

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
firewall_gtp_policy yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • gtp - The parameter in requested url type: str required: true
  • firewall_gtp_policy - no description type: dict
    • action - Action. type: str choices: [allow, deny] more...
    • apn-sel-mode - No description for the parameter type: array choices: [ms, net, vrf] more...
    • apnmember - APN member. type: str more...
    • id - ID. type: int more...
    • imei - IMEI(SV) pattern. type: str more...
    • imsi - IMSI prefix. type: str more...
    • max-apn-restriction - Maximum APN restriction value. type: str choices: [all, public-1, public-2, private-1, private-2] more...
    • messages - No description for the parameter type: array choices: [create-req, create-res, update-req, update-res] more...
    • msisdn - MSISDN prefix. type: str more...
    • rai - RAI pattern. type: str more...
    • rat-type - No description for the parameter type: array choices: [any, utran, geran, wlan, gan, hspa, eutran, virtual, nbiot] more...
    • uli - ULI pattern. type: str more...
    • imsi-prefix - IMSI prefix. type: str more...
    • msisdn-prefix - MSISDN prefix. type: str more...

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: 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 policies in the GTP
     fmgr_fact:
       facts:
           selector: 'firewall_gtp_policy'
           params:
               adom: 'FortiCarrier' # This is FOC-only object, need a FortiCarrier adom
               gtp: 'ansible-test' # name
               policy: 'your_value'
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Policy.
     fmgr_firewall_gtp_policy:
        bypass_validation: False
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        gtp: 'ansible-test' # name
        state: present
        firewall_gtp_policy:
           action: allow #<value in [allow, deny]>
           apn-sel-mode:
             - ms
             - net
             - vrf
           id: 1
           max-apn-restriction: public-1 #<value in [all, public-1, public-2, ...]>
           messages:
             - create-req
             - create-res
             - update-req
             - update-res
           rat-type:
             - any
             - utran
             - geran
             - wlan
             - gan
             - hspa
             - eutran
             - virtual
             - nbiot

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.