fortinet.fortimanager.fmgr_firewall_gtp_policy (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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Policy.
      fortinet.fortimanager.fmgr_firewall_gtp_policy:
        bypass_validation: false
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        gtp: "ansible-test" # name
        state: present
        firewall_gtp_policy:
          action: allow # <value in [allow, deny]>
          apn-sel-mode:
            - ms
            - net
            - vrf
          id: 1
          max-apn-restriction: public-1 # <value in [all, public-1, public-2, ...]>
          messages:
            - create-req
            - create-res
            - update-req
            - update-res
          rat-type:
            - any
            - utran
            - geran
            - wlan
            - gan
            - hspa
            - eutran
            - virtual
            - nbiot

Scanned by Steampunk Spotter

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

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the policies in the GTP
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_gtp_policy"
          params:
            adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
            gtp: "ansible-test" # name
            policy: "your_value"

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

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

firewall_gtp_policy:
    description: The top level parameters set.
    required: false
    suboptions:
      action:
        choices:
        - allow
        - deny
        description: Action.
        type: str
      apn:
        description: APN subfix.
        type: str
      apn-sel-mode:
        choices:
        - ms
        - net
        - vrf
        description: Deprecated, please rename it to apn_sel_mode.
        elements: str
        type: list
      apnmember:
        description: (list or str) APN member.
        type: raw
      id:
        description: ID.
        required: true
        type: int
      imei:
        description: IMEI
        type: str
      imsi:
        description: IMSI prefix.
        type: str
      imsi-prefix:
        description: Deprecated, please rename it to imsi_prefix. IMSI prefix.
        type: str
      max-apn-restriction:
        choices:
        - all
        - public-1
        - public-2
        - private-1
        - private-2
        description: Deprecated, please rename it to max_apn_restriction. Maximum APN
          restriction value.
        type: str
      messages:
        choices:
        - create-req
        - create-res
        - update-req
        - update-res
        description: No description.
        elements: str
        type: list
      msisdn:
        description: MSISDN prefix.
        type: str
      msisdn-prefix:
        description: Deprecated, please rename it to msisdn_prefix. MSISDN prefix.
        type: str
      rai:
        description: RAI pattern.
        type: str
      rat-type:
        choices:
        - any
        - utran
        - geran
        - wlan
        - gan
        - hspa
        - eutran
        - virtual
        - nbiot
        description: Deprecated, please rename it to rat_type.
        elements: str
        type: list
      uli:
        description: ULI pattern.
        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.
    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

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