Skip to content

Latest commit

 

History

History
287 lines (243 loc) · 13.1 KB

fortios_switch_controller_mac_policy.rst

File metadata and controls

287 lines (243 loc) · 13.1 KB
Raw
source:fortios_switch_controller_mac_policy.py
orphan:

fortios_switch_controller_mac_policy -- Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

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

Requirements

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

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_switch_controller_mac_policy v6.4.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • 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_controller_mac_policy - Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device. type: dict more...
    Supported Version Ranges
    switch_controller_mac_policy v6.4.0 -> latest
    • bounce_port_link - Enable/disable bouncing (administratively bring the link down, up) of a switch port where this mac-policy is applied. type: str choices: disable, enable more...
      Supported Version Ranges
      bounce_port_link v7.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • count - Enable/disable packet count on the NAC device. type: str choices: disable, enable more...
      Supported Version Ranges
      count v6.4.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • description - Description for the MAC policy. type: str more...
      Supported Version Ranges
      description v6.4.0 -> latest
    • drop - Enable/disable dropping of NAC device traffic. type: str choices: disable, enable more...
      Supported Version Ranges
      drop v6.4.1 -> v6.4.1
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • fortilink - FortiLink interface for which this MAC policy belongs to. Source system.interface.name. type: str more...
      Supported Version Ranges
      fortilink v6.4.0 -> latest
    • name - MAC policy name. type: str required: true more...
      Supported Version Ranges
      name v6.4.0 -> latest
    • traffic_policy - Traffic policy to be applied when using this MAC policy. Source switch-controller.traffic-policy.name. type: str more...
      Supported Version Ranges
      traffic_policy v6.4.0 -> latest
    • vlan - Ingress traffic VLAN assignment for the MAC address matching this MAC policy. Source system.interface.name. type: str more...
      Supported Version Ranges
      vlan v6.4.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure MAC policy to be applied on the managed FortiSwitch devices through NAC device.
  fortinet.fortios.fortios_switch_controller_mac_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_mac_policy:
          bounce_port_link: "disable"
          count: "disable"
          description: "<your_own_value>"
          drop: "disable"
          fortilink: "<your_own_value> (source system.interface.name)"
          name: "default_name_8"
          traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"
          vlan: "<your_own_value> (source system.interface.name)"

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 fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate 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
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

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)
  • Nicolas Thomas (@thomnico)

Hint

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