drmofu.fortimanager.fmgr_gtp_messagefilterv0v1 (2.2.2) — module

Message filter for GTPv0/v1 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 GTPv0/v1 messages.
      fmgr_gtp_messagefilterv0v1:
         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_messagefilterv0v1:
            create-mbms: <value in [allow, deny]>
            create-pdp: <value in [allow, deny]>
            data-record: <value in [allow, deny]>
            delete-aa-pdp: <value in [allow, deny]>
            delete-mbms: <value in [allow, deny]>
            delete-pdp: <value in [allow, deny]>
            echo: <value in [allow, deny]>
            end-marker: <value in [allow, deny]>
            error-indication: <value in [allow, deny]>
            failure-report: <value in [allow, deny]>
            fwd-relocation: <value in [allow, deny]>
            fwd-srns-context: <value in [allow, deny]>
            gtp-pdu: <value in [allow, deny]>
            identification: <value in [allow, deny]>
            mbms-de-registration: <value in [allow, deny]>
            mbms-notification: <value in [allow, deny]>
            mbms-registration: <value in [allow, deny]>
            mbms-session-start: <value in [allow, deny]>
            mbms-session-stop: <value in [allow, deny]>
            mbms-session-update: <value in [allow, deny]>
            ms-info-change-notif: <value in [allow, deny]>
            name: <value of string>
            node-alive: <value in [allow, deny]>
            note-ms-present: <value in [allow, deny]>
            pdu-notification: <value in [allow, deny]>
            ran-info: <value in [allow, deny]>
            redirection: <value in [allow, deny]>
            relocation-cancel: <value in [allow, deny]>
            send-route: <value in [allow, deny]>
            sgsn-context: <value in [allow, deny]>
            support-extension: <value in [allow, deny]>
            unknown-message: <value in [allow, deny]>
            unknown-message-white-list: <value of integer>
            update-mbms: <value in [allow, deny]>
            update-pdp: <value in [allow, deny]>
            v0-create-aa-pdp--v1-init-pdp-ctx: <value in [deny, allow]>
            version-not-support: <value in [allow, deny]>
            create-aa-pdp|init-pdp-ctx: <value in [allow, deny]>
            ue-registration-query: <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_messagefilterv0v1:
    description: the top level parameters set
    required: false
    suboptions:
      create-aa-pdp|init-pdp-ctx:
        choices:
        - allow
        - deny
        description: GTPv0 create AA PDP context
        type: str
      create-mbms:
        choices:
        - allow
        - deny
        description: GTPv1 create MBMS context
        type: str
      create-pdp:
        choices:
        - allow
        - deny
        description: Create PDP context
        type: str
      data-record:
        choices:
        - allow
        - deny
        description: Data record transfer
        type: str
      delete-aa-pdp:
        choices:
        - allow
        - deny
        description: GTPv0 delete AA PDP context
        type: str
      delete-mbms:
        choices:
        - allow
        - deny
        description: GTPv1 delete MBMS context
        type: str
      delete-pdp:
        choices:
        - allow
        - deny
        description: Delete PDP context
        type: str
      echo:
        choices:
        - allow
        - deny
        description: Echo
        type: str
      end-marker:
        choices:
        - allow
        - deny
        description: GTPv1 End marker
        type: str
      error-indication:
        choices:
        - allow
        - deny
        description: Error indication
        type: str
      failure-report:
        choices:
        - allow
        - deny
        description: Failure report
        type: str
      fwd-relocation:
        choices:
        - allow
        - deny
        description: GTPv1 forward relocation
        type: str
      fwd-srns-context:
        choices:
        - allow
        - deny
        description: GTPv1 forward SRNS
        type: str
      gtp-pdu:
        choices:
        - allow
        - deny
        description: PDU
        type: str
      identification:
        choices:
        - allow
        - deny
        description: Identification
        type: str
      mbms-de-registration:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS de-registration
        type: str
      mbms-notification:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS notification
        type: str
      mbms-registration:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS registration
        type: str
      mbms-session-start:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS session start
        type: str
      mbms-session-stop:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS session stop
        type: str
      mbms-session-update:
        choices:
        - allow
        - deny
        description: GTPv1 MBMS session update
        type: str
      ms-info-change-notif:
        choices:
        - allow
        - deny
        description: GTPv1 MS info change notification
        type: str
      name:
        description: Message filter name.
        type: str
      node-alive:
        choices:
        - allow
        - deny
        description: Node alive
        type: str
      note-ms-present:
        choices:
        - allow
        - deny
        description: Note MS GPRS present
        type: str
      pdu-notification:
        choices:
        - allow
        - deny
        description: PDU notification
        type: str
      ran-info:
        choices:
        - allow
        - deny
        description: GTPv1 RAN information relay
        type: str
      redirection:
        choices:
        - allow
        - deny
        description: Redirection
        type: str
      relocation-cancel:
        choices:
        - allow
        - deny
        description: GTPv1 relocation cancel
        type: str
      send-route:
        choices:
        - allow
        - deny
        description: Send routing information for GPRS
        type: str
      sgsn-context:
        choices:
        - allow
        - deny
        description: SGSN context
        type: str
      support-extension:
        choices:
        - allow
        - deny
        description: GTPv1 supported extension headers notify
        type: str
      ue-registration-query:
        choices:
        - allow
        - deny
        description: UE Registration Query
        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-mbms:
        choices:
        - allow
        - deny
        description: GTPv1 update MBMS context
        type: str
      update-pdp:
        choices:
        - allow
        - deny
        description: Update PDP context
        type: str
      v0-create-aa-pdp--v1-init-pdp-ctx:
        choices:
        - deny
        - allow
        description: GTPv0 create AA PDP context
        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