Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms

Transcription

1 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Dell Engineering July 2017 A Dell Technical White Paper

2 Revisions Date June 2017 Description Initial release The information in this publication is provided as is. Dell Inc. makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any software described in this publication requires an applicable software license. Copyright 2017 Dell Inc. or its subsidiaries. All Rights Reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property of their respective owners. Published in the USA [8/2/2017] Dell believes the information in this document is accurate as of its publication date. The information is subject to change without notice.

3 Table of contents Revisions... 2 Executive summary Introduction WSMAN clients WinRM CLI OpenWSMAN CLI Scripting WSMAN clients using Python Graphical representation of the environment Common APIs Detect Host Operating System Construct WSMAN CLI commands Enumerate Launch WSMAN CLI command Ping test Custom management scripts for Dell Command Monitor Listing BIOS settings Checking if a BIOS password is set Getting the first power-on date, manufacturing date, model, service-tag Getting the System Summary Getting the property ownership tag details Getting the boot order Important Notes Where to Find More Information Summary Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

4 Executive summary Dell Command Monitor is an in-band management tool within the Dell Command suite of products that are provided without any fee to Dell client commercial customers. This white paper describes the process of creating common custom Python scripts for running Dell Command Monitor on Windows and Linux target systems. Information provided in this white paper is relevant for System administrators who want to program scripts with WSMAN clients and harness the power of the secure and standards-based WSMAN service. 4 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

5 1 Introduction Dell Command Monitor allows the use of secure, simple, scriptable, and standards-based remote management capability through Web Services for Management (WSMAN) to manage and monitor Dell commercial client systems. WSMAN is a management transport protocol that enables access to systems management data objects and methods that are supported by target system. You can use the WSMAN interface by scripting WSMAN using command-line tools such as WinRM on Windows, and wsmancli on Linux. WSMAN can be accessed from scripting languages such as Python, which can run on both Windows and Linux operating systems. This white paper provides information that enables you to: Get started on programmatically scripting with WSMAN using Python Learn common APIs to leverage in your Dell Command Monitor custom scripts to get various BIOS settings Note: You may need to read the specifications documents to understand the terminology and concept in this white paper. 5 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

6 2 WSMAN clients There are two primary WSMAN clients described in this document: Windows Remote Management (WinRM) CLI for Windows OpenWSMAN CLI for Linux Both WSMAN clients are equivalent in most of their feature sets. They allow usage of most of the frequent and high usage WSMAN operations. Refer the WinRM and OpenWSMAN CLI sections for sample output of command-line tool s help menu. You can find more information on installation and usage of these CLI tools in the Where to Find More Information section. 2.1 WinRM CLI Sample output of WinRM CLI invocation C:\>winrm Windows Remote Management Command Line Tool Windows Remote Management (WinRM) is the Microsoft implementation of the WS-Management protocol which provides a secure way to communicate with local and remote computers using web services. Usage: winrm OPERATION RESOURCE_URI [-SWITCH:VALUE [-SWITCH:VALUE]...] [@{KEY=VALUE[;KEY=VALUE]...}] For help on a specific operation: winrm g[et] -? Retrieving management information. winrm s[et] -? Modifying management information. winrm c[reate] -? Creating new instances of management resources. winrm d[elete] -? Remove an instance of a management resource. winrm e[numerate] -? List all instances of a management resource. winrm i[nvoke] -? Executes a method on a management resource. winrm id[entify] -? Determines if a WS-Management implementation is running on the remote machine. winrm quickconfig -? Configures this machine to accept WS-Management requests from other machines. winrm configsddl -? Modify an existing security descriptor for a URI. winrm helpmsg -? Displays error message for the error code. For help on related topics: winrm help uris How to construct resource URIs. winrm help aliases Abbreviations for URIs. winrm help config Configuring WinRM client and service settings. winrm help certmapping Configuring client certificate access. winrm help remoting How to access remote machines. winrm help auth Providing credentials for remote access. winrm help input Providing input to create, set, and invoke. winrm help switches Other switches such as formatting, options, etc. winrm help proxy Providing proxy information. 6 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

7 2.2 OpenWSMAN CLI Sample output of OpenWSMAN CLI invocation ~]# wsman -? Usage: wsman [Option...] <action> <Resource Uri> Help Options -?, --help --help-all Show help options --help-enumeration Enumeration Options --help-tests Test Cases --help-cim CIM Options --help-flags Request Flags --help-event Subscription Options Application Options -d, --debug=1-6 Set the verbosity of debugging output. -j, --encoding Set request message encoding -c, --cacert=<filename> Certificate file to verify the peer -A, --cert=<filename> Certificate file. The certificate must be in PEM format. -K, --sslkey=<key> SSL Key. -u, --username=<username> User name -g, --path=<path> Service Path (default: 'wsman') -J, --input=<filename> File with resource for Create and Put operations in XML, can be a SOAP envelope -p, --password=<password> User Password -h, --hostname=<hostname> Host name -b, --endpoint=<url> End point -P, --port=<port> Server Port -X, --proxy=<proxy> Proxy name -Y, --proxyauth=<proxyauth> Proxy user:pwd -y, --auth=<basic digest gss> Authentication Method -a, --method=<custom method> Method (Works only with 'invoke') -k, --prop=<key=val> Properties with key value pairs (For 'put', 'invoke' and 'create') -C, --config-file=<file> Alternate configuration file -O, --out-file=<file> Write output to file -V, --noverifypeer Not to verify peer certificate -v, --noverifyhost Not to verify hostname -I, --transport-timeout=<time in sec> Transport timeout in seconds 7 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

8 3 Scripting WSMAN clients using Python Before you begin, ensure that Python version 2.7 is installed on your system. For more information, see the Python release website. Dell recommends Python version 2.7 to leverage many of the list and xml tree iteration features that you can use in processing WSMAN s CIM XML output format. 3.1 Graphical representation of the environment Figure 1 WSMAN over SSL Figure 1 provides a graphical representation of the environment. It starts with administrator using the management station to run scripts to send WSMAN commands through an SSL connection. The target system in this example is a Dell system where Dell Command Monitor is installed. 8 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

9 4 Common APIs While creating WSMAN scripts using Python, certain common usage patterns were observed. Based on this observation, common APIs were created for those patterns. Some of the common APIs that were created are as follows: Detect Host Operating System Construct WSMAN CLI command Launch WSMAN CLI command Ping test The following sections describe the APIs and outlines their use. These APIs are used in the common files that are available with the script packages posted on Dell TechCenter. Links to the respective resources are included in the Where to Find More Information section of this white paper. All the API examples have been developed using the Python programming language. 4.1 Detect Host Operating System The host operating system must be detected as a pre-step to constructing the applicable WSMAN CLI command. #Detect the Host Operating System def detect_host_os(): """ Common module that checks the OS type and returns appropriate value. This is to decide if either winrm or wsmancli must be used. """ import sys if sys.platform == "win32": return 1 else: return 2 The API returns 1 for Windows or 2 for Linux, depending on the host operating system. If the host OS is Windows, WinRM CLI commands has to be constructed. If the host OS is Linux, OpenWSMAN CLI commands has to be constructed. 4.2 Construct WSMAN CLI commands The following are the five WSMan operations that are commonly used: Enumerate Enumerate keys Get Set Invoke Having an API for each of these operations is important to enable custom WSMAN scripts creation. To construct the relevant WSMAN CLI commands, these APIs must detect the host operating system. The following sections describe the Python API required to only use the Enumerate WSMan operation. 9 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

10 4.2.1 Enumerate This API detects the host operating system and constructs the relevant WSMAN enumerate CLI command, using the input parameters provided. The input parameters for the API are class name, user name, password, and IP address. The constructed command can be directly launched on the command line or shell of the host operating system, using the API described in the Launch WSMAN CLI command section. #Enumeration def wsman_enumerate_command(classname, username, password, ipaddress): """ Constructs the WSMan Enumerate Operation command based on the OS and returns the command to be used. """ if detect_host_os() == 1: wsman_command = 'winrm e -u:%s -p:%s - r: -skipcacheck -skipcncheck' wsman_command = wsman_command % (classname, username, password, ipaddress) else: wsman_command = 'wsman enumerate -N root/dcim/sysman -u %s -p %s -h %s -P v -j utf-8 -y basic -o -m 256 -V -v' wsman_command = wsman_command % (classname, username, password,ipaddress) return wsman_command 4.3 Launch WSMAN CLI command After the relevant WSMAN CLI command is constructed, it must be launched on the command line or shell. This must be done to communicate with the remote WSMAN service. The subprocess python module is used for the communication. The response from the remote WSMAN service is stored in two strings stdout and stderr. After the response is returned from the API, stdout must be checked to use the output data. If it is empty, then an error may have occurred. The stderr string must be used to print the error. # launch the constructed WSMAN CLI command def wsman_command_launch(wsman_command): """ Executes the WSMan command on the shell (OS agnostic) and returns the standard out and error values. """ proc = subprocess.popen(wsman_command,shell=true,stdin=subprocess.pipe,stdout=subprocess.pipe,st derr=subprocess.pipe) stdout_value,stderr_value = proc.communicate() return(stdout_value,stderr_value) 10 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

11 4.4 Ping test The ping API is used to test the network connectivity with the remote controller or the system. You can use this test before launching WSMAN CLI commands to communicate with the remote WSMAN service. The following implementation detects the host operating system and performs the ping test. Depending on the connectivity status, an appropriate message is displayed. # Ping test def ping(ipaddress): """ Ping the IP Address of the Target to make sure the network is up and responsive. """ import sys import re from sys import stdout if(detect_host_os() == 1): cmd = "ping -n 2 " + ipaddress resp = "\(0%" else: cmd = "ping -c 2 " + ipaddress resp = " 0%" print 'Pinging %s. Waiting for response.' % (ipaddress), stdout.flush() stdout_value,stderr_value = wsman_command_launch(cmd) if(re.search(resp,stdout_value)== None): print "\nthe idrac is not responding. Check system and try again." sys.exit() print "Response received." 11 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

12 5 Custom management scripts for Dell Command Monitor 5.1 Listing BIOS settings # List BIOS settings wsman_command = wsman_enumerate_command("dcim_biosenumeration", username, password, " ") stdout_value,stderr_value = wsman_command_launch(wsman_command) print stdout_value 5.2 Checking if a BIOS password is set # Check isset property to know if a BIOS password is set wsman_command = wsman_enumerate_command("dcim_biospassword", username, password, " ") stdout_value,stderr_value=wsman_command_launch(wsman_command) print stdout_value 5.3 Getting the first power-on date, manufacturing date, model, servicetag # Get First Power On Date and Manufacturing Date wsman_command = wsman_enumerate_command("dcim_chassis", "<user_name>", "<password>", " ") stdout_value,stderr_value = wsman_command_launch(wsman_command) print stdout_value 5.4 Getting the System Summary # Get System Summary #wsman_command=wsman_enumerate_command("dcim_computersystem", "<user_name>", "<password>", " ") stdout_value,stderr_value = wsman_command_launch(wsman_command) print stdout_value 12 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

13 5.5 Getting the property ownership tag details # Get Property Ownership Tag wsman_command = wsman_enumerate_command("dcim_biosstring", "<user_name>", "<password>", " ") stdout_value,stderr_value = wsman_command_launch(wsman_command) print stdout_value 5.6 Getting the boot order # Get Boot Sequence wsman_command=wsman_enumerate_command("dcim_bootsourcesetting", "<user_name>", "<password>", " ") stdout_value,stderr_value = wsman_command_launch(wsman_command) print stdout_value 13 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

14 6 Important Notes Ensure that the environment is configured appropriately to work with WSMAN CLI tools, along with the appropriate version of Python. The target system that the scripts communicate with WSMAN service running in the software stack. Dell s DCM must be installed and OMI server must be running for Linux system. 14 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

15 7 Where to Find More Information WSMAN Interface Guide for Linux: WSMAN Interface Guide for Windows: WSMAN command line open source for Linux (OpenWSMan): OpenWSMan installation instructions: management/w/wiki/3567.instructions installingopenwsman cli on linux.aspx WSMAN command line for Windows (Winrm): us/library/windows/desktop/aa384291(v=vs.85).aspx WSMAN scripts for the Dell Lifecycle Controller: management/w/wiki/scripting the dell lifecycle controller.aspx 15 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)

16 8 Summary Using the tools readily available on Windows and with some effort in Linux, this white paper provides information on creating custom workstation management scripts for Dell Command Monitor. The ability to create custom scripts for remote and secure systems management enables you to be more productive and efficient. 16 Python scripting for Dell Command Monitor to Manage Windows & Linux Platforms Document ID version (optional)