drmofu.fortimanager.fmgr_firewall_gtp_ievalidation (2.2.2) — module

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

Scanned by Steampunk Spotter

• 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: 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]>

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

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

firewall_gtp_ievalidation:
    description: the top level parameters set
    required: false
    suboptions:
      apn-restriction:
        choices:
        - disable
        - enable
        description: Validate APN restriction.
        type: str
      charging-ID:
        choices:
        - disable
        - enable
        description: Validate charging ID.
        type: str
      charging-gateway-addr:
        choices:
        - disable
        - enable
        description: Validate charging gateway address.
        type: str
      end-user-addr:
        choices:
        - disable
        - enable
        description: Validate end user address.
        type: str
      gsn-addr:
        choices:
        - disable
        - enable
        description: Validate GSN address.
        type: str
      imei:
        choices:
        - disable
        - enable
        description: Validate IMEI
        type: str
      imsi:
        choices:
        - disable
        - enable
        description: Validate IMSI.
        type: str
      mm-context:
        choices:
        - disable
        - enable
        description: Validate MM context.
        type: str
      ms-tzone:
        choices:
        - disable
        - enable
        description: Validate MS time zone.
        type: str
      ms-validated:
        choices:
        - disable
        - enable
        description: Validate MS validated.
        type: str
      msisdn:
        choices:
        - disable
        - enable
        description: Validate MSISDN.
        type: str
      nsapi:
        choices:
        - disable
        - enable
        description: Validate NSAPI.
        type: str
      pdp-context:
        choices:
        - disable
        - enable
        description: Validate PDP context.
        type: str
      qos-profile:
        choices:
        - disable
        - enable
        description: Validate Quality of Service
        type: str
      rai:
        choices:
        - disable
        - enable
        description: Validate RAI.
        type: str
      rat-type:
        choices:
        - disable
        - enable
        description: Validate RAT type.
        type: str
      reordering-required:
        choices:
        - disable
        - enable
        description: Validate re-ordering required.
        type: str
      selection-mode:
        choices:
        - disable
        - enable
        description: Validate selection mode.
        type: str
      uli:
        choices:
        - disable
        - enable
        description: Validate user location information.
        type: str
    type: dict

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