FileMgr

✏️ /usr/lib/python3.9/site-packages/ansible_collections/wti/remote/plugins/lookup/cpm_config_backup.py

✕ Tutup

# -*- coding: utf-8 -*-
#
# (C) 2019 Red Hat Inc.
# Copyright (C) 2020 Western Telematic Inc.
#
# GNU General Public License v3.0+
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Module to retrieve WTI Parameters from WTI OOB and PDU devices.
# CPM remote_management
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type

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

DOCUMENTATION = """
---
module: cpm_config_backup
version_added: "2.9.0"
author: "Western Telematic Inc. (@wtinetworkgear)"
short_description: Get parameters from WTI OOB and PDU devices
description:
    - "Get parameters from WTI OOB and PDU devices"
options:
    cpm_url:
        description:
            - This is the URL of the WTI device to get the parameters from.
        type: str
        required: true
    cpm_username:
        description:
            - This is the Username of the WTI device to get the parameters from.
        type: str
        required: true
    cpm_password:
        description:
            - This is the Password of the WTI device to get the parameters from.
        type: str
        required: true
    cpm_path:
        description:
            - This is the directory path to store the WTI device configuration file.
        type: str
        required: false
        default: "/tmp/"
    use_https:
        description:
            - Designates to use an https connection or http connection.
        type: bool
        required: false
        default: true
    validate_certs:
        description:
            - If false, SSL certificates will not be validated. This should only be used
            - on personally controlled sites using self-signed certificates.
        type: bool
        required: false
        default: true
    use_proxy:
        description: Flag to control if the lookup will observe HTTP proxy environment variables when present.
        type: bool
        required: false
        default: false
notes:
  - Use C(groups/cpm) in C(module_defaults) to set common options used between CPM modules.)
"""

EXAMPLES = """
-   name: Get the Parameters for a WTI device
    cpm_config_backup:
        cpm_url: "nonexist.wti.com"
        cpm_username: "super"
        cpm_password: "super"
        use_https: true
        validate_certs: false
"""

RETURN = """
data:
  description: The XML configuration of the WTI device queried
  returned: always
  type: complex
  contains:
    status:
      description: List of status returns from backup operation
      returned: success
      type: list
      sample:
        - code: 0
          savedfilename: "/tmp/wti-192-10-10-239-2020-02-13T16-05-57.xml"
          text: "ok"
"""

import base64
import json
import datetime

from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_text, to_bytes, to_native
from ansible.module_utils.six.moves.urllib.error import HTTPError, URLError
from ansible.module_utils.urls import open_url, ConnectionError, SSLValidationError

def get_unit_type(filedata):
    beginsearch = filedata.find("unit_type_info=\"")
    beginsearch = (beginsearch + 16)
    endsearch = filedata.find("\">", beginsearch)
    if (((endsearch == -1) | (beginsearch == -1)) | (endsearch < beginsearch) | ((endsearch - beginsearch) > 16)):
        header = "wti"
    else:
        header = filedata[beginsearch:beginsearch + (endsearch - beginsearch)]
    return (header)

def normalize_string(filedata):
    filedata = filedata.replace(":", "-")
    filedata = filedata.replace(".", "-")
    return (filedata)

def run_module():
    # define the available arguments/parameters that a user can pass to
    # the module
    module_args = dict(
        cpm_url=dict(type='str', required=True),
        cpm_username=dict(type='str', required=True),
        cpm_password=dict(type='str', required=True, no_log=True),
        cpm_path=dict(type='str', default="/tmp/"),
        use_https=dict(type='bool', default=True),
        validate_certs=dict(type='bool', default=True),
        use_proxy=dict(type='bool', default=False)
    )

result = dict(
        changed=False,
        data=''
    )

module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)

auth = to_text(base64.b64encode(to_bytes('{0}:{1}'.format(to_native(module.params['cpm_username']), to_native(module.params['cpm_password'])),
                   errors='surrogate_or_strict')))

if module.params['use_https'] is True:
        protocol = "https://"
    else:
        protocol = "http://"

fullurl = ("%s%s/cgi-bin/gethtml?formWTIDownloadConfigXML.html" % (protocol, to_native(module.params['cpm_url'])))

try:
        response = open_url(fullurl, data=None, method='GET', validate_certs=module.params['validate_certs'], use_proxy=module.params['use_proxy'],
                            headers={'Content-Type': 'application/xml', 'Authorization': "Basic %s" % auth})

except HTTPError as e:
        fail_json = dict(msg='GET: Received HTTP error for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
        module.fail_json(**fail_json)
    except URLError as e:
        fail_json = dict(msg='GET: Failed lookup url for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
        module.fail_json(**fail_json)
    except SSLValidationError as e:
        fail_json = dict(msg='GET: Error validating the server''s certificate for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
        module.fail_json(**fail_json)
    except ConnectionError as e:
        fail_json = dict(msg='GET: Error connecting to {0} : {1}'.format(fullurl, to_native(e)), changed=False)
        module.fail_json(**fail_json)

json_string = response.read()

try:
        f = open(normalize_string(to_native(module.params['cpm_path'])) + get_unit_type(to_native(json_string)) + "-" + to_native(module.params['cpm_url']) +
                 "-" + datetime.datetime.now().replace(microsecond=0).isoformat() + ".xml", "wb")
        f.write(json_string)
        f.close()
        json_string = '{\"status\": { \"code\": \"0\", \"text\": \"ok\", \"savedfilename\": \"%s%s-%s-%s.xml\"  }}' \
                      % (normalize_string(to_native(module.params['cpm_path'])), get_unit_type(to_native(json_string)),
                         to_native(module.params['cpm_url']), datetime.datetime.now().replace(microsecond=0).isoformat())

except Exception as e:
        json_string = "{\"status\": { \"code\": \"1\", \"text\": \"error: " + str(e) + "\", \"savedfilename\": \"\"  }}"

result['data'] = json_string

module.exit_json(**result)

def main():
    run_module()

if __name__ == '__main__':
    main()

Batal

⬅ plugins 33 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 cpm_alarm_info.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_config_backup.py	py	6.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_config_restore.py	py	6.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_current_info.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_firmware_info.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_firmware_update.py	py	13.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_hostname_config.py	py	10 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_hostname_info.py	py	5.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_interface_config.py	py	19.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_interface_info.py	py	7.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_iptables_config.py	py	10.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_iptables_info.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_metering.py	py	6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_plugconfig.py	py	9.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_plugcontrol.py	py	7.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_power_info.py	py	8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_serial_port_action_info.py	py	6.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_serial_port_action_set.py	py	9.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_serial_port_config.py	py	14.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_serial_port_info.py	py	6.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_snmp_config.py	py	22.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_snmp_info.py	py	6.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_status.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_status_info.py	py	10.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_syslog_client_config.py	py	15.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_syslog_client_info.py	py	7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_syslog_server_config.py	py	14.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_syslog_server_info.py	py	6.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_temp_info.py	py	6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_time_config.py	py	15.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_time_info.py	py	6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 cpm_user.py	py	13.1 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission