fortinet.fortimanager.fmgr_switchcontroller_lldpprofile module – Configure FortiSwitch LLDP profiles.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_switchcontroller_lldpprofile.

New in fortinet.fortimanager 2.0.0

Synopsis

• This module is able to configure a FortiManager device.

• Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
switchcontroller_lldpprofile dictionary	The top level parameters set.
802.1-tlvs list / elements=string	Deprecated, please rename it to 802_1_tlvs. Transmitted IEEE 802. Choices: "port-vlan-id"
802.3-tlvs list / elements=string	Deprecated, please rename it to 802_3_tlvs. Transmitted IEEE 802. Choices: "max-frame-size" "power-negotiation"
auto-isl string	Deprecated, please rename it to auto_isl. Enable/disable auto inter-switch LAG. Choices: "disable" "enable"
auto-isl-auth string	Deprecated, please rename it to auto_isl_auth. Auto inter-switch LAG authentication mode. Choices: "legacy" "strict" "relax"
auto-isl-auth-encrypt string	Deprecated, please rename it to auto_isl_auth_encrypt. Auto inter-switch LAG encryption mode. Choices: "none" "mixed" "must"
auto-isl-auth-identity string	Deprecated, please rename it to auto_isl_auth_identity. Auto inter-switch LAG authentication identity.
auto-isl-auth-macsec-profile string	Deprecated, please rename it to auto_isl_auth_macsec_profile. Auto inter-switch LAG macsec profile for encryption.
auto-isl-auth-reauth integer	Deprecated, please rename it to auto_isl_auth_reauth. Auto inter-switch LAG authentication reauth period in seconds
auto-isl-auth-user string	Deprecated, please rename it to auto_isl_auth_user. Auto inter-switch LAG authentication user certificate.
auto-isl-hello-timer integer	Deprecated, please rename it to auto_isl_hello_timer. Auto inter-switch LAG hello timer duration
auto-isl-port-group integer	Deprecated, please rename it to auto_isl_port_group. Auto inter-switch LAG port group ID
auto-isl-receive-timeout integer	Deprecated, please rename it to auto_isl_receive_timeout. Auto inter-switch LAG timeout if no response is received
auto-mclag-icl string	Deprecated, please rename it to auto_mclag_icl. Enable/disable MCLAG inter chassis link. Choices: "disable" "enable"
custom-tlvs list / elements=dictionary	Deprecated, please rename it to custom_tlvs. Custom-Tlvs.
information-string string	Deprecated, please rename it to information_string. Organizationally defined information string
name string	TLV name
oui string	Organizationally unique identifier
subtype integer	Organizationally defined subtype
med-location-service list / elements=dictionary	Deprecated, please rename it to med_location_service. Med-Location-Service.
name string	Location service type name.
status string	Enable or disable this TLV. Choices: "disable" "enable"
sys-location-id string	Deprecated, please rename it to sys_location_id. Location service ID.
med-network-policy list / elements=dictionary	Deprecated, please rename it to med_network_policy. Med-Network-Policy.
assign-vlan string	Deprecated, please rename it to assign_vlan. Enable/disable VLAN assignment when this profile is applied on manage… Choices: "disable" "enable"
dscp integer	Advertised Differentiated Services Code Point
name string	Policy type name.
priority integer	Advertised Layer 2 priority
status string	Enable or disable this TLV. Choices: "disable" "enable"
vlan integer	ID of VLAN to advertise, if configured on port
vlan-intf string	Deprecated, please rename it to vlan_intf. VLAN interface to advertise; if configured on port.
med-tlvs list / elements=string	Deprecated, please rename it to med_tlvs. Transmitted LLDP-MED TLVs Choices: "inventory-management" "network-policy" "power-management" "location-identification"
name string / required	Profile name.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch LLDP profiles.
      fortinet.fortimanager.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: present # <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: <integer>
          auto_isl_port_group: <integer>
          auto_isl_receive_timeout: <integer>
          custom_tlvs:
            -
              information_string: <string>
              name: <string>
              oui: <string>
              subtype: <integer>
          med_network_policy:
            -
              dscp: <integer>
              name: <string>
              priority: <integer>
              status: <value in [disable, enable]>
              vlan: <integer>
              vlan_intf: <string>
              assign_vlan: <value in [disable, enable]>
          med_tlvs:
            - inventory-management
            - network-policy
            - power-management
            - location-identification
          name: <string>
          med_location_service:
            -
              name: <string>
              status: <value in [disable, enable]>
              sys_location_id: <string>
          auto_mclag_icl: <value in [disable, enable]>
          auto_isl_auth: <value in [legacy, strict, relax]>
          auto_isl_auth_encrypt: <value in [none, mixed, must]>
          auto_isl_auth_identity: <string>
          auto_isl_auth_macsec_profile: <string>
          auto_isl_auth_reauth: <integer>
          auto_isl_auth_user: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)