fortinet.fortios.fortios_diameter_filter_profile (2.3.6) — module

Configure Diameter filter profiles in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify diameter_filter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Diameter filter profiles.
  fortinet.fortios.fortios_diameter_filter_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      diameter_filter_profile:
          cmd_flags_reserve_set: "allow"
          command_code_invalid: "allow"
          command_code_range: "<your_own_value>"
          comment: "Comment."
          log_packet: "disable"
          message_length_invalid: "allow"
          missing_request_action: "allow"
          monitor_all_messages: "disable"
          name: "default_name_11"
          protocol_version_invalid: "allow"
          request_error_flag_set: "allow"
          track_requests_answers: "disable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

diameter_filter_profile:
    default: null
    description:
    - Configure Diameter filter profiles.
    suboptions:
      cmd_flags_reserve_set:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for messages with cmd flag reserve bits set.
        type: str
      command_code_invalid:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for messages with invalid command code.
        type: str
      command_code_range:
        description:
        - Valid range for command codes (0-16777215).
        type: str
      comment:
        description:
        - Comment.
        type: str
      log_packet:
        choices:
        - disable
        - enable
        description:
        - Enable/disable packet log for triggered diameter settings.
        type: str
      message_length_invalid:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for invalid message length.
        type: str
      missing_request_action:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for answers without corresponding request.
        type: str
      monitor_all_messages:
        choices:
        - disable
        - enable
        description:
        - Enable/disable logging for all User Name and Result Code AVP messages.
        type: str
      name:
        description:
        - Profile name.
        required: true
        type: str
      protocol_version_invalid:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for invalid protocol version.
        type: str
      request_error_flag_set:
        choices:
        - allow
        - block
        - reset
        - monitor
        description:
        - Action to be taken for request messages with error flag set.
        type: str
      track_requests_answers:
        choices:
        - disable
        - enable
        description:
        - Enable/disable validation that each answer has a corresponding request.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str