fortios_switch_controller_lldp_profile – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate

From Get docs
Ansible/docs/2.8/modules/fortios switch controller lldp profile module


fortios_switch_controller_lldp_profile – Configure FortiSwitch LLDP profiles in Fortinet’s FortiOS and FortiGate

New in version 2.8.


Synopsis

  • This module is able to configure a FortiGate or FortiOS 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.2

Requirements

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

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

host

- / required

FortiOS or FortiGate ip address.

https

boolean

  • no
  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol

password

-

Default:

""

FortiOS or FortiGate password.

switch_controller_lldp_profile

-

Default:

null

Configure FortiSwitch LLDP profiles.

802.1-tlvs

-

  • port-vlan-id

Transmitted IEEE 802.1 TLVs.

802.3-tlvs

-

  • max-frame-size

Transmitted IEEE 802.3 TLVs.

auto-isl

-

  • disable
  • enable

Enable/disable auto inter-switch LAG.

auto-isl-hello-timer

-

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

auto-isl-port-group

-

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

auto-isl-receive-timeout

-

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

custom-tlvs

-

Configuration method to edit custom TLV entries.

information-string

-

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

name

- / required

TLV name (not sent).

oui

-

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

subtype

-

Organizationally defined subtype (0 - 255).

med-network-policy

-

Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value (TLV) categories.

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.

name

- / required

Policy type name.

priority

-

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

status

-

  • disable
  • enable

Enable or disable this TLV.

vlan

-

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

med-tlvs

-

  • inventory-management
  • network-policy

Transmitted LLDP-MED TLVs (type-length-value descriptions): inventory management TLV and/or network policy TLV.

name

- / required

Profile name.

state

-

  • present
  • absent

Indicates whether to create or remove the object

username

- / required

FortiOS or FortiGate username.

vdom

-

Default:

"root"

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.



Notes

Note

  • Requires fortiosapi library developed by Fortinet
  • Run as a local_action in your playbook


Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure FortiSwitch LLDP profiles.
    fortios_switch_controller_lldp_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      switch_controller_lldp_profile:
        state: "present"
        802.1-tlvs: "port-vlan-id"
        802.3-tlvs: "max-frame-size"
        auto-isl: "disable"
        auto-isl-hello-timer: "6"
        auto-isl-port-group: "7"
        auto-isl-receive-timeout: "8"
        custom-tlvs:
         -
            information-string: "<your_own_value>"
            name: "default_name_11"
            oui: "<your_own_value>"
            subtype: "13"
        med-network-policy:
         -
            dscp: "15"
            name: "default_name_16"
            priority: "17"
            status: "disable"
            vlan: "19"
        med-tlvs: "inventory-management"
        name: "default_name_21"

Return Values

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

Key Returned Description

build

string

always

Build number of the fortigate image


Sample:

1547

http_method

string

always

Last method used to provision the content into FortiGate


Sample:

PUT

http_status

string

always

Last result given by FortiGate on last operation applied


Sample:

200

mkey

string

success

Master key (id) used in the last call to FortiGate


Sample:

id

name

string

always

Name of the table used to fulfill the request


Sample:

urlfilter

path

string

always

Path of the table used to fulfill the request


Sample:

webfilter

revision

string

always

Internal revision number


Sample:

17.0.2.10658

serial

string

always

Serial number of the unit


Sample:

FGVMEVYYQT3AB5352

status

string

always

Indication of the operation's result


Sample:

success

vdom

string

always

Virtual domain used


Sample:

root

version

string

always

Version of the FortiGate


Sample:

v5.6.3




Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_switch_controller_lldp_profile_module.html