ansible.builtin.fortios_switch_controller_lldp_profile (v2.8.20) — module

Configure FortiSwitch LLDP profiles in Fortinet's FortiOS and FortiGate.

| "added in version" 2.8 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

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

Usage examples

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

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip address.
    required: true

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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

switch_controller_lldp_profile:
    default: null
    description:
    - Configure FortiSwitch LLDP profiles.
    suboptions:
      802.1-tlvs:
        choices:
        - port-vlan-id
        description:
        - Transmitted IEEE 802.1 TLVs.
      802.3-tlvs:
        choices:
        - max-frame-size
        description:
        - Transmitted IEEE 802.3 TLVs.
      auto-isl:
        choices:
        - disable
        - enable
        description:
        - Enable/disable auto inter-switch LAG.
      auto-isl-hello-timer:
        description:
        - Auto inter-switch LAG hello timer duration (1 - 30 sec, default = 3).
      auto-isl-port-group:
        description:
        - Auto inter-switch LAG port group ID (0 - 9).
      auto-isl-receive-timeout:
        description:
        - Auto inter-switch LAG timeout if no response is received (3 - 90 sec, default
          = 9).
      custom-tlvs:
        description:
        - Configuration method to edit custom TLV entries.
        suboptions:
          information-string:
            description:
            - Organizationally defined information string (0 - 507 hexadecimal bytes).
          name:
            description:
            - TLV name (not sent).
            required: true
          oui:
            description:
            - Organizationally unique identifier (OUI), a 3-byte hexadecimal number, for
              this TLV.
          subtype:
            description:
            - Organizationally defined subtype (0 - 255).
      med-network-policy:
        description:
        - Configuration method to edit Media Endpoint Discovery (MED) network policy type-length-value
          (TLV) categories.
        suboptions:
          dscp:
            description:
            - 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:
            description:
            - Policy type name.
            required: true
          priority:
            description:
            - Advertised Layer 2 priority (0 - 7; from lowest to highest priority).
          status:
            choices:
            - disable
            - enable
            description:
            - Enable or disable this TLV.
          vlan:
            description:
            - ID of VLAN to advertise, if configured on port (0 - 4094, 0 = priority tag).
      med-tlvs:
        choices:
        - inventory-management
        - network-policy
        description:
        - 'Transmitted LLDP-MED TLVs (type-length-value descriptions): inventory management
          TLV and/or network policy TLV.'
      name:
        description:
        - Profile name.
        required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

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