#!/usr/bin/python
from __future__ import absolute_import, division, print_function
# Copyright 2019-2024 Fortinet, Inc.
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

__metaclass__ = type

ANSIBLE_METADATA = {'status': ['preview'],
                    'supported_by': 'community',
                    'metadata_version': '1.1'}

DOCUMENTATION = '''
---
module: fmgr_switchcontroller_lldpprofile
short_description: Configure FortiSwitch LLDP profiles.
description:
    - This module is able to configure a FortiManager device.
    - Examples include all parameters and values which need to be adjusted to data sources before usage.

version_added: "2.0.0"
author:
    - Xinwei Du (@dux-fortinet)
    - Xing Li (@lix-fortinet)
    - Jie Xue (@JieX19)
    - Link Zheng (@chillancezen)
    - Frank Shen (@fshen01)
    - Hongbin Lu (@fgtdev-hblu)
notes:
    - Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case).
      Please change the arguments such as "var-name" to "var_name".
      Old argument names are still available yet you will receive deprecation warnings.
      You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
    - 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
options:
    access_token:
        description: The token to access FortiManager without using username and password.
        type: str
    bypass_validation:
        description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.
        type: bool
        default: false
    enable_log:
        description: Enable/Disable logging for task.
        type: bool
        default: false
    forticloud_access_token:
        description: Authenticate Ansible client with forticloud API access token.
        type: str
    proposed_method:
        description: The overridden method for the underlying Json RPC request.
        type: str
        choices:
          - update
          - set
          - add
    rc_succeeded:
        description: The rc codes list with which the conditions to succeed will be overriden.
        type: list
        elements: int
    rc_failed:
        description: The rc codes list with which the conditions to fail will be overriden.
        type: list
        elements: int
    state:
        description: The directive to create, update or delete an object.
        type: str
        required: true
        choices:
          - present
          - absent
    workspace_locking_adom:
        description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
        type: str
    workspace_locking_timeout:
        description: The maximum time in seconds to wait for other user to release the workspace lock.
        type: int
        default: 300
    adom:
        description: The parameter (adom) in requested url.
        type: str
        required: true
    switchcontroller_lldpprofile:
        description: The top level parameters set.
        required: false
        type: dict
        suboptions:
            802.1-tlvs:
                type: list
                elements: str
                description: Deprecated, please rename it to 802_1_tlvs. Transmitted IEEE 802.
                choices:
                    - 'port-vlan-id'
            802.3-tlvs:
                type: list
                elements: str
                description: Deprecated, please rename it to 802_3_tlvs. Transmitted IEEE 802.
                choices:
                    - 'max-frame-size'
                    - 'power-negotiation'
            auto-isl:
                type: str
                description: Deprecated, please rename it to auto_isl. Enable/disable auto inter-switch LAG.
                choices:
                    - 'disable'
                    - 'enable'
            auto-isl-hello-timer:
                type: int
                description: Deprecated, please rename it to auto_isl_hello_timer. Auto inter-switch LAG hello timer duration
            auto-isl-port-group:
                type: int
                description: Deprecated, please rename it to auto_isl_port_group. Auto inter-switch LAG port group ID
            auto-isl-receive-timeout:
                type: int
                description: Deprecated, please rename it to auto_isl_receive_timeout. Auto inter-switch LAG timeout if no response is received
            custom-tlvs:
                type: list
                elements: dict
                description: Deprecated, please rename it to custom_tlvs. Custom-Tlvs.
                suboptions:
                    information-string:
                        type: str
                        description: Deprecated, please rename it to information_string. Organizationally defined information string
                    name:
                        type: str
                        description: TLV name
                    oui:
                        type: str
                        description: Organizationally unique identifier
                    subtype:
                        type: int
                        description: Organizationally defined subtype
            med-network-policy:
                type: list
                elements: dict
                description: Deprecated, please rename it to med_network_policy. Med-Network-Policy.
                suboptions:
                    dscp:
                        type: int
                        description: Advertised Differentiated Services Code Point
                    name:
                        type: str
                        description: Policy type name.
                    priority:
                        type: int
                        description: Advertised Layer 2 priority
                    status:
                        type: str
                        description: Enable or disable this TLV.
                        choices:
                            - 'disable'
                            - 'enable'
                    vlan:
                        type: int
                        description: ID of VLAN to advertise, if configured on port
                    vlan-intf:
                        type: str
                        description: Deprecated, please rename it to vlan_intf. VLAN interface to advertise; if configured on port.
                    assign-vlan:
                        type: str
                        description: Deprecated, please rename it to assign_vlan. Enable/disable VLAN assignment when this profile is applied on manage...
                        choices:
                            - 'disable'
                            - 'enable'
            med-tlvs:
                type: list
                elements: str
                description: Deprecated, please rename it to med_tlvs. Transmitted LLDP-MED TLVs
                choices:
                    - 'inventory-management'
                    - 'network-policy'
                    - 'power-management'
                    - 'location-identification'
            name:
                type: str
                description: Profile name.
                required: true
            med-location-service:
                type: list
                elements: dict
                description: Deprecated, please rename it to med_location_service. Med-Location-Service.
                suboptions:
                    name:
                        type: str
                        description: Location service type name.
                    status:
                        type: str
                        description: Enable or disable this TLV.
                        choices:
                            - 'disable'
                            - 'enable'
                    sys-location-id:
                        type: str
                        description: Deprecated, please rename it to sys_location_id. Location service ID.
            auto-mclag-icl:
                type: str
                description: Deprecated, please rename it to auto_mclag_icl. Enable/disable MCLAG inter chassis link.
                choices:
                    - 'disable'
                    - 'enable'
            auto-isl-auth:
                type: str
                description: Deprecated, please rename it to auto_isl_auth. Auto inter-switch LAG authentication mode.
                choices:
                    - 'legacy'
                    - 'strict'
                    - 'relax'
            auto-isl-auth-encrypt:
                type: str
                description: Deprecated, please rename it to auto_isl_auth_encrypt. Auto inter-switch LAG encryption mode.
                choices:
                    - 'none'
                    - 'mixed'
                    - 'must'
            auto-isl-auth-identity:
                type: str
                description: Deprecated, please rename it to auto_isl_auth_identity. Auto inter-switch LAG authentication identity.
            auto-isl-auth-macsec-profile:
                type: str
                description: Deprecated, please rename it to auto_isl_auth_macsec_profile. Auto inter-switch LAG macsec profile for encryption.
            auto-isl-auth-reauth:
                type: int
                description: Deprecated, please rename it to auto_isl_auth_reauth. Auto inter-switch LAG authentication reauth period in seconds
            auto-isl-auth-user:
                type: str
                description: Deprecated, please rename it to auto_isl_auth_user. Auto inter-switch LAG authentication user certificate.
'''

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 = '''
meta:
    description: The result of the request.
    type: dict
    returned: always
    contains:
        request_url:
            description: The full url requested.
            returned: always
            type: str
            sample: /sys/login/user
        response_code:
            description: The status of api request.
            returned: always
            type: int
            sample: 0
        response_data:
            description: The api response.
            type: list
            returned: always
        response_message:
            description: The descriptive message of the api response.
            type: str
            returned: always
            sample: OK.
        system_information:
            description: The information of the target system.
            type: dict
            returned: always
rc:
    description: The status the request.
    type: int
    returned: always
    sample: 0
version_check_warning:
    description: Warning if the parameters used in the playbook are not supported by the current FortiManager version.
    type: list
    returned: complex
'''
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import NAPIManager
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_galaxy_version
from ansible_collections.fortinet.fortimanager.plugins.module_utils.napi import check_parameter_bypass
from ansible_collections.fortinet.fortimanager.plugins.module_utils.common import get_module_arg_spec


def main():
    jrpc_urls = [
        '/pm/config/adom/{adom}/obj/switch-controller/lldp-profile',
        '/pm/config/global/obj/switch-controller/lldp-profile'
    ]

    perobject_jrpc_urls = [
        '/pm/config/adom/{adom}/obj/switch-controller/lldp-profile/{lldp-profile}',
        '/pm/config/global/obj/switch-controller/lldp-profile/{lldp-profile}'
    ]

    url_params = ['adom']
    module_primary_key = 'name'
    module_arg_spec = {
        'adom': {'required': True, 'type': 'str'},
        'switchcontroller_lldpprofile': {
            'type': 'dict',
            'v_range': [['6.0.0', '']],
            'options': {
                '802.1-tlvs': {'type': 'list', 'choices': ['port-vlan-id'], 'elements': 'str'},
                '802.3-tlvs': {'type': 'list', 'choices': ['max-frame-size', 'power-negotiation'], 'elements': 'str'},
                'auto-isl': {'choices': ['disable', 'enable'], 'type': 'str'},
                'auto-isl-hello-timer': {'type': 'int'},
                'auto-isl-port-group': {'type': 'int'},
                'auto-isl-receive-timeout': {'type': 'int'},
                'custom-tlvs': {
                    'type': 'list',
                    'options': {'information-string': {'type': 'str'}, 'name': {'type': 'str'}, 'oui': {'type': 'str'}, 'subtype': {'type': 'int'}},
                    'elements': 'dict'
                },
                'med-network-policy': {
                    'type': 'list',
                    'options': {
                        'dscp': {'type': 'int'},
                        'name': {'type': 'str'},
                        'priority': {'type': 'int'},
                        'status': {'choices': ['disable', 'enable'], 'type': 'str'},
                        'vlan': {'type': 'int'},
                        'vlan-intf': {'v_range': [['6.2.0', '']], 'type': 'str'},
                        'assign-vlan': {'v_range': [['6.2.2', '']], 'choices': ['disable', 'enable'], 'type': 'str'}
                    },
                    'elements': 'dict'
                },
                'med-tlvs': {
                    'type': 'list',
                    'choices': ['inventory-management', 'network-policy', 'power-management', 'location-identification'],
                    'elements': 'str'
                },
                'name': {'required': True, 'type': 'str'},
                'med-location-service': {
                    'v_range': [['6.2.0', '']],
                    'type': 'list',
                    'options': {
                        'name': {'v_range': [['6.2.0', '']], 'type': 'str'},
                        'status': {'v_range': [['6.2.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                        'sys-location-id': {'v_range': [['6.2.0', '']], 'type': 'str'}
                    },
                    'elements': 'dict'
                },
                'auto-mclag-icl': {'v_range': [['6.4.0', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                'auto-isl-auth': {'v_range': [['7.4.1', '']], 'choices': ['legacy', 'strict', 'relax'], 'type': 'str'},
                'auto-isl-auth-encrypt': {'v_range': [['7.4.1', '']], 'choices': ['none', 'mixed', 'must'], 'type': 'str'},
                'auto-isl-auth-identity': {'v_range': [['7.4.1', '']], 'type': 'str'},
                'auto-isl-auth-macsec-profile': {'v_range': [['7.4.1', '']], 'type': 'str'},
                'auto-isl-auth-reauth': {'v_range': [['7.4.1', '']], 'type': 'int'},
                'auto-isl-auth-user': {'v_range': [['7.4.1', '']], 'type': 'str'}
            }

        }
    }

    module_option_spec = get_module_arg_spec('full crud')
    module_arg_spec.update(module_option_spec)
    params_validation_blob = []
    check_galaxy_version(module_arg_spec)
    module = AnsibleModule(argument_spec=check_parameter_bypass(module_arg_spec, 'switchcontroller_lldpprofile'),
                           supports_check_mode=False)

    if not module._socket_path:
        module.fail_json(msg='MUST RUN IN HTTPAPI MODE')
    connection = Connection(module._socket_path)
    connection.set_option('access_token', module.params.get('access_token', None))
    connection.set_option('enable_log', module.params.get('enable_log', False))
    connection.set_option('forticloud_access_token', module.params.get('forticloud_access_token', None))
    fmgr = NAPIManager(jrpc_urls, perobject_jrpc_urls, module_primary_key, url_params, module, connection, top_level_schema_name='data')
    fmgr.validate_parameters(params_validation_blob)
    fmgr.process_curd(argument_specs=module_arg_spec)

    module.exit_json(meta=module.params)


if __name__ == '__main__':
    main()
