fortios_system_lldp_network_policy – Configure LLDP network policy in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
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
FortiOS Version Compatibility¶
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_system_lldp_network_policy | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_lldp_network_policy - Configure LLDP network policy. type: dict more...
- comment - Comment. type: str more...
- guest - Guest. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- guest_voice_signaling - Guest Voice Signaling. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- name - LLDP network policy name. type: str required: true more...
- softphone - Softphone. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- streaming_video - Streaming Video. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- video_conferencing - Video Conferencing. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- video_signaling - Video Signaling. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- voice - Voice. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
- voice_signaling - Voice signaling. type: dict more...
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int more...
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int more...
- status - Enable/disable advertising this policy. type: str choices: disable, enable more...
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p more...
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int more...
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: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
guest_voice_signaling:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
name: "default_name_16"
softphone:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
streaming_video:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
video_conferencing:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
video_signaling:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
voice:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
voice_signaling:
dscp: "46"
priority: "5"
status: "disable"
tag: "none"
vlan: "0"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3