fmgr_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
switchcontroller_lldpprofile yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • switchcontroller_lldpprofile - no description type: dict
    • 802.1-tlvs - Transmitted IEEE 802. type: array choices: [port-vlan-id] more...
    • 802.3-tlvs - Transmitted IEEE 802. type: array 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, default = 3). 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, default = 9). type: int more...
    • custom-tlvs - Custom-Tlvs. type: array more...
      • information-string - Organizationally defined information string (0 - 507 hexadecimal bytes). type: str more...
      • name - TLV name (not sent). type: str 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-network-policy - Med-Network-Policy. type: array 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 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. type: str more...
      • assign-vlan - Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port. type: str choices: [disable, enable] more...
    • med-tlvs - Transmitted LLDP-MED TLVs (type-length-value descriptions). type: array choices: [inventory-management, network-policy, power-management, location-identification] more...
    • name - Profile name. type: str more...
    • med-location-service - Med-Location-Service. type: array more...
      • name - Location service type name. type: str more...
      • status - Enable or disable this TLV. type: str choices: [disable, enable] more...
      • sys-location-id - Location service ID. type: str more...
    • auto-mclag-icl - Enable/disable MCLAG inter chassis link. type: str choices: [disable, enable] more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_switchcontroller_lldpprofile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        switchcontroller_lldpprofile:
           802.1-tlvs:
             - port-vlan-id
           802.3-tlvs:
             - max-frame-size
             - power-negotiation
           auto-isl: <value in [disable, enable]>
           auto-isl-hello-timer: <value of integer>
           auto-isl-port-group: <value of integer>
           auto-isl-receive-timeout: <value of integer>
           custom-tlvs:
             -
                 information-string: <value of string>
                 name: <value of string>
                 oui: <value of string>
                 subtype: <value of integer>
           med-network-policy:
             -
                 dscp: <value of integer>
                 name: <value of string>
                 priority: <value of integer>
                 status: <value in [disable, enable]>
                 vlan: <value of integer>
                 vlan-intf: <value of string>
                 assign-vlan: <value in [disable, enable]>
           med-tlvs:
             - inventory-management
             - network-policy
             - power-management
             - location-identification
           name: <value of string>
           med-location-service:
             -
                 name: <value of string>
                 status: <value in [disable, enable]>
                 sys-location-id: <value of string>
           auto-mclag-icl: <value in [disable, enable]>

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.