drmofu.fortimanager.fmgr_gtp_messagefilterv2 (2.2.2) — module

Message filter for GTPv2 messages.

| "added in version" 2.0.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: Message filter for GTPv2 messages.
      fmgr_gtp_messagefilterv2:
         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>
         state: <value in [present, absent]>
         gtp_messagefilterv2:
            bearer-resource-cmd-fail: <value in [allow, deny]>
            change-notification: <value in [allow, deny]>
            create-bearer: <value in [allow, deny]>
            create-session: <value in [allow, deny]>
            delete-bearer-cmd-fail: <value in [allow, deny]>
            delete-bearer-req-resp: <value in [allow, deny]>
            delete-pdn-connection-set: <value in [allow, deny]>
            delete-session: <value in [allow, deny]>
            echo: <value in [allow, deny]>
            modify-bearer-cmd-fail: <value in [allow, deny]>
            modify-bearer-req-resp: <value in [allow, deny]>
            name: <value of string>
            resume: <value in [allow, deny]>
            suspend: <value in [allow, deny]>
            trace-session: <value in [allow, deny]>
            unknown-message: <value in [allow, deny]>
            unknown-message-white-list: <value of integer>
            update-bearer: <value in [allow, deny]>
            update-pdn-connection-set: <value in [allow, deny]>
            version-not-support: <value in [allow, deny]>
            context-req-res-ack: <value in [allow, deny]>
            forward-relocation-cmp-notif-ack: <value in [allow, deny]>
            forward-relocation-req-res: <value in [allow, deny]>
            alert-mme-notif-ack: <value in [allow, deny]>
            configuration-transfer-tunnel: <value in [allow, deny]>
            create-forwarding-tunnel-req-resp: <value in [allow, deny]>
            create-indirect-forwarding-tunnel-req-resp: <value in [allow, deny]>
            cs-paging: <value in [allow, deny]>
            delete-indirect-forwarding-tunnel-req-resp: <value in [allow, deny]>
            detach-notif-ack: <value in [allow, deny]>
            dlink-data-notif-ack: <value in [allow, deny]>
            dlink-notif-failure: <value in [allow, deny]>
            forward-access-notif-ack: <value in [allow, deny]>
            identification-req-resp: <value in [allow, deny]>
            isr-status: <value in [allow, deny]>
            mbms-session-start-req-resp: <value in [allow, deny]>
            mbms-session-stop-req-resp: <value in [allow, deny]>
            mbms-session-update-req-resp: <value in [allow, deny]>
            modify-access-req-resp: <value in [allow, deny]>
            pgw-dlink-notif-ack: <value in [allow, deny]>
            pgw-restart-notif-ack: <value in [allow, deny]>
            ran-info-relay: <value in [allow, deny]>
            release-access-bearer-req-resp: <value in [allow, deny]>
            relocation-cancel-req-resp: <value in [allow, deny]>
            remote-ue-report-notif-ack: <value in [allow, deny]>
            reserved-for-earlier-version: <value in [allow, deny]>
            stop-paging-indication: <value in [allow, deny]>
            ue-activity-notif-ack: <value in [allow, deny]>
            ue-registration-query-req-resp: <value in [allow, deny]>

Inputs

    
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

gtp_messagefilterv2:
    description: the top level parameters set
    required: false
    suboptions:
      alert-mme-notif-ack:
        choices:
        - allow
        - deny
        description: Alert MME notification/acknowledge
        type: str
      bearer-resource-cmd-fail:
        choices:
        - allow
        - deny
        description: Bearer resource
        type: str
      change-notification:
        choices:
        - allow
        - deny
        description: Change notification
        type: str
      configuration-transfer-tunnel:
        choices:
        - allow
        - deny
        description: Configuration transfer tunnel
        type: str
      context-req-res-ack:
        choices:
        - allow
        - deny
        description: Context request/response/acknowledge
        type: str
      create-bearer:
        choices:
        - allow
        - deny
        description: Create bearer
        type: str
      create-forwarding-tunnel-req-resp:
        choices:
        - allow
        - deny
        description: Create forwarding tunnel request/response
        type: str
      create-indirect-forwarding-tunnel-req-resp:
        choices:
        - allow
        - deny
        description: Create indirect data forwarding tunnel request/response
        type: str
      create-session:
        choices:
        - allow
        - deny
        description: Create session
        type: str
      cs-paging:
        choices:
        - allow
        - deny
        description: CS paging indication
        type: str
      delete-bearer-cmd-fail:
        choices:
        - allow
        - deny
        description: Delete bearer
        type: str
      delete-bearer-req-resp:
        choices:
        - allow
        - deny
        description: Delete bearer
        type: str
      delete-indirect-forwarding-tunnel-req-resp:
        choices:
        - allow
        - deny
        description: Delete indirect data forwarding tunnel request/response
        type: str
      delete-pdn-connection-set:
        choices:
        - allow
        - deny
        description: Delete PDN connection set
        type: str
      delete-session:
        choices:
        - allow
        - deny
        description: Delete session
        type: str
      detach-notif-ack:
        choices:
        - allow
        - deny
        description: Detach notification/acknowledge
        type: str
      dlink-data-notif-ack:
        choices:
        - allow
        - deny
        description: Downlink data notification/acknowledge
        type: str
      dlink-notif-failure:
        choices:
        - allow
        - deny
        description: Downlink data notification failure indication
        type: str
      echo:
        choices:
        - allow
        - deny
        description: Echo
        type: str
      forward-access-notif-ack:
        choices:
        - allow
        - deny
        description: Forward access context notification/acknowledge
        type: str
      forward-relocation-cmp-notif-ack:
        choices:
        - allow
        - deny
        description: Forward relocation complete notification/acknowledge
        type: str
      forward-relocation-req-res:
        choices:
        - allow
        - deny
        description: Forward relocation request/response
        type: str
      identification-req-resp:
        choices:
        - allow
        - deny
        description: Identification request/response
        type: str
      isr-status:
        choices:
        - allow
        - deny
        description: ISR status indication
        type: str
      mbms-session-start-req-resp:
        choices:
        - allow
        - deny
        description: MBMS session start request/response
        type: str
      mbms-session-stop-req-resp:
        choices:
        - allow
        - deny
        description: MBMS session stop request/response
        type: str
      mbms-session-update-req-resp:
        choices:
        - allow
        - deny
        description: MBMS session update request/response
        type: str
      modify-access-req-resp:
        choices:
        - allow
        - deny
        description: Modify access bearers request/response
        type: str
      modify-bearer-cmd-fail:
        choices:
        - allow
        - deny
        description: Modify bearer
        type: str
      modify-bearer-req-resp:
        choices:
        - allow
        - deny
        description: Modify bearer
        type: str
      name:
        description: Message filter name.
        type: str
      pgw-dlink-notif-ack:
        choices:
        - allow
        - deny
        description: PGW downlink triggering notification/acknowledge
        type: str
      pgw-restart-notif-ack:
        choices:
        - allow
        - deny
        description: PGW restart notification/acknowledge
        type: str
      ran-info-relay:
        choices:
        - allow
        - deny
        description: RAN information relay
        type: str
      release-access-bearer-req-resp:
        choices:
        - allow
        - deny
        description: Release access bearers request/response
        type: str
      relocation-cancel-req-resp:
        choices:
        - allow
        - deny
        description: Relocation cancel request/response
        type: str
      remote-ue-report-notif-ack:
        choices:
        - allow
        - deny
        description: Remote UE report notification/acknowledge
        type: str
      reserved-for-earlier-version:
        choices:
        - allow
        - deny
        description: Reserved for earlier version of the GTP specification
        type: str
      resume:
        choices:
        - allow
        - deny
        description: Resume
        type: str
      stop-paging-indication:
        choices:
        - allow
        - deny
        description: Stop Paging Indication
        type: str
      suspend:
        choices:
        - allow
        - deny
        description: Suspend
        type: str
      trace-session:
        choices:
        - allow
        - deny
        description: Trace session
        type: str
      ue-activity-notif-ack:
        choices:
        - allow
        - deny
        description: UE activity notification/acknowledge
        type: str
      ue-registration-query-req-resp:
        choices:
        - allow
        - deny
        description: UE registration query request/response
        type: str
      unknown-message:
        choices:
        - allow
        - deny
        description: Allow or Deny unknown messages.
        type: str
      unknown-message-white-list:
        description: White list
        type: int
      update-bearer:
        choices:
        - allow
        - deny
        description: Update bearer
        type: str
      update-pdn-connection-set:
        choices:
        - allow
        - deny
        description: Update PDN connection set
        type: str
      version-not-support:
        choices:
        - allow
        - deny
        description: Version not supported
        type: str
    type: dict

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

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