fmgr_switchcontroller_lldpprofile – Configure FortiSwitch LLDP profiles.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • switchcontroller_lldpprofile - Configure FortiSwitch LLDP profiles. type: dict
    • 802_1_tlvs (Alias name: 802.1-tlvs) Transmitted ieee 802. type: list choices: [port-vlan-id] more...
    • 802_3_tlvs (Alias name: 802.3-tlvs) Transmitted ieee 802. type: list choices: [max-frame-size, power-negotiation] more...
    • auto_isl (Alias name: auto-isl) Enable/disable auto inter-switch lag. type: str choices: [disable, enable] more...
    • auto_isl_hello_timer (Alias name: auto-isl-hello-timer) Auto inter-switch lag hello timer duration (1 - 30 sec, default = 3). type: int more...
    • auto_isl_port_group (Alias name: auto-isl-port-group) Auto inter-switch lag port group id (0 - 9). type: int more...
    • auto_isl_receive_timeout (Alias name: auto-isl-receive-timeout) Auto inter-switch lag timeout if no response is received (3 - 90 sec, default = 9). type: int more...
    • custom_tlvs (Alias name: custom-tlvs) Custom-tlvs. type: list more...
      • information_string (Alias name: information-string) Organizationally defined information string (0 - 507 hexadecimal bytes). type: str more...
      • name Tlv name (not sent). type: str more...
      • oui Organizationally unique identifier (oui), a 3-byte hexadecimal number, for this tlv. type: str more...
      • subtype Organizationally defined subtype (0 - 255). type: int more...
    • med_network_policy (Alias name: med-network-policy) Med-network-policy. type: list more...
      • dscp 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. type: int more...
      • name Policy type name. type: str more...
      • priority Advertised layer 2 priority (0 - 7; from lowest to highest priority). type: int more...
      • status Enable or disable this tlv. type: str choices: [disable, enable] more...
      • vlan Id of vlan to advertise, if configured on port (0 - 4094, 0 = priority tag). type: int more...
      • vlan_intf (Alias name: vlan-intf) Vlan interface to advertise; if configured on port. type: str more...
      • assign_vlan (Alias name: assign-vlan) Enable/disable vlan assignment when this profile is applied on managed fortiswitch port. type: str choices: [disable, enable] more...
    • med_tlvs (Alias name: med-tlvs) Transmitted lldp-med tlvs (type-length-value descriptions). type: list choices: [inventory-management, network-policy, power-management, location-identification] more...
    • name Profile name. type: str more...
    • med_location_service (Alias name: med-location-service) Med-location-service. type: list more...
      • name Location service type name. type: str more...
      • status Enable or disable this tlv. type: str choices: [disable, enable] more...
      • sys_location_id (Alias name: sys-location-id) Location service id. type: str more...
    • auto_mclag_icl (Alias name: auto-mclag-icl) Enable/disable mclag inter chassis link. type: str choices: [disable, enable] more...
    • auto_isl_auth (Alias name: auto-isl-auth) Auto inter-switch lag authentication mode. type: str choices: [legacy, strict, relax] more...
    • auto_isl_auth_encrypt (Alias name: auto-isl-auth-encrypt) Auto inter-switch lag encryption mode. type: str choices: [none, mixed, must] more...
    • auto_isl_auth_identity (Alias name: auto-isl-auth-identity) Auto inter-switch lag authentication identity. type: str more...
    • auto_isl_auth_macsec_profile (Alias name: auto-isl-auth-macsec-profile) Auto inter-switch lag macsec profile for encryption. type: str more...
    • auto_isl_auth_reauth (Alias name: auto-isl-auth-reauth) Auto inter-switch lag authentication reauth period in seconds(10 - 3600, default = 3600). type: int more...
    • auto_isl_auth_user (Alias name: auto-isl-auth-user) Auto inter-switch lag authentication user certificate. type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch LLDP profiles.
      fortinet.fortimanager.fmgr_switchcontroller_lldpprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_lldpprofile:
          802_1_tlvs:
            - port-vlan-id
          802_3_tlvs:
            - max-frame-size
            - power-negotiation
          auto_isl: <value in [disable, enable]>
          auto_isl_hello_timer: <integer>
          auto_isl_port_group: <integer>
          auto_isl_receive_timeout: <integer>
          custom_tlvs:
            -
              information_string: <string>
              name: <string>
              oui: <string>
              subtype: <integer>
          med_network_policy:
            -
              dscp: <integer>
              name: <string>
              priority: <integer>
              status: <value in [disable, enable]>
              vlan: <integer>
              vlan_intf: <string>
              assign_vlan: <value in [disable, enable]>
          med_tlvs:
            - inventory-management
            - network-policy
            - power-management
            - location-identification
          name: <string>
          med_location_service:
            -
              name: <string>
              status: <value in [disable, enable]>
              sys_location_id: <string>
          auto_mclag_icl: <value in [disable, enable]>
          auto_isl_auth: <value in [legacy, strict, relax]>
          auto_isl_auth_encrypt: <value in [none, mixed, must]>
          auto_isl_auth_identity: <string>
          auto_isl_auth_macsec_profile: <string>
          auto_isl_auth_reauth: <integer>
          auto_isl_auth_user: <string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)