lix_fortinet.fortios.fortios_system_lldp_network_policy (102.2.120) — module

Configure LLDP network policy in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

system_lldp_network_policy:
    default: null
    description:
    - Configure LLDP network policy.
    suboptions:
      comment:
        description:
        - Comment.
        type: str
      guest:
        description:
        - Guest.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      guest_voice_signaling:
        description:
        - Guest Voice Signaling.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      name:
        description:
        - LLDP network policy name.
        required: true
        type: str
      softphone:
        description:
        - Softphone.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      streaming_video:
        description:
        - Streaming Video.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      video_conferencing:
        description:
        - Video Conferencing.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      video_signaling:
        description:
        - Video Signaling.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      voice:
        description:
        - Voice.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
      voice_signaling:
        description:
        - Voice signaling.
        suboptions:
          dscp:
            description:
            - Differentiated Services Code Point (DSCP) value to advertise.
            type: int
          priority:
            description:
            - 802.1P CoS/PCP to advertise (0 - 7; from lowest to highest priority).
            type: int
          status:
            choices:
            - disable
            - enable
            description:
            - Enable/disable advertising this policy.
            type: str
          tag:
            choices:
            - none
            - dot1q
            - dot1p
            description:
            - Advertise tagged or untagged traffic.
            type: str
          vlan:
            description:
            - 802.1Q VLAN ID to advertise (1 - 4094).
            type: int
        type: dict
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str