fortiswitch_switch_lldp_profile – LLDP configuration profiles in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify switch_lldp feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_switch_lldp_profile | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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_lldp_profile - LLDP configuration profiles. type: dict
- auto_isl - Enable/disable automatic inter-switch LAG. type: str choices: enable, disable
- auto_isl_auth - Automatic inter-switch LAG authentication. type: str choices: legacy, strict, relax
- auto_isl_auth_encrypt - Automatic inter-switch LAG authentication encryption. type: str choices: none, must, mixed
- auto_isl_auth_identity - Automatic authentication identity. type: str
- auto_isl_auth_macsec_profile - Fortilink LLDP macsec port profile. type: str
- auto_isl_auth_reauth - Automatic authentication reauth period (10 - 3600 mins). type: int
- auto_isl_auth_user - Automatic authentication User certificate. type: str
- auto_isl_hello_timer - Automatic ISL hello timer (1 - 30 sec). type: int
- auto_isl_port_group - Automatic inter-switch LAG port group. type: int
- auto_isl_receive_timeout - Automatic ISL timeout (0 - 300 sec). type: int
- auto_mclag_icl - Enable/disable MCLAG inter chassis link. type: str choices: enable, disable
- custom_tlvs - Organizationally Specific TLV configuration. type: list
- information_string - Organizationally defined information string. type: str
- name - TLV name (not sent). type: str
- oui - Organizationally unique identifier. type: str
- subtype - Organizationally defined subtype. type: int
- med_location_service - LLDP MED location service configuration. type: list
- name - Policy type name. type: str
- status - Enable/disable Location Service TLV. type: str choices: disable, enable
- sys_location_id - LLDP System Location Id. type: str
- med_network_policy - LLDP MED network policy configuration. type: list
- assign_vlan - Enable/disable automatically adding this VLAN to ports with this profile (does not affect trunks). type: str choices: disable, enable
- dscp - Advertised DSCP value. type: int
- name - Policy type name. type: str
- priority - Advertised L2 priority. type: int
- status - Enable/disable this TLV. type: str choices: disable, enable
- vlan - VLAN to advertise (if configured on port). type: int
- med_tlvs - Transmitted LLDP-MED TLVs. type: str choices: inventory-management, network-policy, location-identification, power-management
- name - Profile name. type: str required: true
- tlvs_802dot1 - Transmitted IEEE 802.1 TLVs. type: str choices: port-vlan-id, vlan-name
- tlvs_802dot3 - Transmitted IEEE 802.3 TLVs. type: str choices: max-frame-size, power-negotiation, eee-config
- vlan_name_map - VLANs that advertise Vlan Names type: str
Examples
- name: LLDP configuration profiles.
fortinet.fortiswitch.fortiswitch_switch_lldp_profile:
state: "present"
switch_lldp_profile:
802.1_tlvs: "port-vlan-id"
802.3_tlvs: "max-frame-size"
auto_isl: "enable"
auto_isl_auth: "legacy"
auto_isl_auth_encrypt: "none"
auto_isl_auth_identity: "<your_own_value>"
auto_isl_auth_macsec_profile: "<your_own_value> (source switch.macsec.profile.name)"
auto_isl_auth_reauth: "10"
auto_isl_auth_user: "<your_own_value> (source system.certificate.local.name)"
auto_isl_hello_timer: "12"
auto_isl_port_group: "13"
auto_isl_receive_timeout: "14"
auto_mclag_icl: "enable"
custom_tlvs:
-
information_string: "<your_own_value>"
name: "default_name_18"
oui: "<your_own_value>"
subtype: "20"
med_location_service:
-
name: "default_name_22"
status: "disable"
sys_location_id: "<your_own_value> (source system.location.name)"
med_network_policy:
-
assign_vlan: "disable"
dscp: "27"
name: "default_name_28"
priority: "29"
status: "disable"
vlan: "31"
med_tlvs: "inventory-management"
name: "default_name_33"
vlan_name_map: "<your_own_value>"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.