-
Notifications
You must be signed in to change notification settings - Fork 49
/
get_report_list.py
112 lines (101 loc) · 4.78 KB
/
get_report_list.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#
# _author_ = Raajeev Kalyanaraman <[email protected]>
#
# Copyright (c) 2022 Dell EMC Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""
#### Synopsis
Script to get the list of reports defined in OM Enterprise
#### Description
This script uses the OME REST API to get a list of reports
currently defined in that instance. For authentication X-Auth
is used over Basic Authentication
Note that the credentials entered are not stored to disk.
#### Python Example
`python get_report_list.py --ip <xx> --user <username> --password <pwd>`
"""
import argparse
import json
import sys
from argparse import RawTextHelpFormatter
from getpass import getpass
import requests
import urllib3
def get_report_list(ip_address, user_name, password):
""" Authenticate with OME and enumerate reports """
try:
base_uri = 'https://%s' % ip_address
session_url = base_uri + '/api/SessionService/Sessions'
report_svc = base_uri + '/api/ReportService/ReportDefs'
next_link_url = None
headers = {'content-type': 'application/json'}
user_details = {'UserName': user_name,
'Password': password,
'SessionType': 'API'}
session_info = requests.post(session_url, verify=False,
data=json.dumps(user_details),
headers=headers)
if session_info.status_code == 201:
headers['X-Auth-Token'] = session_info.headers['X-Auth-Token']
report_response = requests.get(report_svc, headers=headers, verify=False)
if report_response.status_code == 200:
report_info = report_response.json()
total_reports = report_info['@odata.count']
if total_reports > 0:
if '@odata.nextLink' in report_info:
next_link_url = base_uri + report_info['@odata.nextLink']
while next_link_url:
next_link_response = requests.get(next_link_url, headers=headers, verify=False)
if next_link_response.status_code == 200:
next_link_json_data = next_link_response.json()
report_info['value'] += next_link_json_data['value']
if '@odata.nextLink' in next_link_json_data:
next_link_url = base_uri + next_link_json_data['@odata.nextLink']
else:
next_link_url = None
else:
print("Unable to retrieve device list from nextLink %s" % next_link_url)
next_link_url = None
print("*** List of pre-defined reports ***")
print(json.dumps(report_info, indent=4, sort_keys=True))
else:
print("No pre-defined reports found on %s" % ip_address)
else:
print("Unable to retrieve reports from %s" % ip_address)
else:
print("Unable to create a session with appliance %s" % ip_address)
except Exception as error:
print("Unexpected error:", str(error))
if __name__ == '__main__':
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
parser.add_argument("--ip", "-i", required=True, help="OME Appliance IP")
parser.add_argument("--user", "-u", required=False,
help="Username for OME Appliance", default="admin")
parser.add_argument("--password", "-p", required=False,
help="Password for OME Appliance")
args = parser.parse_args()
if not args.password:
if not sys.stdin.isatty():
# notify user that they have a bad terminal
# perhaps if os.name == 'nt': , prompt them to use winpty?
print("Your terminal is not compatible with Python's getpass module. You will need to provide the"
" --password argument instead. See https://stackoverflow.com/a/58277159/4427375")
sys.exit(0)
else:
password = getpass()
else:
password = args.password
get_report_list(args.ip, args.user, password)