fortios_switch_controller_lldp_profile – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate.¶
New in version 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 lldp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_switch_controller_lldp_profile | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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_lldp_profile - Configure FortiSwitch LLDP profiles. type: dict more...
- tlvs_802dot1 - Transmitted IEEE 802.1 TLVs. type: list choices: port-vlan-id more...
- tlvs_802dot3 - Transmitted IEEE 802.3 TLVs. type: list choices: max-frame-size, power-negotiation more...
- auto_isl - Enable/disable auto inter-switch LAG. type: str choices: disable, enable more...
- auto_isl_hello_timer - Auto inter-switch LAG hello timer duration (1 - 30 sec). type: int more...
- auto_isl_port_group - Auto inter-switch LAG port group ID (0 - 9). type: int more...
- auto_isl_receive_timeout - Auto inter-switch LAG timeout if no response is received (3 - 90 sec). type: int more...
- auto_mclag_icl - Enable/disable MCLAG inter chassis link. type: str choices: disable, enable more...
- custom_tlvs - Configuration method to edit custom TLV entries. type: list member_path: custom_tlvs:name more...
- information_string - Organizationally defined information string (0 - 507 hexadecimal bytes). type: str more...
- name - TLV name (not sent). type: str required: true more...
- oui - Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. type: str more...
- subtype - Organizationally defined subtype (0 - 255). type: int more...
- med_location_service - Configuration method to edit Media Endpoint Discovery (MED) location service type-length-value (TLV) categories. type: list member_path: med_location_service:name more...
- name - Location service type name. type: str required: true more...
- status - Enable or disable this TLV. type: str choices: disable, enable more...
- sys_location_id - Location service ID. Source switch-controller.location.name. type: str more...
- med_network_policy - Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories. type: list member_path: med_network_policy:name more...
- assign_vlan - Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port. type: str choices: disable, enable more...
- 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 more...
- name - Policy type name. type: str required: true more...
- priority - Advertised Layer 2 priority (0 - 7; from lowest to highest priority). type: int more...
- status - Enable or disable this TLV. type: str choices: disable, enable more...
- vlan - ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). type: int more...
- vlan_intf - VLAN interface to advertise; if configured on port. Source system.interface.name. type: str more...
- med_tlvs - Transmitted LLDP-MED TLVs (type-length-value descriptions). type: list choices: inventory-management, network-policy, power-management, location-identification more...
- name - Profile name. type: str required: true more...
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: "3"
auto_isl_port_group: "0"
auto_isl_receive_timeout: "60"
auto_mclag_icl: "disable"
custom_tlvs:
-
information_string: "<your_own_value>"
name: "default_name_12"
oui: "<your_own_value>"
subtype: "0"
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: "0"
name: "default_name_22"
priority: "0"
status: "disable"
vlan: "2047"
vlan_intf: "<your_own_value> (source system.interface.name)"
med_tlvs: "inventory-management"
name: "default_name_28"
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