fortiswitch_switch_acl_prelookup – Prelookup Policy configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify switch_acl feature and prelookup category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_switch_acl_prelookup v7.0.0 -> latest

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • switch_acl_prelookup - Prelookup Policy configuration. type: dict
    • action - Actions for the policy. type: dict
      • cos_queue - COS queue number (0 - 7), or unset to disable. type: int
      • count - Count enable/disable action. type: str choices: enable, disable
      • drop - Drop enable/disable action. type: str choices: enable, disable
      • outer_vlan_tag - Outer vlan tag. type: int
      • remark_cos - Remark CoS value (0 - 7), or unset to disable. type: int
    • classifier - Match-conditions for the policy. type: dict
      • cos - 802.1Q CoS value to be matched. type: int
      • dscp - DSCP value to be matched. type: int
      • dst_ip_prefix - Destination-ip address to be matched. type: str
      • dst_mac - Destination mac address to be matched. type: str
      • ether_type - Ether type to be matched. type: int
      • service - Service name. type: str
      • src_ip_prefix - Source-ip address to be matched. type: str
      • src_mac - Source mac address to be matched. type: str
      • vlan_id - Vlan id to be matched. type: int
    • description - Description of the policy. type: str
    • group - Group ID of the policy. type: int
    • id - Prelookup policy ID. type: int required: true
    • interface - Interface to which policy is bound in the pre-lookup. type: str
    • interface_all - Select all interface. type: str choices: enable, disable
    • schedule - schedule list. type: list
      • schedule_name - Schedule name. type: str
    • status - Set policy status. type: str choices: active, inactive

Examples

- name: Prelookup Policy configuration.
  fortinet.fortiswitch.fortiswitch_switch_acl_prelookup:
      state: "present"
      switch_acl_prelookup:
          action:
              cos_queue: "4"
              count: "enable"
              drop: "enable"
              outer_vlan_tag: "7"
              remark_cos: "8"
          classifier:
              cos: "10"
              dscp: "11"
              dst_ip_prefix: "<your_own_value>"
              dst_mac: "<your_own_value>"
              ether_type: "14"
              service: "<your_own_value> (source switch.acl.service.custom.name)"
              src_ip_prefix: "<your_own_value>"
              src_mac: "<your_own_value>"
              vlan_id: "18"
          description: "<your_own_value>"
          group: "20"
          id: "21"
          interface: "<your_own_value> (source switch.physical-port.name)"
          interface_all: "enable"
          schedule:
              -
                  schedule_name: "<your_own_value> (source system.schedule.onetime.name system.schedule.recurring.name system.schedule.group.name)"
          status: "active"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.