fortinet.fortios.fortios_switch_controller_dynamic_port_policy (2.3.6) — module

Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device 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 switch_controller feature and dynamic_port_policy 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 Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
  fortinet.fortios.fortios_switch_controller_dynamic_port_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_dynamic_port_policy:
          description: "<your_own_value>"
          fortilink: "<your_own_value> (source system.interface.name)"
          name: "default_name_5"
          policy:
              -
                  set_802_1x: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name)"
                  bounce_port_link: "disable"
                  category: "device"
                  description: "<your_own_value>"
                  family: "<your_own_value>"
                  host: "myhostname"
                  hw_vendor: "<your_own_value>"
                  interface_tags:
                      -
                          tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
                  lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
                  mac: "<your_own_value>"
                  name: "default_name_18"
                  qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
                  status: "enable"
                  type: "<your_own_value>"
                  vlan_policy: "<your_own_value> (source switch-controller.vlan-policy.name)"

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

switch_controller_dynamic_port_policy:
    default: null
    description:
    - Configure Dynamic port policy to be applied on the managed FortiSwitch ports through
      DPP device.
    suboptions:
      description:
        description:
        - Description for the Dynamic port policy.
        type: str
      fortilink:
        description:
        - FortiLink interface for which this Dynamic port policy belongs to. Source system.interface.name.
        type: str
      name:
        description:
        - Dynamic port policy name.
        required: true
        type: str
      policy:
        description:
        - Port policies with matching criteria and actions.
        elements: dict
        suboptions:
          bounce_port_link:
            choices:
            - disable
            - enable
            description:
            - Enable/disable bouncing (administratively bring the link down, up) of a
              switch port where this policy is applied. Helps to clear and reassign VLAN
              from lldp-profile.
            type: str
          category:
            choices:
            - device
            - interface-tag
            description:
            - Category of Dynamic port policy.
            type: str
          description:
            description:
            - Description for the policy.
            type: str
          family:
            description:
            - Match policy based on family.
            type: str
          host:
            description:
            - Match policy based on host.
            type: str
          hw_vendor:
            description:
            - Match policy based on hardware vendor.
            type: str
          interface_tags:
            description:
            - Match policy based on the FortiSwitch interface object tags.
            elements: dict
            suboptions:
              tag_name:
                description:
                - FortiSwitch port tag name. Source switch-controller.switch-interface-tag.name.
                required: true
                type: str
            type: list
          lldp_profile:
            description:
            - LLDP profile to be applied when using this policy. Source switch-controller.lldp-profile.name.
            type: str
          mac:
            description:
            - Match policy based on MAC address.
            type: str
          name:
            description:
            - Policy name.
            required: true
            type: str
          qos_policy:
            description:
            - QoS policy to be applied when using this policy. Source switch-controller.qos.qos-policy.name.
            type: str
          set_802_1x:
            description:
            - 802.1x security policy to be applied when using this policy. Source switch-controller.security-policy.802-1X.name
              switch-controller.security-policy.captive-portal.name.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable policy.
            type: str
          type:
            description:
            - Match policy based on type.
            type: str
          vlan_policy:
            description:
            - VLAN policy to be applied when using this policy. Source switch-controller.vlan-policy.name.
            type: str
        type: list
    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