fortinet.fortios.fortios_switch_controller_lldp_profile module – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
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.0.0: 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 |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure FortiSwitch LLDP profiles. |
|
Enable/disable auto inter-switch LAG. Choices:
|
|
Auto inter-switch LAG hello timer duration (1 - 30 sec). |
|
Auto inter-switch LAG port group ID (0 - 9). |
|
Auto inter-switch LAG timeout if no response is received (3 - 90 sec). |
|
Enable/disable MCLAG inter chassis link. Choices:
|
|
Configuration method to edit custom TLV entries. |
|
Organizationally defined information string (0 - 507 hexadecimal bytes). |
|
TLV name (not sent). |
|
Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. |
|
Organizationally defined subtype (0 - 255). |
|
Configuration method to edit Media Endpoint Discovery (MED) location service type-length-value (TLV) categories. |
|
Location service type name. |
|
Enable or disable this TLV. Choices:
|
|
Location service ID. Source switch-controller.location.name. |
|
Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories. |
|
Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port. Choices:
|
|
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. |
|
Policy type name. |
|
Advertised Layer 2 priority (0 - 7; from lowest to highest priority). |
|
Enable or disable this TLV. Choices:
|
|
ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). |
|
VLAN interface to advertise; if configured on port. Source system.interface.name. |
|
Transmitted LLDP-MED TLVs (type-length-value descriptions). Choices:
|
|
Profile name. |
|
Transmitted IEEE 802.1 TLVs. Choices:
|
|
Transmitted IEEE 802.3 TLVs. Choices:
|
|
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. Default: “root” |
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 |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always 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)