#!/usr/bin/python

# (c) 2020, NetApp, Inc
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

""" NetApp ONTAP Info using REST APIs """

from __future__ import absolute_import, division, print_function

__metaclass__ = type

DOCUMENTATION = '''
module: na_ontap_rest_info
author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
extends_documentation_fragment:
    - netapp.ontap.netapp.na_ontap
short_description: NetApp ONTAP information gatherer using REST APIs
description:
    - This module allows you to gather various information about ONTAP configuration using REST APIs
version_added: 20.5.0
notes:
  - I(security_login_role_config_info) there is no REST equivalent.
  - I(security_login_role_info) there is no REST equivalent.
  - I(security_key_manager_key_info) there is no REST equivalent.
  - I(vserver_motd_info) there is no REST equivalent.
  - I(vserver_login_banner_info) there is no REST equivalent.
  - I(vscan_connection_extended_stats_info) there is no REST equivalent.
  - I(env_sensors_info) there is no REST equivalent.
  - I(fcp_adapter_info) there is no REST equivalent.
  - I(net_dev_discovery_info) there is no REST equivalent.
  - I(net_failover_group_info)  there is no REST equivalent.
  - I(net_firewall_info) there is no REST equivalent.
  - I(ntfs_dacl_info) there is no REST equivalent.
  - I(ntfs_sd_info) there is no REST equivalent.
  - I(role_info) there is not REST equivalent.
  - I(subsys_health_info) there is not REST equivalent.
  - I(volume_move_target_aggr_info) there is not REST equivalent.

options:
    state:
        type: str
        description:
            - deprecated as of 21.1.0.
            - this option was ignored and continues to be ignored.
    gather_subset:
        type: list
        elements: str
        description:
            - When supplied, this argument will restrict the information collected to a given subset.
            - Either the REST API or the ZAPI info name can be given. Possible values for this argument include
            - application/applications or application_info
            - application/consistency-groups
            - application/templates or application_template_info
            - cloud/targets or cloud_targets_info
            - cluster/chassis or cluster_chassis_info
            - cluster/fireware/history
            - cluster/jobs or cluster_jobs_info
            - cluster/licensing/licenses or license_info
            - cluster/mediators
            - cluster/metrics or cluster_metrics_info
            - cluster/metrocluster or metrocluster_info
            - cluster/metrocluster/diagnostics or cluster_metrocluster_diagnostics or metrocluster_check_info
            - cluster/metrocluster/dr-groups
            - cluster/metrocluster/interconnects
            - cluster/metrocluster/nodes or metrocluster-node-get-iter
            - cluster/metrocluster/operations
            - cluster/nodes or cluster_node_info or sysconfig_info
            - cluster/ntp/keys
            - cluster/ntp/servers or ntp_server_info
            - cluster/peers or cluster_peer_info
            - cluster/schedules or cluster_schedules or job_schedule_cron_info
            - cluster/software or ontap_system_version or  cluster_image_info
            - cluster/software/download or cluster_software_download
            - cluster/software/history or cluster_software_history
            - cluster/software/packages or cluster_software_packages
            - cluster/web
            - name-services/dns or svm_dns_config_info or net_dns_info
            - name-services/ldap or svm_ldap_config_info or ldap_client or ldap_config
            - name-services/local-hosts
            - name-services/name-mappings or svm_name_mapping_config_info
            - name-services/nis or svm_nis_config_info
            - name-services/unix-groups
            - name-services/unix-users
            - network/ethernet/broadcast-domains or broadcast_domains_info or net_port_broadcast_domain_info
            - network/ethernet/ports or network_ports_info or  net_port_info
            - network/ethernet/switch/ports
            - network/ethernet/switches or cluster_switch_info
            - network/fc/logins or san_fc_logins_info
            - network/fc/ports
            - network/fc/wwpn-aliases or san_fc_wppn-aliases or fcp_alias_info
            - network/http-proxy
            - network/ip/bgp/peer-groups
            - network/ip/interfaces or ip_interfaces_info or net_interface_info
            - network/ip/routes or ip_routes_info or net_routes_info
            - network/ip/service-policies or ip_service_policies or net_interface_service_policy_info
            - network/ipspaces or network_ipspaces_info or net_ipspaces_info
            - private/support/alerts or sys_cluster_alerts
            - private/cli/vserver/security/file-directory or file_directory_security
            - protocols/audit
            - protocols/cifs/domains
            - protocols/cifs/home-directory/search-paths or cifs_home_directory_info
            - protocols/cifs/local-groups
            - protocols/cifs/local-users
            - protocols/cifs/services or cifs_services_info or cifs_options_info
            - protocols/cifs/sessions
            - protocols/cifs/shares or cifs_share_info
            - protocols/cifs/users-and-groups/privileges
            - protocols/cifs/unix-symlink-mapping
            - protocols/file-access-tracing/events
            - protocols/file-access-tracing/filters
            - protocols/fpolicy
            - protocols/locks
            - protocols/ndmp
            - protocols/ndmp/nodes
            - protocols/ndmp/sessions
            - protocols/ndmp/svms
            - protocols/nfs/connected-clients
            - protocols/nfs/export-policies or export_policy_info
            - protocols/nfs/export-policies/rules B(Requires the owning_resource to be set)
            - protocols/nfs/kerberos/interfaces
            - protocols/nfs/kerberos/realms or kerberos_realm_info
            - protocols/nfs/services or vserver_nfs_info or nfs_info
            - protocols/nvme/interfaces or nvme_interface_info
            - protocols/nvme/services or nvme_info
            - protocols/nvme/subsystems or nvme_subsystem_info
            - protocols/nvme/subsystem-controllers
            - protocols/nvme/subsystem-maps
            - protocols/s3/buckets
            - protocols/s3/services
            - protocols/san/fcp/services or san_fcp_services or fcp_service_info
            - protocols/san/igroups or nitiator_groups_info or igroup_info
            - protocols/san/iscsi/credentials or san_iscsi_credentials
            - protocols/san/iscsi/services or san_iscsi_services or iscsi_service_info
            - protocols/san/iscsi/sessions
            - protocols/san/lun-maps or san_lun_maps or lun_map_info
            - protocols/san/portsets
            - protocols/san/vvol-bindings
            - protocols/vscan or vscan_status_info or vscan_info
            - protocols/vscan/server-status or vscan_connection_status_all_info
            - security/accounts or security_login_info or security_login_account_info
            - security/anti-ransomware/suspects
            - security/audit
            - security/audit/destinations or cluster_log_forwarding_info
            - security/audit/messages
            - security/authentication/cluster/ad-proxy
            - security/authentication/cluster/ldap
            - security/authentication/cluster/nis
            - security/authentication/cluster/saml-sp
            - security/authentication/publickeys
            - security/azure-key-vaults
            - security/certificates
            - security/gcp-kms
            - security/ipsec
            - security/ipsec/ca-certificates
            - security/ipsec/policies
            - security/ipsec/security-associations
            - security/key-manager-configs
            - security/key-managers
            - security/key-stores
            - security/login/messages
            - security/roles or security_login_rest_role_info
            - security/ssh
            - security/ssh/svms
            - snapmirror/policies or snapmirror_policy_info
            - snapmirror/relationships or snapmirror_info
            - storage/aggregates or aggregate_info
            - storage/bridges or storage_bridge_info
            - storage/cluster
            - storage/disks or disk_info
            - storage/file/clone/split-loads
            - storage/file/clone/split-status
            - storage/file/clone/tokens
            - storage/flexcache/flexcaches or storage_flexcaches_info
            - storage/flexcache/origins or storage_flexcaches_origin_info
            - storage/luns or storage_luns_info or lun_info
            - storage/monitored-files
            - storage/namespaces or storage_NVMe_namespaces or nvme_namespace_info
            - storage/ports or storage_ports_info
            - storage/qos/policies or storage_qos_policies or qos_policy_info or qos_adaptive_policy_info
            - storage/qos/workloads
            - storage/qtrees or storage_qtrees_config or qtree_info
            - storage/quota/reports or storage_quota_reports or quota_report_info
            - storage/quota/rules or storage_quota_policy_rules
            - storage/shelves or storage_shelves_config or shelf_info
            - storage/snaplock/audit-logs
            - storage/snaplock/compliance-clocks
            - storage/snaplock/event-retention/operations
            - storage/snaplock/event-retention/policies
            - storage/snaplock/file-fingerprints
            - storage/snaplock/litigations
            - storage/snapshot-policies or storage_snapshot_policies or snapshot_policy_info
            - storage/switches
            - storage/tape-devices
            - storage/volumes or volume_info
            - storage/volumes/snapshots B(Requires the owning_resource to be set)
            - storage/volume-efficiency-policies or sis_policy_info
            - support/autosupport or autosupport_config_info
            - support/autosupport/check or autosupport_check_info
            - support/autosupport/messages or autosupport_messages_history
            - support/auto-update
            - support/auto-update/configurations
            - support/auto-update/updates
            - support/configuration-backup
            - support/configuration-backup/backups
            - support/coredump/coredumps
            - support/ems or support_ems_config
            - support/ems/destinations or event_notification_info or event_notification_destination_info
            - support/ems/events or support_ems_events
            - support/ems/filters or support_ems_filters
            - support/ems/messages
            - support/snmp
            - support/snmp/traphosts
            - support/snmp/users
            - svm/migrations
            - svm/peers or svm_peers_info or vserver_peer_info
            - svm/peer-permissions or svm_peer-permissions_info
            - svm/svms or vserver_info
            - B(The following do not have direct Rest API equivalent)
            - aggr_efficiency_info
            - cifs_vserver_security_info
            - clock_info
            - cluster_identity_info
            - net_vlan_info
            - sis_info
            - snapmirror_destination_info
            - system_node_info
            - volume_space_info
            - Can specify a list of values to include a larger subset.
            - REST APIs are supported with ONTAP 9.6 onwards.
        default: "demo"
    max_records:
        type: int
        description:
            - Maximum number of records returned in a single call.
        default: 1024
    fields:
        type: list
        elements: str
        description:
            - Request specific fields from subset.
               '*' to return all the fields, one or more subsets are allowed.
               '<list of fields>'  to return specified fields, only one subset will be allowed.
            - If the option is not present, return default REST subset of Api Fields for that API.
        version_added: '20.6.0'
    parameters:
        description:
        - Allows for any rest option to be passed in
        type: dict
        version_added: '20.7.0'
    use_python_keys:
        description:
        - If true, I(/) in the returned dictionary keys are translated to I(_).
        - It makes it possible to use a . notation when processing the output.
        - For instance I(ontap_info["svm/svms"]) can be accessed as I(ontap_info.svm_svms).
        type: bool
        default: false
        version_added: '21.9.0'
    owning_resource:
        description:
        - Some resources cannot be accessed directly.  You need to select them based on the owner or parent.  For instance, volume for a snaphot.
        - The following subsets require an owning resource, and the following suboptions when uuid is not present.
        - <snapshot>  B(volume_name) is the volume name, B(svm_name) is the owning vserver name for the volume.
        - <export policy rule> B(policy_name) is the name of the policy, B(svm_name) is the owning vserver name for the policy, B(rule_index) is the rule index.
        type: dict
        version_added: '21.19.0'
'''

EXAMPLES = '''
- name: run ONTAP gather facts for vserver info
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - svm/svms

- name: run ONTAP gather facts for aggregate info and volume info
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - storage/aggregates
      - storage/volumes

- name: run ONTAP gather facts for all subsets
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      use_rest: Always
      gather_subset:
      - all

- name: run ONTAP gather facts for aggregate info and volume info with fields section
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - '*'
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/aggregates
        - storage/volumes

- name: run ONTAP gather facts for aggregate info with specified fields
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - 'uuid'
        - 'name'
        - 'node'
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/aggregates
      parameters:
        recommend:
          true

- name: Get Snapshot info (owning_resource example)
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      fields:
        - '*'
      validate_certs: false
      use_rest: Always
      gather_subset:
        - storage/volumes/snapshots
      owning_resource:
        volume_name: volume_name
        svm_name: svm_name

- name: run ONTAP gather facts for volume info with query on name and state
  netapp.ontap.na_ontap_rest_info:
      hostname: "1.2.3.4"
      username: "testuser"
      password: "test-password"
      https: true
      validate_certs: false
      gather_subset:
        - storage/volumes
      parameters:
        name: ansible*
        state: online

- name: run ONTAP gather fact to get DACLs
  netapp.ontap.na_ontap_rest_info:
    hostname: "1.2.3.4"
    username: "testuser"
    password: "test-password"
    https: true
    validate_certs: false
    gather_subset:
        - file_directory_security
    parameters:
      vserver: svm1
      path: /vol1/qtree1
    use_python_keys: true
'''

from ansible.module_utils.basic import AnsibleModule
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule
from ansible_collections.netapp.ontap.plugins.module_utils.netapp import OntapRestAPI
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic


class NetAppONTAPGatherInfo(object):
    '''Class with gather info methods'''

    def __init__(self):
        """
        Parse arguments, setup state variables,
        check parameters and ensure request module is installed
        """
        self.argument_spec = netapp_utils.na_ontap_host_argument_spec()
        self.argument_spec.update(dict(
            state=dict(type='str', required=False),
            gather_subset=dict(default=['demo'], type='list', elements='str', required=False),
            max_records=dict(type='int', default=1024, required=False),
            fields=dict(type='list', elements='str', required=False),
            parameters=dict(type='dict', required=False),
            use_python_keys=dict(type='bool', default=False),
            owning_resource=dict(type='dict', required=False),
        ))

        self.module = AnsibleModule(
            argument_spec=self.argument_spec,
            supports_check_mode=True
        )

        # set up variables
        self.na_helper = NetAppModule()
        self.parameters = self.na_helper.set_parameters(self.module.params)
        self.fields = ''

        self.rest_api = OntapRestAPI(self.module)

    def validate_ontap_version(self):
        """
            Method to validate the ONTAP version
        """

        api = 'cluster'
        data = {'fields': ['version']}

        ontap_version, error = self.rest_api.get(api, data)

        if error:
            self.module.fail_json(msg=error)

        return ontap_version

    def get_subset_info(self, gather_subset_info, default_fields=None):
        """
            Gather ONTAP information for the given subset using REST APIs
            Input for REST APIs call : (api, data)
            return gathered_ontap_info
        """

        api = gather_subset_info['api_call']
        if gather_subset_info.pop('post', False):
            self.run_post(gather_subset_info)
        if default_fields:
            total_fields = default_fields + ',' + self.fields
            data = {'max_records': self.parameters['max_records'], 'fields': total_fields}
        else:
            data = {'max_records': self.parameters['max_records'], 'fields': self.fields}

        #  Delete the fields record from data if it is a private/cli API call.
        #  The private_cli_fields method handles the fields for API calls using the private/cli endpoint.
        if '/private/cli' in api:
            del data['fields']

        # allow for passing in any additional rest api fields
        if self.parameters.get('parameters'):
            for each in self.parameters['parameters']:
                data[each] = self.parameters['parameters'][each]

        gathered_ontap_info, error = self.rest_api.get(api, data)

        if not error:
            return gathered_ontap_info

        # If the API doesn't exist (using an older system), we don't want to fail the task.
        if int(error.get('code', 0)) == 3 or (
           # if Aggr recommender can't make a recommendation, it will fail with the following error code, don't fail the task.
           int(error.get('code', 0)) == 19726344 and "No recommendation can be made for this cluster" in error.get('message')):
            return error.get('message')

        # Fail the module if error occurs from REST APIs call
        if int(error.get('code', 0)) == 6:
            error = "%s user is not authorized to make %s api call" % (self.parameters.get('username'), api)
        self.module.fail_json(msg=error)

    @staticmethod
    def strip_dacls(response):
        # Use 'DACL - ACE' as a marker for the start of the list of DACLS in the descriptor.
        if 'acls' not in response['records'][0]:
            return None
        if 'DACL - ACEs' not in response['records'][0]['acls']:
            return None
        index = response['records'][0]['acls'].index('DACL - ACEs')
        dacls = response['records'][0]['acls'][(index + 1):]

        dacl_list = []
        if dacls:
            for dacl in dacls:
                # The '-' marker is the start of the DACL, the '-0x' marker is the end of the DACL.
                start_hyphen = dacl.index('-') + 1
                first_hyphen_removed = dacl[start_hyphen:]
                end_hyphen = first_hyphen_removed.index('-0x')
                dacl_dict = {'access_type': dacl[:start_hyphen - 1].strip()}
                dacl_dict['user_or_group'] = first_hyphen_removed[:end_hyphen]
                dacl_list.append(dacl_dict)
        return dacl_list

    def run_post(self, gather_subset_info):
        api = gather_subset_info['api_call']
        post_return, error = self.rest_api.post(api, None)
        if error:
            return None
        dummy, error = self.rest_api.wait_on_job(post_return['job'], increment=5)
        if error:
            # TODO: Handle errors that are not errors
            self.module.fail_json(msg="%s" % error)

    def get_next_records(self, api):
        """
            Gather next set of ONTAP information for the specified api
            Input for REST APIs call : (api, data)
            return gather_subset_info
        """

        data = {}
        gather_subset_info, error = self.rest_api.get(api, data)

        if error:
            self.module.fail_json(msg=error)

        return gather_subset_info

    def private_cli_fields(self, api):
        '''
        The private cli endpoint does not allow '*' to be an entered.
        If fields='*' or fields are not included within the playbook, the API call will be populated to return all possible fields.
        If fields is entered into the playbook the fields entered will be parsed into the API.
        '''
        if api == 'support/autosupport/check':
            if 'fields' not in self.parameters or '*' in self.parameters['fields']:
                fields = '?fields=node,corrective-action,status,error-detail,check-type,check-category'
            else:
                fields = '?fields=' + ','.join(self.parameters.get('fields'))

        if api == 'private/cli/vserver/security/file-directory':
            fields = '?fields=acls'

        return str(fields)

    def convert_subsets(self):
        """
        Convert an info to the REST API
        """
        info_to_rest_mapping = {
            "aggregate_info": "storage/aggregates",
            "aggr_efficiency_info": ['storage/aggregates', 'space.efficiency,name,node'],
            "application_info": "application/applications",
            "application_template_info": "application/templates",
            "autosupport_check_info": "support/autosupport/check",
            "autosupport_config_info": "support/autosupport",
            "autosupport_messages_history": "support/autosupport/messages",
            "broadcast_domains_info": "network/ethernet/broadcast-domains",
            "cifs_home_directory_info": "protocols/cifs/home-directory/search-paths",
            "cifs_options_info": "protocols/cifs/services",
            "cifs_services_info": "protocols/cifs/services",
            "cifs_share_info": "protocols/cifs/shares",
            "cifs_vserver_security_info": ["protocols/cifs/services", "security.encrypt_dc_connection,"
                                                                      "security.kdc_encryption,security.smb_signing,"
                                                                      "security.smb_encryption,"
                                                                      "security.lm_compatibility_level,svm.name"],
            "clock_info": ["cluster/nodes", "date"],
            "cloud_targets_info": "cloud/targets",
            "cluster_chassis_info": "cluster/chassis",
            "cluster_identity_info": ["cluster", "contact,location,name,uuid"],
            "cluster_image_info": "cluster/software",
            "cluster_jobs_info": "cluster/jobs",
            "cluster_log_forwarding_info": "security/audit/destinations",
            "cluster_metrocluster_diagnostics": "cluster/metrocluster/diagnostics",
            "cluster_metrics_info": "cluster/metrics",
            "cluster_node_info": "cluster/nodes",
            "cluster_peer_info": "cluster/peers",
            "cluster_schedules": "cluster/schedules",
            "cluster_software_download": "cluster/software/download",
            "cluster_software_history": "cluster/software/history",
            "cluster_software_packages": "cluster/software/packages",
            "cluster_switch_info": "network/ethernet/switches",
            "disk_info": "storage/disks",
            "event_notification_info": "support/ems/destinations",
            "event_notification_destination_info": "support/ems/destinations",
            "export_policy_info": "protocols/nfs/export-policies",
            "fcp_alias_info": "network/fc/wwpn-aliases",
            "fcp_service_info": "protocols/san/fcp/services",
            "file_directory_security": "private/cli/vserver/security/file-directory",
            "igroup_info": "protocols/san/igroups",
            "initiator_groups_info": "protocols/san/igroups",
            "ip_interfaces_info": "network/ip/interfaces",
            "ip_routes_info": "network/ip/routes",
            "ip_service_policies": "network/ip/service-policies",
            "iscsi_service_info": "protocols/san/iscsi/services",
            "job_schedule_cron_info": "cluster/schedules",
            "kerberos_realm_info": "protocols/nfs/kerberos/realms",
            "ldap_client": "name-services/ldap",
            "ldap_config": "name-services/ldap",
            "license_info": "cluster/licensing/licenses",
            "lun_info": "storage/luns",
            "lun_map_info": "protocols/san/lun-maps",
            "net_dns_info": "name-services/dns",
            "net_interface_info": "network/ip/interfaces",
            "net_interface_service_policy_info": "network/ip/service-policies",
            "net_port_broadcast_domain_info": "network/ethernet/broadcast-domains",
            "net_port_info": "network/ethernet/ports",
            "net_routes_info": "network/ip/routes",
            "net_ipspaces_info": "network/ipspaces",
            "net_vlan_info": ["network/ethernet/ports", "name,node.name,vlan.base_port,vlan.tag"],
            "network_ipspaces_info": "network/ipspaces",
            "network_ports_info": "network/ethernet/ports",
            "nfs_info": "protocols/nfs/services",
            "ntp_server_info": "cluster/ntp/servers",
            "nvme_info": "protocols/nvme/services",
            "nvme_interface_info": "protocols/nvme/interfaces",
            "nvme_namespace_info": "storage/namespaces",
            "nvme_subsystem_info": "protocols/nvme/subsystems",
            "metrocluster_info": "cluster/metrocluster",
            "metrocluster_node_info": "cluster/metrocluster/nodes",
            "metrocluster_check_info": "cluster/metrocluster/diagnostics",
            "ontap_system_version": "cluster/software",
            "quota_report_info": "storage/quota/reports",
            "qos_policy_info": "storage/qos/policies",
            "qos_adaptive_policy_info": "storage/qos/policies",
            "qtree_info": "storage/qtrees",
            "san_fc_logins_info": "network/fc/logins",
            "san_fc_wppn-aliases": "network/fc/wwpn-aliases",
            "san_fcp_services": "protocols/san/fcp/services",
            "san_iscsi_credentials": "protocols/san/iscsi/credentials",
            "san_iscsi_services": "protocols/san/iscsi/services",
            "san_lun_maps": "protocols/san/lun-maps",
            "security_login_account_info": "security/accounts",
            "security_login_info": "security/accounts",
            "security_login_rest_role_info": "security/roles",
            "shelf_info": "storage/shelves",
            "sis_info": ["storage/volumes", "efficiency.compression,efficiency.cross_volume_dedupe,"
                                            "efficiency.cross_volume_dedupe,efficiency.compaction,"
                                            "efficiency.compression,efficiency.dedupe,efficiency.policy.name,"
                                            "efficiency.schedule,svm.name"],
            "sis_policy_info": "storage/volume-efficiency-policies",
            "snapmirror_destination_info": ["snapmirror/relationships", "destination.path,destination.svm.name,"
                                                                        "destination.svm.uuid,policy.type,uuid,state,"
                                                                        "source.path,source.svm.name,source.svm.uuid,"
                                                                        "transfer.bytes_transferred"],
            "snapmirror_info": "snapmirror/relationships",
            "snapmirror_policy_info": "snapmirror/policies",
            "snapshot_policy_info": "storage/snapshot-policies",
            "storage_bridge_info": "storage/bridges",
            "storage_flexcaches_info": "storage/flexcache/flexcaches",
            "storage_flexcaches_origin_info": "storage/flexcache/origins",
            "storage_luns_info": "storage/luns",
            "storage_NVMe_namespaces": "storage/namespaces",
            "storage_ports_info": "storage/ports",
            "storage_qos_policies": "storage/qos/policies",
            "storage_qtrees_config": "storage/qtrees",
            "storage_quota_reports": "storage/quota/reports",
            "storage_quota_policy_rules": "storage/quota/rules",
            "storage_shelves_config": "storage/shelves",
            "storage_snapshot_policies": "storage/snapshot-policies",
            "support_ems_config": "support/ems",
            "support_ems_events": "support/ems/events",
            "support_ems_filters": "support/ems/filters",
            "svm_dns_config_info": "name-services/dns",
            "svm_ldap_config_info": "name-services/ldap",
            "svm_name_mapping_config_info": "name-services/name-mappings",
            "svm_nis_config_info": "name-services/nis",
            "svm_peers_info": "svm/peers",
            "svm_peer-permissions_info": "svm/peer-permissions",
            "sysconfig_info": "cluster/nodes",
            "system_node_info": ["cluster/nodes", "controller.cpu.firmware_release,controller.failed_fan.count,"
                                                  "controller.failed_fan.message,"
                                                  "controller.failed_power_supply.count,"
                                                  "controller.failed_power_supply.message,"
                                                  "controller.over_temperature,is_all_flash_optimized,"
                                                  "is_all_flash_select_optimized,is_capacity_optimized,state,name,"
                                                  "location,model,nvram.id,owner,serial_number,storage_configuration,"
                                                  "system_id,uptime,uuid,vendor_serial_number,nvram.battery_state,"
                                                  "version,vm.provider_type"],
            "sys_cluster_alerts": "private/support/alerts",
            "vserver_info": "svm/svms",
            "vserver_peer_info": "svm/peers",
            "vserver_nfs_info": "protocols/nfs/services",
            "volume_info": "storage/volumes",
            "volume_space_info": ["storage/volumes", 'space.logical_space.available,space.logical_space.used,'
                                                     'space.logical_space.used_percent,space.snapshot.reserve_size,'
                                                     'space.snapshot.reserve_percent,space.used,name,svm.name'],
            "vscan_connection_status_all_info": "protocols/vscan/server-status",
            "vscan_info": "protocols/vscan",
            "vscan_status_info": "protocols/vscan"
        }
        # Add rest API names as there info version, also make sure we don't add a duplicate
        subsets = []
        for subset in self.parameters['gather_subset']:
            if subset in info_to_rest_mapping:
                if info_to_rest_mapping[subset] not in subsets:
                    subsets.append(info_to_rest_mapping[subset])
            elif subset not in subsets:
                subsets.append(subset)
        return subsets

    def get_ontap_subset_info_all(self, subset, default_fields, get_ontap_subset_info):
        """ Iteratively get all records for a subset """
        try:
            # Verify whether the supported subset passed
            specified_subset = get_ontap_subset_info[subset]
        except KeyError:
            self.module.fail_json(msg="Specified subset %s is not found, supported subsets are %s" %
                                  (subset, list(get_ontap_subset_info.keys())))
        if 'api_call' not in specified_subset:
            specified_subset['api_call'] = subset
        subset_info = self.get_subset_info(specified_subset, default_fields)

        if subset_info is not None and isinstance(subset_info, dict) and '_links' in subset_info:
            while subset_info['_links'].get('next'):
                # Get all the set of records if next link found in subset_info for the specified subset
                next_api = subset_info['_links']['next']['href']
                gathered_subset_info = self.get_next_records(next_api.replace('/api', ''))

                # Update the subset info for the specified subset
                subset_info['_links'] = gathered_subset_info['_links']
                subset_info['records'].extend(gathered_subset_info['records'])

            # metrocluster doesn't have a records field, so we need to skip this
            if subset_info.get('records') is not None:
                # Getting total number of records
                subset_info['num_records'] = len(subset_info['records'])
        if subset == 'private/cli/vserver/security/file-directory':
            subset_info = self.strip_dacls(subset_info)

        return subset_info

    def apply(self):
        """
        Perform pre-checks, call functions and exit
        """
        # Validating ONTAP version
        self.validate_ontap_version()

        # Defining gather_subset and appropriate api_call
        get_ontap_subset_info = {
            'application/applications': {},
            'application/consistency-groups': {},
            'application/templates': {},
            'cloud/targets': {},
            'cluster': {},
            'cluster/chassis': {},
            'cluster/fireware/history': {},
            'cluster/jobs': {},
            'cluster/licensing/licenses': {},
            'cluster/mediators': {},
            'cluster/metrocluster': {},
            'cluster/metrocluster/diagnostics': {
                'post': True
            },
            'cluster/metrocluster/dr-groups': {},
            'cluster/metrocluster/interconnects': {},
            'cluster/metrocluster/nodes': {},
            'cluster/metrocluster/operations': {},
            'cluster/metrics': {},
            'cluster/nodes': {},
            'cluster/ntp/keys': {},
            'cluster/ntp/servers': {},
            'cluster/peers': {},
            'cluster/schedules': {},
            'cluster/software': {},
            'cluster/software/download': {},
            'cluster/software/history': {},
            'cluster/software/packages': {},
            'cluster/web': {},
            'name-services/dns': {},
            'name-services/ldap': {},
            'name-services/local-hosts': {},
            'name-services/name-mappings': {},
            'name-services/nis': {},
            'name-services/unix-groups': {},
            'name-services/unix-users': {},
            'network/ethernet/broadcast-domains': {},
            'network/ethernet/ports': {},
            'network/ethernet/switch/ports': {},
            'network/fc/logins': {},
            'network/fc/ports': {},
            'network/fc/wwpn-aliases': {},
            'network/http-proxy': {},
            'network/ip/bgp/peer-groups': {},
            'network/ip/interfaces': {},
            'network/ip/routes': {},
            'network/ip/service-policies': {},
            'network/ipspaces': {},
            'network/ethernet/switches': {},
            'private/support/alerts': {},
            'protocols/audit': {},
            'protocols/cifs/domains': {},
            'protocols/cifs/home-directory/search-paths': {},
            'protocols/cifs/local-groups': {},
            'protocols/cifs/local-users': {},
            'protocols/cifs/services': {},
            'protocols/cifs/sessions': {},
            'protocols/cifs/shares': {},
            'protocols/cifs/users-and-groups/privileges': {},
            'protocols/cifs/unix-symlink-mapping': {},
            'protocols/file-access-tracing/events': {},
            'protocols/file-access-tracing/filters': {},
            'protocols/fpolicy': {},
            'protocols/locks': {},
            'protocols/ndmp': {},
            'protocols/ndmp/nodes': {},
            'protocols/ndmp/sessions': {},
            'protocols/ndmp/svms': {},
            'protocols/nfs/connected-clients': {},
            'protocols/nfs/export-policies': {},
            'protocols/nfs/kerberos/interfaces': {},
            'protocols/nfs/kerberos/realms': {},
            'protocols/nfs/services': {},
            'protocols/nvme/interfaces': {},
            'protocols/nvme/services': {},
            'protocols/nvme/subsystems': {},
            'protocols/nvme/subsystem-controllers': {},
            'protocols/nvme/subsystem-maps': {},
            'protocols/s3/buckets': {},
            'protocols/s3/services': {},
            'protocols/san/fcp/services': {},
            'protocols/san/igroups': {},
            'protocols/san/iscsi/credentials': {},
            'protocols/san/iscsi/services': {},
            'protocols/san/iscsi/sessions': {},
            'protocols/san/lun-maps': {},
            'protocols/san/portsets': {},
            'protocols/san/vvol-bindings': {},
            'protocols/vscan/server-status': {},
            'protocols/vscan': {},
            'security/accounts': {},
            'security/anti-ransomware/suspects': {},
            'security/audit': {},
            'security/audit/destinations': {},
            'security/audit/messages': {},
            'security/authentication/cluster/ad-proxy': {},
            'security/authentication/cluster/ldap': {},
            'security/authentication/cluster/nis': {},
            'security/authentication/cluster/saml-sp': {},
            'security/authentication/publickeys': {},
            'security/azure-key-vaults': {},
            'security/certificates': {},
            'security/gcp-kms': {},
            'security/ipsec': {},
            'security/ipsec/ca-certificates': {},
            'security/ipsec/policies': {},
            'security/ipsec/security-associations': {},
            'security/key-manager-configs': {},
            'security/key-managers': {},
            'security/key-stores': {},
            'security/login/messages': {},
            'security/roles': {},
            'security/ssh': {},
            'security/ssh/svms': {},
            'snapmirror/policies': {},
            'snapmirror/relationships': {},
            'storage/aggregates': {},
            'storage/bridges': {},
            'storage/cluster': {},
            'storage/disks': {},
            'storage/file/clone/split-loads': {},
            'storage/file/clone/split-status': {},
            'storage/file/clone/tokens': {},
            'storage/flexcache/flexcaches': {},
            'storage/flexcache/origins': {},
            'storage/luns': {},
            'storage/monitored-files': {},
            'storage/namespaces': {},
            'storage/ports': {},
            'storage/qos/policies': {},
            'storage/qos/workloads': {},
            'storage/qtrees': {},
            'storage/quota/reports': {},
            'storage/quota/rules': {},
            'storage/shelves': {},
            'storage/snaplock/audit-logs': {},
            'storage/snaplock/compliance-clocks': {},
            'storage/snaplock/event-retention/operations': {},
            'storage/snaplock/event-retention/policies': {},
            'storage/snaplock/file-fingerprints': {},
            'storage/snaplock/litigations': {},
            'storage/snapshot-policies': {},
            'storage/switches': {},
            'storage/tape-devices': {},
            'storage/volumes': {},
            'storage/volume-efficiency-policies': {},
            'support/autosupport': {},
            'support/autosupport/check': {
                'api_call': '/private/cli/system/node/autosupport/check/details' + self.private_cli_fields('support/autosupport/check'),
            },
            'support/autosupport/messages': {},
            'support/auto-update': {},
            'support/auto-update/configurations': {},
            'support/auto-update/updates': {},
            'support/configuration-backup': {},
            'support/configuration-backup/backups': {},
            'support/coredump/coredumps': {},
            'support/ems': {},
            'support/ems/destinations': {},
            'support/ems/events': {},
            'support/ems/filters': {},
            'support/ems/messages': {},
            'support/snmp': {},
            'support/snmp/traphosts': {},
            'support/snmp/users': {},
            'svm/migrations': {},
            'svm/peers': {},
            'svm/peer-permissions': {},
            'svm/svms': {}
        }
        if 'gather_subset' in self.parameters and (
                'private/cli/vserver/security/file-directory' in self.parameters['gather_subset']
                or 'file_directory_security' in self.parameters['gather_subset']
        ):
            get_ontap_subset_info['private/cli/vserver/security/file-directory'] = {
                'api_call': 'private/cli/vserver/security/file-directory' + self.private_cli_fields('private/cli/vserver/security/file-directory')}
        if 'all' in self.parameters['gather_subset']:
            # If all in subset list, get the information of all subsets
            self.parameters['gather_subset'] = sorted(get_ontap_subset_info.keys())
        if 'demo' in self.parameters['gather_subset']:
            self.parameters['gather_subset'] = ['cluster/software', 'svm/svms', 'cluster/nodes']
        get_ontap_subset_info = self.add_uuid_subsets(get_ontap_subset_info)

        length_of_subsets = len(self.parameters['gather_subset'])

        if self.parameters.get('fields') is not None:
            # If multiple fields specified to return, convert list to string
            self.fields = ','.join(self.parameters.get('fields'))

            if self.fields != '*' and length_of_subsets > 1:
                # Restrict gather subsets to one subset if fields section is list_of_fields
                self.module.fail_json(msg="Error: fields: %s, only one subset will be allowed." % self.parameters.get('fields'))
        converted_subsets = self.convert_subsets()

        result_message = {}
        for subset in converted_subsets:
            subset, default_fields = subset if isinstance(subset, list) else (subset, None)
            result_message[subset] = self.get_ontap_subset_info_all(subset, default_fields, get_ontap_subset_info)

        results = {'changed': False}
        if self.parameters.get('state') is not None:
            results['state'] = self.parameters['state']
            results['warnings'] = "option 'state' is deprecated."
        if self.parameters['use_python_keys']:
            new_dict = dict((key.replace('/', '_'), value) for (key, value) in result_message.items())
            new_dict = dict((key.replace('-', '_'), value) for (key, value) in new_dict.items())
            result_message = new_dict
        self.module.exit_json(ontap_info=result_message, **results)

    def add_uuid_subsets(self, get_ontap_subset_info):
        params = self.parameters.get('owning_resource')
        if 'gather_subset' in self.parameters:
            if 'storage/volumes/snapshots' in self.parameters['gather_subset']:
                self.check_error_values('storage/volumes/snapshots', params, ['volume_name', 'svm_name'])
                record = self.get_volume_uuid()
                if record:
                    get_ontap_subset_info['storage/volumes/snapshots'] = {
                        'api_call': 'storage/volumes/%s/snapshots' % record.get('uuid'),
                    }
            if 'protocols/nfs/export-policies/rules' in self.parameters['gather_subset']:
                self.check_error_values('protocols/nfs/export-policies/rules', params, ['policy_name', 'svm_name', 'rule_index'])
                record = self.get_export_policy_id()
                if record:
                    get_ontap_subset_info['protocols/nfs/export-policies/rules'] = {
                        'api_call': 'protocols/nfs/export-policies/%s/rules/%s' % (record.get('id'), self.parameters['owning_resource']['rule_index']),
                    }
        return get_ontap_subset_info

    def get_volume_uuid(self):
        api = 'storage/volumes'
        query = {'name': self.parameters['owning_resource']['volume_name'],
                 'svm.name': self.parameters['owning_resource']['svm_name']}
        record, error = rest_generic.get_one_record(self.rest_api, api, query)
        if error:
            self.module.fail_json(
                msg='Could not find volume %s on SVM %s' % (self.parameters['owning_resource']['volume_name'],
                                                            self.parameters['owning_resource']['svm_name']))
        if record:
            return record
        return None

    def get_export_policy_id(self):
        api = 'protocols/nfs/export-policies'
        query = {'name': self.parameters['owning_resource']['policy_name'],
                 'svm.name': self.parameters['owning_resource']['svm_name']}
        record, error = rest_generic.get_one_record(self.rest_api, api, query)
        if error:
            self.module.fail_json(
                msg='Could not find export policy %s on SVM %s' % (self.parameters['owning_resource']['policy_name'],
                                                                   self.parameters['owning_resource']['svm_name']))
        if record:
            return record
        return None

    def check_error_values(self, api, params, items):
        error = not params or sorted(list(params.keys())) != sorted(items)
        if error:
            self.module.fail_json(msg="Error: %s are required for %s" % (', '.join(items), api))


def main():
    """
    Main function
    """
    obj = NetAppONTAPGatherInfo()
    obj.apply()


if __name__ == '__main__':
    main()