fortinet.fortimanager.fmgr_firewall_gtp_messagefilter (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Message filter.
      fortinet.fortimanager.fmgr_firewall_gtp_messagefilter:
        # 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_messagefilter:
          create_aa_pdp: <value in [allow, deny]>
          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]>
          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_notification: <value in [allow, deny]>
          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_action: <value in [allow, deny]>
          update_mbms: <value in [allow, deny]>
          update_pdp: <value in [allow, deny]>
          version_not_support: <value in [allow, deny]>

Inputs

    
gtp:
    description: The parameter (gtp) in requested url.
    required: true
    type: str

adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

firewall_gtp_messagefilter:
    description: The top level parameters set.
    required: false
    suboptions:
      create-aa-pdp:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to create_aa_pdp. Create AA PDP.
        type: str
      create-mbms:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to create_mbms. Create MBMS.
        type: str
      create-pdp:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to create_pdp. Create PDP.
        type: str
      data-record:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to data_record. Data record.
        type: str
      delete-aa-pdp:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to delete_aa_pdp. Delete AA PDP.
        type: str
      delete-mbms:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to delete_mbms. Delete MBMS.
        type: str
      delete-pdp:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to delete_pdp. Delete PDP.
        type: str
      echo:
        choices:
        - allow
        - deny
        description: Echo.
        type: str
      error-indication:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to error_indication. Error indication.
        type: str
      failure-report:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to failure_report. Failure report.
        type: str
      fwd-relocation:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to fwd_relocation. Forward relocation.
        type: str
      fwd-srns-context:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to fwd_srns_context. Forward SRNS context.
        type: str
      gtp-pdu:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to gtp_pdu. GTP PDU.
        type: str
      identification:
        choices:
        - allow
        - deny
        description: Identification.
        type: str
      mbms-notification:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to mbms_notification. MBMS notification.
        type: str
      node-alive:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to node_alive. Node alive.
        type: str
      note-ms-present:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to note_ms_present. Note MS present.
        type: str
      pdu-notification:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to pdu_notification. PDU notification.
        type: str
      ran-info:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to ran_info. Ran info.
        type: str
      redirection:
        choices:
        - allow
        - deny
        description: Redirection.
        type: str
      relocation-cancel:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to relocation_cancel. Relocation cancel.
        type: str
      send-route:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to send_route. Send route.
        type: str
      sgsn-context:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to sgsn_context. SGSN context.
        type: str
      support-extension:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to support_extension. Support extension.
        type: str
      unknown-message-action:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to unknown_message_action. Unknown message
          action.
        type: str
      update-mbms:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to update_mbms. Update MBMS.
        type: str
      update-pdp:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to update_pdp. Update PDP.
        type: str
      version-not-support:
        choices:
        - allow
        - deny
        description: Deprecated, please rename it to version_not_support. Version not
          supported.
        type: str
    type: dict

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