#!/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_wanprof_system_virtualwanlink_service
short_description: Create SD-WAN rules or priority rules
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
    wanprof:
        description: The parameter (wanprof) in requested url.
        type: str
        required: true
    wanprof_system_virtualwanlink_service:
        description: The top level parameters set.
        required: false
        type: dict
        suboptions:
            addr-mode:
                type: str
                description: Deprecated, please rename it to addr_mode. Address mode
                choices:
                    - 'ipv4'
                    - 'ipv6'
            bandwidth-weight:
                type: int
                description: Deprecated, please rename it to bandwidth_weight. Coefficient of reciprocal of available bidirectional bandwidth in the fo...
            default:
                type: str
                description: Enable/disable use of SD-WAN as default service.
                choices:
                    - 'disable'
                    - 'enable'
            dscp-forward:
                type: str
                description: Deprecated, please rename it to dscp_forward. Enable/disable forward traffic DSCP tag.
                choices:
                    - 'disable'
                    - 'enable'
            dscp-forward-tag:
                type: str
                description: Deprecated, please rename it to dscp_forward_tag. Forward traffic DSCP tag.
            dscp-reverse:
                type: str
                description: Deprecated, please rename it to dscp_reverse. Enable/disable reverse traffic DSCP tag.
                choices:
                    - 'disable'
                    - 'enable'
            dscp-reverse-tag:
                type: str
                description: Deprecated, please rename it to dscp_reverse_tag. Reverse traffic DSCP tag.
            dst:
                type: raw
                description: (list or str) Destination address name.
            dst-negate:
                type: str
                description: Deprecated, please rename it to dst_negate. Enable/disable negation of destination address match.
                choices:
                    - 'disable'
                    - 'enable'
            dst6:
                type: raw
                description: (list or str) Destination address6 name.
            end-port:
                type: int
                description: Deprecated, please rename it to end_port. End destination port number.
            gateway:
                type: str
                description: Enable/disable SD-WAN service gateway.
                choices:
                    - 'disable'
                    - 'enable'
            groups:
                type: raw
                description: (list or str) User groups.
            health-check:
                type: str
                description: Deprecated, please rename it to health_check. Health check.
            hold-down-time:
                type: int
                description: Deprecated, please rename it to hold_down_time. Waiting period in seconds when switching from the back-up member to the pr...
            id:
                type: int
                description: Priority rule ID
                required: true
            internet-service:
                type: str
                description: Deprecated, please rename it to internet_service. Enable/disable use of Internet service for application-based load balancing.
                choices:
                    - 'disable'
                    - 'enable'
            internet-service-ctrl:
                type: raw
                description: (list) Deprecated, please rename it to internet_service_ctrl.
            internet-service-ctrl-group:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_ctrl_group. Control-based Internet Service group list.
            internet-service-custom:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_custom. Custom Internet service name list.
            internet-service-custom-group:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group list.
            internet-service-group:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_group. Internet Service group list.
            internet-service-id:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_id. Internet service ID list.
            jitter-weight:
                type: int
                description: Deprecated, please rename it to jitter_weight. Coefficient of jitter in the formula of custom-profile-1.
            latency-weight:
                type: int
                description: Deprecated, please rename it to latency_weight. Coefficient of latency in the formula of custom-profile-1.
            link-cost-factor:
                type: str
                description: Deprecated, please rename it to link_cost_factor. Link cost factor.
                choices:
                    - 'latency'
                    - 'jitter'
                    - 'packet-loss'
                    - 'inbandwidth'
                    - 'outbandwidth'
                    - 'bibandwidth'
                    - 'custom-profile-1'
            link-cost-threshold:
                type: int
                description: Deprecated, please rename it to link_cost_threshold. Percentage threshold change of link cost values that will result in p...
            member:
                type: str
                description: Member sequence number.
            mode:
                type: str
                description: Control how the priority rule sets the priority of interfaces in the SD-WAN.
                choices:
                    - 'auto'
                    - 'manual'
                    - 'priority'
                    - 'sla'
                    - 'load-balance'
            name:
                type: str
                description: Priority rule name.
            packet-loss-weight:
                type: int
                description: Deprecated, please rename it to packet_loss_weight. Coefficient of packet-loss in the formula of custom-profile-1.
            priority-members:
                type: raw
                description: (list or str) Deprecated, please rename it to priority_members. Member sequence number list.
            protocol:
                type: int
                description: Protocol number.
            quality-link:
                type: int
                description: Deprecated, please rename it to quality_link. Quality grade.
            route-tag:
                type: int
                description: Deprecated, please rename it to route_tag. IPv4 route map route-tag.
            sla:
                type: list
                elements: dict
                description: No description.
                suboptions:
                    health-check:
                        type: str
                        description: Deprecated, please rename it to health_check. Virtual WAN Link health-check.
                    id:
                        type: int
                        description: SLA ID.
            src:
                type: raw
                description: (list or str) Source address name.
            src-negate:
                type: str
                description: Deprecated, please rename it to src_negate. Enable/disable negation of source address match.
                choices:
                    - 'disable'
                    - 'enable'
            src6:
                type: raw
                description: (list or str) Source address6 name.
            start-port:
                type: int
                description: Deprecated, please rename it to start_port. Start destination port number.
            status:
                type: str
                description: Enable/disable SD-WAN service.
                choices:
                    - 'disable'
                    - 'enable'
            tos:
                type: str
                description: Type of service bit pattern.
            tos-mask:
                type: str
                description: Deprecated, please rename it to tos_mask. Type of service evaluated bits.
            users:
                type: raw
                description: (list or str) User name.
            internet-service-app-ctrl:
                type: raw
                description: (list) Deprecated, please rename it to internet_service_app_ctrl.
            internet-service-app-ctrl-group:
                type: raw
                description: (list or str) Deprecated, please rename it to internet_service_app_ctrl_group. Application control based Internet Service ...
            role:
                type: str
                description: Service role to work with neighbor.
                choices:
                    - 'primary'
                    - 'secondary'
                    - 'standalone'
            sla-compare-method:
                type: str
                description: Deprecated, please rename it to sla_compare_method. Method to compare SLA value for sla and load balance mode.
                choices:
                    - 'order'
                    - 'number'
            standalone-action:
                type: str
                description: Deprecated, please rename it to standalone_action. Enable/disable service when selected neighbor role is standalone while ...
                choices:
                    - 'disable'
                    - 'enable'
            input-device:
                type: raw
                description: (list or str) Deprecated, please rename it to input_device. Source interface name.
            internet-service-name:
                type: str
                description: Deprecated, please rename it to internet_service_name. Internet service name list.
            input-device-negate:
                type: str
                description: Deprecated, please rename it to input_device_negate. Enable/disable negation of input device match.
                choices:
                    - 'disable'
                    - 'enable'
'''

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: Create SD-WAN rules or priority rules
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service:
        # 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>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_service:
          addr_mode: <value in [ipv4, ipv6]>
          bandwidth_weight: <integer>
          default: <value in [disable, enable]>
          dscp_forward: <value in [disable, enable]>
          dscp_forward_tag: <string>
          dscp_reverse: <value in [disable, enable]>
          dscp_reverse_tag: <string>
          dst: <list or string>
          dst_negate: <value in [disable, enable]>
          dst6: <list or string>
          end_port: <integer>
          gateway: <value in [disable, enable]>
          groups: <list or string>
          health_check: <string>
          hold_down_time: <integer>
          id: <integer>
          internet_service: <value in [disable, enable]>
          internet_service_ctrl: <list or integer>
          internet_service_ctrl_group: <list or string>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_id: <list or string>
          jitter_weight: <integer>
          latency_weight: <integer>
          link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
          link_cost_threshold: <integer>
          member: <string>
          mode: <value in [auto, manual, priority, ...]>
          name: <string>
          packet_loss_weight: <integer>
          priority_members: <list or string>
          protocol: <integer>
          quality_link: <integer>
          route_tag: <integer>
          sla:
            -
              health_check: <string>
              id: <integer>
          src: <list or string>
          src_negate: <value in [disable, enable]>
          src6: <list or string>
          start_port: <integer>
          status: <value in [disable, enable]>
          tos: <string>
          tos_mask: <string>
          users: <list or string>
          internet_service_app_ctrl: <list or integer>
          internet_service_app_ctrl_group: <list or string>
          role: <value in [primary, secondary, standalone]>
          sla_compare_method: <value in [order, number]>
          standalone_action: <value in [disable, enable]>
          input_device: <list or string>
          internet_service_name: <string>
          input_device_negate: <value in [disable, enable]>
'''

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}/wanprof/{wanprof}/system/virtual-wan-link/service'
    ]

    perobject_jrpc_urls = [
        '/pm/config/adom/{adom}/wanprof/{wanprof}/system/virtual-wan-link/service/{service}'
    ]

    url_params = ['adom', 'wanprof']
    module_primary_key = 'id'
    module_arg_spec = {
        'adom': {'required': True, 'type': 'str'},
        'wanprof': {'required': True, 'type': 'str'},
        'wanprof_system_virtualwanlink_service': {
            'type': 'dict',
            'v_range': [['6.0.0', '']],
            'options': {
                'addr-mode': {'choices': ['ipv4', 'ipv6'], 'type': 'str'},
                'bandwidth-weight': {'type': 'int'},
                'default': {'choices': ['disable', 'enable'], 'type': 'str'},
                'dscp-forward': {'choices': ['disable', 'enable'], 'type': 'str'},
                'dscp-forward-tag': {'type': 'str'},
                'dscp-reverse': {'choices': ['disable', 'enable'], 'type': 'str'},
                'dscp-reverse-tag': {'type': 'str'},
                'dst': {'type': 'raw'},
                'dst-negate': {'choices': ['disable', 'enable'], 'type': 'str'},
                'dst6': {'type': 'raw'},
                'end-port': {'type': 'int'},
                'gateway': {'choices': ['disable', 'enable'], 'type': 'str'},
                'groups': {'type': 'raw'},
                'health-check': {'type': 'str'},
                'hold-down-time': {'type': 'int'},
                'id': {'required': True, 'type': 'int'},
                'internet-service': {'choices': ['disable', 'enable'], 'type': 'str'},
                'internet-service-ctrl': {'v_range': [['6.0.0', '7.2.1']], 'type': 'raw'},
                'internet-service-ctrl-group': {'v_range': [['6.0.0', '7.2.1']], 'type': 'raw'},
                'internet-service-custom': {'type': 'raw'},
                'internet-service-custom-group': {'type': 'raw'},
                'internet-service-group': {'type': 'raw'},
                'internet-service-id': {'type': 'raw'},
                'jitter-weight': {'type': 'int'},
                'latency-weight': {'type': 'int'},
                'link-cost-factor': {
                    'choices': ['latency', 'jitter', 'packet-loss', 'inbandwidth', 'outbandwidth', 'bibandwidth', 'custom-profile-1'],
                    'type': 'str'
                },
                'link-cost-threshold': {'type': 'int'},
                'member': {'v_range': [['6.0.0', '7.2.1']], 'type': 'str'},
                'mode': {'choices': ['auto', 'manual', 'priority', 'sla', 'load-balance'], 'type': 'str'},
                'name': {'type': 'str'},
                'packet-loss-weight': {'type': 'int'},
                'priority-members': {'type': 'raw'},
                'protocol': {'type': 'int'},
                'quality-link': {'type': 'int'},
                'route-tag': {'type': 'int'},
                'sla': {'type': 'list', 'options': {'health-check': {'type': 'str'}, 'id': {'type': 'int'}}, 'elements': 'dict'},
                'src': {'type': 'raw'},
                'src-negate': {'choices': ['disable', 'enable'], 'type': 'str'},
                'src6': {'type': 'raw'},
                'start-port': {'type': 'int'},
                'status': {'choices': ['disable', 'enable'], 'type': 'str'},
                'tos': {'type': 'str'},
                'tos-mask': {'type': 'str'},
                'users': {'type': 'raw'},
                'internet-service-app-ctrl': {'v_range': [['6.2.0', '']], 'type': 'raw'},
                'internet-service-app-ctrl-group': {'v_range': [['6.2.0', '']], 'type': 'raw'},
                'role': {'v_range': [['6.2.1', '']], 'choices': ['primary', 'secondary', 'standalone'], 'type': 'str'},
                'sla-compare-method': {'v_range': [['6.2.1', '']], 'choices': ['order', 'number'], 'type': 'str'},
                'standalone-action': {'v_range': [['6.2.1', '']], 'choices': ['disable', 'enable'], 'type': 'str'},
                'input-device': {'v_range': [['6.2.2', '']], 'type': 'raw'},
                'internet-service-name': {'v_range': [['6.4.0', '6.4.0']], 'type': 'str'},
                'input-device-negate': {'v_range': [['6.4.1', '']], 'choices': ['disable', 'enable'], '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, 'wanprof_system_virtualwanlink_service'),
                           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()
