fortios_switch_controller_lldp_profile – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate.

New in version 2.8.

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 lldp_profile 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.9.0

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
  • state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
  • switch_controller_lldp_profile - Configure FortiSwitch LLDP profiles. type: dict
    • state - B(Deprecated) type: str required: False choices: present, absent
    • tlvs_802dot1 - Transmitted IEEE 802.1 TLVs. type: str choices: port-vlan-id
    • tlvs_802dot3 - Transmitted IEEE 802.3 TLVs. type: str choices: max-frame-size
    • auto_isl - Enable/disable auto inter-switch LAG. type: str choices: disable, enable
    • auto_isl_hello_timer - Auto inter-switch LAG hello timer duration (1 - 30 sec). type: int
    • auto_isl_port_group - Auto inter-switch LAG port group ID (0 - 9). type: int
    • auto_isl_receive_timeout - Auto inter-switch LAG timeout if no response is received (3 - 90 sec). type: int
    • custom_tlvs - Configuration method to edit custom TLV entries. type: list
      • information_string - Organizationally defined information string (0 - 507 hexadecimal bytes). type: str
      • name - TLV name (not sent). type: str required: True
      • oui - Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. type: str
      • subtype - Organizationally defined subtype (0 - 255). type: int
    • med_network_policy - Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories. type: list
      • dscp - Advertised Differentiated Services Code Point (DSCP) value, a packet header value indicating the level of service requested for traffic, such as high priority or best effort delivery. type: int
      • name - Policy type name. type: str required: True
      • priority - Advertised Layer 2 priority (0 - 7; from lowest to highest priority). type: int
      • status - Enable or disable this TLV. type: str choices: disable, enable
      • vlan - ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). type: int
    • med_tlvs - Transmitted LLDP-MED TLVs (type-length-value descriptions): inventory management TLV and/or network policy TLV. type: str choices: inventory-management, network-policy
    • name - Profile name. type: str required: True

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure FortiSwitch LLDP profiles.
    fortios_switch_controller_lldp_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_lldp_profile:
        tlvs_802dot1: "port-vlan-id"
        tlvs_802dot3: "max-frame-size"
        auto_isl: "disable"
        auto_isl_hello_timer: "6"
        auto_isl_port_group: "7"
        auto_isl_receive_timeout: "8"
        custom_tlvs:
         -
            information_string: "<your_own_value>"
            name: "default_name_11"
            oui: "<your_own_value>"
            subtype: "13"
        med_network_policy:
         -
            dscp: "15"
            name: "default_name_16"
            priority: "17"
            status: "disable"
            vlan: "19"
        med_tlvs: "inventory-management"
        name: "default_name_21"

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.