fortinet.fortimanager.fmgr_firewall_gtp_policy – Policy.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_gtp_policy.

New in version 2.10: of fortinet.fortimanager

Synopsis

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

Parameters

Parameter		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
firewall_gtp_policy dictionary			the top level parameters set
	action string	Choices: allow deny	Action.
	apn-sel-mode list / elements=string	Choices: ms net vrf	no description
	apnmember string		APN member.
	id integer		ID.
	imei string		IMEI(SV) pattern.
	imsi string		IMSI prefix.
	max-apn-restriction string	Choices: all public-1 public-2 private-1 private-2	Maximum APN restriction value.
	messages list / elements=string	Choices: create-req create-res update-req update-res	no description
	msisdn string		MSISDN prefix.
	rai string		RAI pattern.
	rat-type list / elements=string	Choices: any utran geran wlan gan hspa eutran virtual nbiot	no description
	uli string		ULI pattern.
gtp string / required			the parameter (gtp) in requested url
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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

- 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: Policy.
     fmgr_firewall_gtp_policy:
        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>
        gtp: <your own value>
        state: <value in [present, absent]>
        firewall_gtp_policy:
           action: <value in [allow, deny]>
           apn-sel-mode:
             - ms
             - net
             - vrf
           apnmember: <value of string>
           id: <value of integer>
           imei: <value of string>
           imsi: <value of string>
           max-apn-restriction: <value in [all, public-1, public-2, ...]>
           messages:
             - create-req
             - create-res
             - update-req
             - update-res
           msisdn: <value of string>
           rai: <value of string>
           rat-type:
             - any
             - utran
             - geran
             - wlan
             - gan
             - hspa
             - eutran
             - virtual
             - nbiot
           uli: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)