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

Note

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

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 version 2.10: of fortinet.fortimanager

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

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

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

Transmitted IEEE 802.1 TLVs.

Choices:

  • port-vlan-id

802.3-tlvs

list / elements=string

Transmitted IEEE 802.3 TLVs.

Choices:

  • max-frame-size

  • power-negotiation

auto-isl

string

Enable/disable auto inter-switch LAG.

Choices:

  • disable

  • enable

auto-isl-hello-timer

integer

Auto inter-switch LAG hello timer duration (1 - 30 sec, default = 3).

auto-isl-port-group

integer

Auto inter-switch LAG port group ID (0 - 9).

auto-isl-receive-timeout

integer

Auto inter-switch LAG timeout if no response is received (3 - 90 sec, default = 9).

auto-mclag-icl

string

Enable/disable MCLAG inter chassis link.

Choices:

  • disable

  • enable

custom-tlvs

list / elements=string

Custom-Tlvs.

information-string

string

Organizationally defined information string (0 - 507 hexadecimal bytes).

name

string

TLV name (not sent).

oui

string

Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for this TLV.

subtype

integer

Organizationally defined subtype (0 - 255).

med-location-service

list / elements=string

Med-Location-Service.

name

string

Location service type name.

status

string

Enable or disable this TLV.

Choices:

  • disable

  • enable

sys-location-id

string

Location service ID.

med-network-policy

list / elements=string

Med-Network-Policy.

assign-vlan

string

Enable/disable VLAN assignment when this profile is applied on managed FortiSwitch port.

Choices:

  • disable

  • enable

dscp

integer

Advertised Differentiated Services Code Point (DSCP) value, a packet header value indicating the level of service requ…

name

string

Policy type name.

priority

integer

Advertised Layer 2 priority (0 - 7; from lowest to highest priority).

status

string

Enable or disable this TLV.

Choices:

  • disable

  • enable

vlan

integer

ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag).

vlan-intf

string

VLAN interface to advertise; if configured on port.

med-tlvs

list / elements=string

Transmitted LLDP-MED TLVs (type-length-value descriptions).

Choices:

  • inventory-management

  • network-policy

  • power-management

  • location-identification

name

string

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

  • 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: Configure FortiSwitch LLDP profiles.
     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 here, the following are the fields unique to this module:

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)