fortinet.fortimanager.fmgr_firewall_gtp_ievalidation – IE validation.

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

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_ievalidation
dictionary
the top level parameters set
apn-restriction
string
    Choices:
  • disable
  • enable
Validate APN restriction.
charging-gateway-addr
string
    Choices:
  • disable
  • enable
Validate charging gateway address.
charging-ID
string
    Choices:
  • disable
  • enable
Validate charging ID.
end-user-addr
string
    Choices:
  • disable
  • enable
Validate end user address.
gsn-addr
string
    Choices:
  • disable
  • enable
Validate GSN address.
imei
string
    Choices:
  • disable
  • enable
Validate IMEI(SV).
imsi
string
    Choices:
  • disable
  • enable
Validate IMSI.
mm-context
string
    Choices:
  • disable
  • enable
Validate MM context.
ms-tzone
string
    Choices:
  • disable
  • enable
Validate MS time zone.
ms-validated
string
    Choices:
  • disable
  • enable
Validate MS validated.
msisdn
string
    Choices:
  • disable
  • enable
Validate MSISDN.
nsapi
string
    Choices:
  • disable
  • enable
Validate NSAPI.
pdp-context
string
    Choices:
  • disable
  • enable
Validate PDP context.
qos-profile
string
    Choices:
  • disable
  • enable
Validate Quality of Service(QoS) profile.
rai
string
    Choices:
  • disable
  • enable
Validate RAI.
rat-type
string
    Choices:
  • disable
  • enable
Validate RAT type.
reordering-required
string
    Choices:
  • disable
  • enable
Validate re-ordering required.
selection-mode
string
    Choices:
  • disable
  • enable
Validate selection mode.
uli
string
    Choices:
  • disable
  • enable
Validate user location information.
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: IE validation.
     fmgr_firewall_gtp_ievalidation:
        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>
        firewall_gtp_ievalidation:
           apn-restriction: <value in [disable, enable]>
           charging-ID: <value in [disable, enable]>
           charging-gateway-addr: <value in [disable, enable]>
           end-user-addr: <value in [disable, enable]>
           gsn-addr: <value in [disable, enable]>
           imei: <value in [disable, enable]>
           imsi: <value in [disable, enable]>
           mm-context: <value in [disable, enable]>
           ms-tzone: <value in [disable, enable]>
           ms-validated: <value in [disable, enable]>
           msisdn: <value in [disable, enable]>
           nsapi: <value in [disable, enable]>
           pdp-context: <value in [disable, enable]>
           qos-profile: <value in [disable, enable]>
           rai: <value in [disable, enable]>
           rat-type: <value in [disable, enable]>
           reordering-required: <value in [disable, enable]>
           selection-mode: <value in [disable, enable]>
           uli: <value in [disable, enable]>

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)