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

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_lldp_profile.

New in version 2.10: of fortinet.fortios

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

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
switch_controller_lldp_profile
dictionary
Configure FortiSwitch LLDP profiles.
auto_isl
string
    Choices:
  • disable
  • enable
Enable/disable auto inter-switch LAG.
auto_isl_hello_timer
integer
Auto inter-switch LAG hello timer duration (1 - 30 sec).
auto_isl_port_group
integer
Auto inter-switch LAG port group ID (0 - 9).
auto_isl_receive_timeout
integer
Auto inter-switch LAG timeout if no response is received (3 - 90 sec).
auto_mclag_icl
string
    Choices:
  • disable
  • enable
Enable/disable MCLAG inter chassis link.
custom_tlvs
list / elements=string
Configuration method to edit custom TLV entries.
information_string
string
Organizationally defined information string (0 - 507 hexadecimal bytes).
name
string / required
TLV name (not sent).
oui
string
Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV.
subtype
integer
Organizationally defined subtype (0 - 255).
med_location_service
list / elements=string
Configuration method to edit Media Endpoint Discovery (MED) location service type-length-value (TLV) categories.
name
string / required
Location service type name.
status
string
    Choices:
  • disable
  • enable
Enable or disable this TLV.
sys_location_id
string
Location service ID. Source switch-controller.location.name.
med_network_policy
list / elements=string
Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories.
assign_vlan
string
    Choices:
  • disable
  • enable
Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port.
dscp
integer
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.
name
string / required
Policy type name.
priority
integer
Advertised Layer 2 priority (0 - 7; from lowest to highest priority).
status
string
    Choices:
  • disable
  • enable
Enable or disable this TLV.
vlan
integer
ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag).
vlan_intf
string
VLAN interface to advertise; if configured on port. Source system.interface.name.
med_tlvs
list / elements=string
    Choices:
  • inventory-management
  • network-policy
  • power-management
  • location-identification
Transmitted LLDP-MED TLVs (type-length-value descriptions): inventory management TLV and/or network policy TLV.
name
string / required
Profile name.
tlvs_802dot1
string
    Choices:
  • port-vlan-id
Transmitted IEEE 802.1 TLVs.
tlvs_802dot3
string
    Choices:
  • max-frame-size
  • power-negotiation
Transmitted IEEE 802.3 TLVs.
vdom
string
Default:
"root"
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.

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"
        auto_mclag_icl: "disable"
        custom_tlvs:
         -
            information_string: "<your_own_value>"
            name: "default_name_12"
            oui: "<your_own_value>"
            subtype: "14"
        med_location_service:
         -
            name: "default_name_16"
            status: "disable"
            sys_location_id: "<your_own_value> (source switch-controller.location.name)"
        med_network_policy:
         -
            assign_vlan: "disable"
            dscp: "21"
            name: "default_name_22"
            priority: "23"
            status: "disable"
            vlan: "25"
            vlan_intf: "<your_own_value> (source system.interface.name)"
        med_tlvs: "inventory-management"
        name: "default_name_28"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_lldp_profile_module.html