OpenManage-Enterprise/Python/find_non_power_policy_capable_devices.py at main · PeterDaveHelloKitchen/OpenManage-Enterprise · GitHub

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
#
# 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 Find devices which are not capable for power policy,
including servers which are not capable for power monitoring too.

#### Description
This script gets all devices where a power policy cannot be applied from power manager.

Note:
1. Credentials entered are not stored to disk.
2. For a large number of devices ,time taken for script to finish might increase ,also depending on network speed. (upto 6-7 minutes for 8000 devices at 100Mbps network )
3. This script doesn't need OMEnt-Power manager to be already installed on the OMEnt and works with or without OMEnt-Power manager
4:User executing the script should have privilege to cerate a new file in the path where script is located.

API workflow is below:
1. POST on SessionService/Sessions
2. If new session is created (201) parse headers for x-auth token and update headers with token
3. All subsequent requests use X-auth token and not user name and password entered by user
4. From All devices list fetch for the servers not having both 1105(policy capability) and 1006 (monitoring capability)  devicecapability bit set.
5. For Chassis type devices check for only 1105 bit as chassis are always monitoring capable and do not have 1006 in devicecapabilities
5. Print all such devices(deviceId and ServiceTag) into a csv file Non_compatible_policy_devices.csv

#### Python Example
    Finds all non-policy power capable  devices
    python find_non_power_policy_capable_devices.py --ip <ip addr> --user root --password <passwd>

"""

import argparse
import csv
import json
from argparse import RawTextHelpFormatter

import requests
import urllib3

urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)


def get_non_policy_capable_devices(ip_address, user_name, password):
    """ Authenticate with OME and enumerate groups """
    try:
        AllDeviceIDs = []
        session_url = 'https://%s/api/SessionService/Sessions' % ip_address
        dev_url = "https://%s/api/DeviceService/Devices?$top=8000" % ip_address
        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 or session_info.status_code == 200:
            headers['X-Auth-Token'] = session_info.headers['X-Auth-Token']
            response2 = requests.get(dev_url, headers=headers, verify=False)
            if response2.status_code == (200 or 201):
                json_obj1 = json.loads(response2.content)
                for ele in json_obj1["value"]:
                    AllDeviceIDs.append(ele["Id"])
                with open('Non_compatible_policy_devices.csv', 'w', newline='') as file:
                    writer = csv.writer(file, )
                    writer.writerow(["DeviceID", "Service Tag"])
                    for i in range(0, len(AllDeviceIDs)):
                        # if not a chassis check for both OMEAdv and iDRAC Ent License(device without OMEAdv license will always be non policy capable since it can't be added to working set)
                        if json_obj1['value'][i]["Type"] != 2000:
                            if ("1006" and "1105") not in str(json_obj1['value'][i]["DeviceCapabilities"]):
                                writer.writerow(
                                    [json_obj1['value'][i]["Id"], json_obj1['value'][i]["DeviceServiceTag"]])
                        else:
                            # if chassis check only for policy bit, since no license is needed to add to working set
                            if "1105" not in str(json_obj1['value'][i]["DeviceCapabilities"]):
                                writer.writerow(
                                    [json_obj1['value'][i]["Id"], json_obj1['value'][i]["DeviceServiceTag"]])
    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=True,
                        help="Username for OME Appliance", default="admin")
    parser.add_argument("--password", "-p", required=True,
                        help="Password for OME Appliance")
    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_non_policy_capable_devices(args.ip, args.user, args.password)

    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.")