-
Notifications
You must be signed in to change notification settings - Fork 49
/
get_power_manager_policies.py
220 lines (187 loc) · 11.2 KB
/
get_power_manager_policies.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
#
# _author_ = Mahendran P <Mahendran_P@Dell.com>
#
#
# 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 Power Manager policies created for either Devices/Groups with optional filters
#### Description
This script exercises the Power Manager REST API to get different Power Manager Polcies created on devices or groups.
- For authentication X-Auth is used over Basic Authentication
- Note that the credentials entered are not stored to disk.
#### Python Example
python get_power_manager_policies.py --ip <xx> --username <username> --password <pwd> --filterBy <filter_name> --filterValue <filter_value>
Output:
==================================
Power Manager Policies
==================================
POLICY_ID POLICY_NAME POLICY_TYPE POLICY_ENABLED POLICY_EXECUTION_STATE IS_POLICY_ON_GROUP/DEVICE? GROUP/DEVICE_ASSIGNED_TO CREATED_TIME
9 Temperature Triggered for groups TEMPERATURE-TRIGGERED True NOSTATE Group G1_PMP1.0 2020-03-22 13:00:30.520681
6 Policy3 STATIC True NOSTATE Device 47XGH32 2020-03-18 11:17:44.340717
5 Policy2 STATIC True SUCCESS Device 47XGH32 2020-03-18 11:09:29.710303
4 Policy1 STATIC True SUCCESS Device 47XGH32 2020-03-18 11:02:20.585298
"""
# Import the modules required for this script
import argparse
import json
import sys
from argparse import RawTextHelpFormatter
# Import the modules required for this script
from requests.packages.urllib3.exceptions import InsecureRequestWarning
try:
import urllib3
import requests
from columnar import columnar
except ModuleNotFoundError:
print("This program requires urllib3, requests, and columnar. To install them on most systems run "
"`pip install requests urllib3`")
sys.exit(0)
from requests.packages.urllib3.exceptions import InsecureRequestWarning
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
# Policy Type dictonary to display the output for better reading
policy_type_dictionary = {
1: "STATIC",
2: "TEMPERATURE-TRIGGERED"}
# Policy Execution State dictonary to display the output for better reading
policy_execution_state_dictionary = {
1: "NOSTATE",
2: "EXECUTING",
3: "SUCCESS",
4: "PARTIAL_SUCCESS",
5: "FAILED"}
# IsAssociatedToGroup dictonary to display the output for better reading
IsAssociatedToGroup_dictionary = {
"True": "Group",
"False": "Device"}
def get_power_manager_policies(ip_address, user_name, password, filterBY, filterValue):
""" Authenticate with OpenManage Enterprise, get power manager policies"""
try:
# Defining Session URL & its headers
session_url = 'https://%s/api/SessionService/Sessions' % ip_address
headers = {'content-type': 'application/json'}
# Define Payload for posting session API
user_details = {'UserName': user_name,
'Password': password,
'SessionType': 'API'}
# Define the Policy URL basis the filter existance & type
if filterBY and filterValue:
if filterBY in ('Enabled', 'Type'):
policies_url = "https://%s/api/PowerService/Policies?$filter=%s eq %s" % (
ip_address, filterBY, filterValue)
else:
policies_url = "https://%s/api/PowerService/Policies?$filter=contains(%s,'%s')" % (
ip_address, filterBY, filterValue)
else:
policies_url = "https://%s/api/PowerService/Policies" % ip_address
# Defining OUTPUT format
output_column_headers = ['Policy_ID', 'Policy_Name', 'Policy_Type', 'Policy_Enabled', "Policy_Execution_State",
"Is_Policy_on_Group/Device?", "Group/Device_Assigned_To", "Created_Time"]
output_column_data = []
# Create the session with OpenManage Enterprise
session_info = requests.post(session_url, verify=False,
data=json.dumps(user_details),
headers=headers)
# If session doesn't create, message the user with error
if session_info.status_code != 201 & session_info.status_code != 200:
session_json_data = session_info.json()
if 'error' in session_json_data:
error_content = session_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to create a session with %s" % ip_address)
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to create a session with %s. See below ExtendedInfo for more information" % ip_address)
print(extended_error_content[0]['Message'])
else:
print("Unable to create a session with %s. Please try again later" % ip_address)
else:
headers['X-Auth-Token'] = session_info.headers['X-Auth-Token']
# Get Power Manager Policies API call with OpenManage Enterprise
policies_response = requests.get(policies_url, headers=headers, verify=False)
policies_json_data = policies_response.json()
# If policies API doesn't respond or failed, message the user with error
if policies_response.status_code != 201 & policies_response.status_code != 200:
if 'error' in policies_json_data:
error_content = policies_json_data['error']
if '@Message.ExtendedInfo' not in error_content:
print("Unable to retrieve Power Manager policies from %s" % ip_address)
else:
extended_error_content = error_content['@Message.ExtendedInfo']
print(
"Unable to retrieve Power Manager policies from %s. See below ExtendedInfo for more information" % ip_address)
print(extended_error_content[0]['Message'])
else:
print("Unable to retrieve Power Manager policies from %s" % ip_address)
else:
policies_count = policies_json_data['@odata.count']
# If the policies count is 0, then error out immediately
if policies_count <= 0:
print("No Power Manager Policies created in %s" % ip_address)
else:
policies_content = json.loads(policies_response.content)
if policies_content:
# For every elements in the policies response, store the details in the table
for policies_elem in policies_content["value"]:
policies_data = [policies_elem["PolicyId"], policies_elem["Name"],
policy_type_dictionary[int(policies_elem["Type"])],
policies_elem["Enabled"],
policy_execution_state_dictionary[int(policies_elem["ExecutionState"])],
IsAssociatedToGroup_dictionary[str(policies_elem["IsAssociatedToGroup"])],
policies_elem["AssignedTo"], policies_elem["CreatedTime"]]
output_column_data.append(policies_data)
table = columnar(output_column_data, output_column_headers, no_borders=True)
print("\n ==================================")
print(" Power Manager Policies ")
print(" ==================================")
print(table)
else:
print("No Power Manager Policies created in %s" % ip_address)
except Exception as error:
print("Unexpected error:", str(error))
if __name__ == '__main__':
parser = argparse.ArgumentParser(description=__doc__, formatter_class=RawTextHelpFormatter)
parser.add_argument("--ip", "-i", required=True, help="OpenManage Enterprise IP <- Mandatory")
parser.add_argument("--username", "-u", required=False,
help="Username for OpenManage Enterprise <- Optional; default = admin", default="admin")
parser.add_argument("--password", "-p", required=True, help="Password for OpenManage Enterprise <- Mandatory")
parser.add_argument("--filterBy", "-b", required=False, help=''' Applicable Filters are:
Name - Name of the policy
Enabled - Policy Enabled state
AssignedTo - Device service tag or Group Name
Type - Policy Type
''', default=None)
parser.add_argument("--filterValue", "-v", required=False, help=''' Input value for filtersBy:
Name - Sting Value
Enabled - true or false
AssignedTo - String Value
Type - 1-Static; 2-Temperature-Triggered
''', default=None)
args = parser.parse_args()
print("WARNING: THIS SCRIPT IS EXPERIMENTAL.")
print("The Power Manager scripts were originally internal Dell scripts we then published externally. If you see "
"this message and are using one of these scripts it would be very helpful if you open an issue on GitHub "
"at https://github.com/dell/OpenManage-Enterprise/issues and tell us you are using the script. We have not "
"dedicated any resources to optimizing them but are happy to do so if we know the community is using them. "
"Likewise if you find a bug in one of these scripts feel free to open an issue and we will investigate.")
get_power_manager_policies(args.ip, args.username, args.password, args.filterBy, args.filterValue)
print("WARNING: THIS SCRIPT IS EXPERIMENTAL.")
print("The Power Manager scripts were originally internal Dell scripts we then published externally. If you see "
"this message and are using one of these scripts it would be very helpful if you open an issue on GitHub "
"at https://github.com/dell/OpenManage-Enterprise/issues and tell us you are using the script. We have not "
"dedicated any resources to optimizing them but are happy to do so if we know the community is using them. "
"Likewise if you find a bug in one of these scripts feel free to open an issue and we will investigate.")