fortios_switch_controller_lldp_profile.rst

source:	fortios_switch_controller_lldp_profile.py
orphan:

fortios_switch_controller_lldp_profile -- Configure FortiSwitch LLDP profiles in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_switch_controller_lldp_profile	v6.0.0 -> latest

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

  	Supported Version Ranges
  switch_controller_lldp_profile	v6.0.0 -> latest

• tlvs_802dot1 - Transmitted IEEE 802.1 TLVs. type: list choices: port-vlan-id more...

  	Supported Version Ranges
  tlvs_802dot1	v6.0.0 -> latest
  [port-vlan-id]	v6.0.0 -> latest

• tlvs_802dot3 - Transmitted IEEE 802.3 TLVs. type: list choices: max-frame-size, power-negotiation more...

  	Supported Version Ranges
  tlvs_802dot3	v6.0.0 -> latest
  [max-frame-size]	v6.0.0 -> latest
  [power-negotiation]	v6.2.0 -> latest

• auto_isl - Enable/disable auto inter-switch LAG. type: str choices: disable, enable more...

  	Supported Version Ranges
  auto_isl	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• auto_isl_auth - Auto inter-switch LAG authentication mode. type: str choices: legacy, strict, relax more...

  	Supported Version Ranges
  auto_isl_auth	v7.4.1 -> latest
  [legacy]	v6.0.0 -> latest
  [strict]	v6.0.0 -> latest
  [relax]	v6.0.0 -> latest

• auto_isl_auth_encrypt - Auto inter-switch LAG encryption mode. type: str choices: none, mixed, must more...

  	Supported Version Ranges
  auto_isl_auth_encrypt	v7.4.1 -> latest
  [none]	v6.0.0 -> latest
  [mixed]	v6.0.0 -> latest
  [must]	v6.0.0 -> latest

• auto_isl_auth_identity - Auto inter-switch LAG authentication identity. type: str more...

  	Supported Version Ranges
  auto_isl_auth_identity	v7.4.1 -> latest

• auto_isl_auth_macsec_profile - Auto inter-switch LAG macsec profile for encryption. type: str more...

  	Supported Version Ranges
  auto_isl_auth_macsec_profile	v7.4.1 -> latest

• auto_isl_auth_reauth - Auto inter-switch LAG authentication reauth period in seconds(10 - 3600). type: int more...

  	Supported Version Ranges
  auto_isl_auth_reauth	v7.4.1 -> latest

• auto_isl_auth_user - Auto inter-switch LAG authentication user certificate. type: str more...

  	Supported Version Ranges
  auto_isl_auth_user	v7.4.1 -> latest

• auto_isl_hello_timer - Auto inter-switch LAG hello timer duration (1 - 30 sec). type: int more...

  	Supported Version Ranges
  auto_isl_hello_timer	v6.0.0 -> latest

• auto_isl_port_group - Auto inter-switch LAG port group ID (0 - 9). type: int more...

  	Supported Version Ranges
  auto_isl_port_group	v6.0.0 -> latest

• auto_isl_receive_timeout - Auto inter-switch LAG timeout if no response is received (3 - 90 sec). type: int more...

  	Supported Version Ranges
  auto_isl_receive_timeout	v6.0.0 -> latest

• auto_mclag_icl - Enable/disable MCLAG inter chassis link. type: str choices: disable, enable more...

  	Supported Version Ranges
  auto_mclag_icl	v6.4.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• custom_tlvs - Configuration method to edit custom TLV entries. type: list member_path: custom_tlvs:name more...

  	Supported Version Ranges
  custom_tlvs	v6.0.0 -> latest

• information_string - Organizationally defined information string (0 - 507 hexadecimal bytes). type: str more...

  	Supported Version Ranges
  information_string	v6.0.0 -> latest

• name - TLV name (not sent). type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• oui - Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV. type: str more...

  	Supported Version Ranges
  oui	v6.0.0 -> latest

• subtype - Organizationally defined subtype (0 - 255). type: int more...

  	Supported Version Ranges
  subtype	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  med_location_service	v6.2.0 -> latest

• name - Location service type name. type: str required: true more...

  	Supported Version Ranges
  name	v6.2.0 -> latest

• status - Enable or disable this TLV. type: str choices: disable, enable more...

  	Supported Version Ranges
  status	v6.2.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• sys_location_id - Location service ID. Source switch-controller.location.name. type: str more...

  	Supported Version Ranges
  sys_location_id	v6.2.0 -> latest

• 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...

  	Supported Version Ranges
  med_network_policy	v6.0.0 -> latest

• assign_vlan - Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port. type: str choices: disable, enable more...

  	Supported Version Ranges
  assign_vlan	v6.2.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• 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...

  	Supported Version Ranges
  dscp	v6.0.0 -> latest

• name - Policy type name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• priority - Advertised Layer 2 priority (0 - 7; from lowest to highest priority). type: int more...

  	Supported Version Ranges
  priority	v6.0.0 -> latest

• status - Enable or disable this TLV. type: str choices: disable, enable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• vlan - ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag). type: int more...

  	Supported Version Ranges
  vlan	v6.0.0 -> v6.0.11	v6.2.3 -> v6.2.3

• vlan_intf - VLAN interface to advertise; if configured on port. Source system.interface.name. type: str more...

  	Supported Version Ranges
  vlan_intf	v6.2.0 -> latest

• med_tlvs - Transmitted LLDP-MED TLVs (type-length-value descriptions). type: list choices: inventory-management, network-policy, power-management, location-identification more...

  	Supported Version Ranges
  med_tlvs	v6.0.0 -> latest
  [inventory-management]	v6.0.0 -> latest
  [network-policy]	v6.0.0 -> latest
  [power-management]	v6.2.0 -> latest
  [location-identification]	v6.2.0 -> latest

• name - Profile name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure FortiSwitch LLDP profiles.
  fortinet.fortios.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_auth: "legacy"
          auto_isl_auth_encrypt: "none"
          auto_isl_auth_identity: "<your_own_value>"
          auto_isl_auth_macsec_profile: "<your_own_value>"
          auto_isl_auth_reauth: "3600"
          auto_isl_auth_user: "<your_own_value>"
          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_18"
                  oui: "<your_own_value>"
                  subtype: "0"
          med_location_service:
              -
                  name: "default_name_22"
                  status: "disable"
                  sys_location_id: "<your_own_value> (source switch-controller.location.name)"
          med_network_policy:
              -
                  assign_vlan: "disable"
                  dscp: "0"
                  name: "default_name_28"
                  priority: "0"
                  status: "disable"
                  vlan: "2047"
                  vlan_intf: "<your_own_value> (source system.interface.name)"
          med_tlvs: "inventory-management"
          name: "default_name_34"

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.