fortinet.fortios.fortios_system_lldp_network_policy module – Configure LLDP network policy in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.1.7).

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

To use it in a playbook, specify: fortinet.fortios.fortios_system_lldp_network_policy.

New in version 2.0.0: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_lldp feature and network_policy 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.9

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

system_lldp_network_policy

dictionary

Configure LLDP network policy.

comment

string

Comment.

guest

dictionary

Guest.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

guest_voice_signaling

dictionary

Guest Voice Signaling.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

name

string / required

LLDP network policy name.

softphone

dictionary

Softphone.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

streaming_video

dictionary

Streaming Video.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

video_conferencing

dictionary

Video Conferencing.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

video_signaling

dictionary

Video Signaling.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

voice

dictionary

Voice.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

voice_signaling

dictionary

Voice signaling.

dscp

integer

Differentiated Services Code Point (DSCP) value to advertise.

priority

integer

802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).

status

string

Enable/disable advertising this policy.

Choices:

  • disable

  • enable

tag

string

Advertise tagged or untagged traffic.

Choices:

  • none

  • dot1q

  • dot1p

vlan

integer

802.1Q VLAN ID to advertise (1 - 4094).

vdom

string

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.

Default: “root”

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure LLDP network policy.
    fortios_system_lldp_network_policy:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_lldp_network_policy:
        comment: "Comment."
        guest:
            dscp: "5"
            priority: "6"
            status: "disable"
            tag: "none"
            vlan: "9"
        guest_voice_signaling:
            dscp: "11"
            priority: "12"
            status: "disable"
            tag: "none"
            vlan: "15"
        name: "default_name_16"
        softphone:
            dscp: "18"
            priority: "19"
            status: "disable"
            tag: "none"
            vlan: "22"
        streaming_video:
            dscp: "24"
            priority: "25"
            status: "disable"
            tag: "none"
            vlan: "28"
        video_conferencing:
            dscp: "30"
            priority: "31"
            status: "disable"
            tag: "none"
            vlan: "34"
        video_signaling:
            dscp: "36"
            priority: "37"
            status: "disable"
            tag: "none"
            vlan: "40"
        voice:
            dscp: "42"
            priority: "43"
            status: "disable"
            tag: "none"
            vlan: "46"
        voice_signaling:
            dscp: "48"
            priority: "49"
            status: "disable"
            tag: "none"
            vlan: "52"

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

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

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)