source: | fortios_system_lldp_network_policy.py |
---|---|
orphan: |
fortios_system_lldp_network_policy -- Configure LLDP network policy in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_system_lldp_network_policy | v6.2.0 -> latest |
- 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...
Supported Version Ranges system_lldp_network_policy v6.2.0 -> latest
- comment - Comment. type: str
more...
Supported Version Ranges comment v6.2.0 -> latest
- guest - Guest. type: dict
more...
Supported Version Ranges guest v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- guest_voice_signaling - Guest Voice Signaling. type: dict
more...
Supported Version Ranges guest_voice_signaling v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- name - LLDP network policy name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> latest
- softphone - Softphone. type: dict
more...
Supported Version Ranges softphone v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- streaming_video - Streaming Video. type: dict
more...
Supported Version Ranges streaming_video v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- video_conferencing - Video Conferencing. type: dict
more...
Supported Version Ranges video_conferencing v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- video_signaling - Video Signaling. type: dict
more...
Supported Version Ranges video_signaling v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- voice - Voice. type: dict
more...
Supported Version Ranges voice v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
- voice_signaling - Voice signaling. type: dict
more...
Supported Version Ranges voice_signaling v6.2.0 -> latest
- dscp - Differentiated Services Code Point (DSCP) value to advertise. type: int
more...
Supported Version Ranges dscp v6.2.0 -> latest
- priority - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority). type: int
more...
Supported Version Ranges priority v6.2.0 -> latest
- status - Enable/disable advertising this policy. type: str choices: disable, enable
more...
Supported Version Ranges status v6.2.0 -> latest
[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
- tag - Advertise tagged or untagged traffic. type: str choices: none, dot1q, dot1p
more...
Supported Version Ranges tag v6.2.0 -> latest
[none] v6.0.0 -> latest
[dot1q] v6.0.0 -> latest
[dot1p] v6.0.0 -> latest
- vlan - 802.1Q VLAN ID to advertise (1 - 4094). type: int
more...
Supported Version Ranges vlan v6.2.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure LLDP network policy.
fortinet.fortios.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"
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
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.