ucsmsdk Documentation

Transcription

1 ucsmsdk Documentation Release Cisco Sep 27, 2018

2

3 Contents 1 Table of Contents Overview Management Information Model Managed Objects References To Managed Objects Properties of Managed Objects Methods Installation Pre-install Checklist Installation Steps Uninstallation Uninstallation Steps Getting Started Connecting Disconnecting Base APIs Creating Objects Querying Objects Querying Objects With Filters Modifying Objects Deleting Objects Transaction Convert To Ucs Python Retrieving Meta Information Watch Ucs Events Wait Until Condition Backup And Import Backup Ucs Import Ucs Start GUI Session Start KVM Session Technical Support Advanced Features Compare And Sync UCS Multiple Parallel Transactions Threading Mode i

4 2 Contributing Types of Contributions Report Bugs Submitting pull requests to change the documentation or code Commit message guidelines Legal Stuff: Sign your work Submit Feedback Credits Development Lead Contributors History ( ) ( ) ( ) ( ) ( ) ( ) ( ) ( ) Indices and tables 41 ii

5 Contents: Contents 1

6 2 Contents

7 CHAPTER 1 Table of Contents 1. Overview 2. Management Information Model (a) Managed Objects (b) References To Managed Objects (c) Properties Of Managed Objects (d) Methods 3. Installation (a) Pre-install Checklist (b) Installation Steps 4. Uninstallation (a) Uninstallation Steps 5. Getting Started (a) Connecting Disconnecting (b) Base APIs (c) Creating Objects (d) Querying Objects (e) Querying Objects With Filters (f) Modifying Objects (g) Deleting Objects (h) Transaction 6. Convert To Ucs Python 7. Retrieving Meta Information 3

8 8. Watch Ucs Events (a) Wait Until Condition 9. Backup And Import (a) Backup Ucs (b) Import Ucs 10. Start GUI Session 11. Start KVM Session 12. Technical Support 13. Advanced Features (a) Compare And Sync UCS (b) Multiple Parallel Transactions (c) Threading Mode 1.1 Overview Cisco UCS Python SDK is a python module which helps automate all aspects of Cisco UCS management including server, network, storage and hypervisor management. Bulk of the Cisco UCS Python SDK work on the UCS Manager s Management Information Tree (MIT), performing create, modify or delete actions on the Managed Objects (MO) in the tree. The next chapter provides an overview of the Cisco UCS Management Information Model (MIM). One of the easiest ways to learn UCS configuration through UCS Python SDK is to automatically generate python script, for configuration actions performed with the UCSM GUI, using API described in Convert To Ucs Python. 1.2 Management Information Model All the physical and logical components that comprise Cisco UCS are represented in a hierarchical Management Information Model, referred to as the Management Information Tree (MIT). Each node in the tree represents a Managed Object (MO), uniquely identified by its Distinguished Name. (DN) The figure below illustrates a sample (partial) MIT for three chassis. Tree (toproot) Distinguished Name -- sys sys -- chassis-1 sys/chassis-1 -- chassis-2 sys/chassis-2 -- chassis-3 sys/chassis-3 -- blade-1 sys/chassis-3/blade-1 -- adaptor-1 sys/chassis-3/blade-1/adaptor-1 -- blade-2 sys/chassis-3/blade-2 -- adaptor-1 sys/chassis-3/blade-2/adaptor-1 -- adaptor-2 sys/chassis-3/blade-2/adaptor-2 4 Chapter 1. Table of Contents

9 1.2.1 Managed Objects Managed Objects (MO) are abstractions of Cisco UCS resources, such as fabric interconnects, chassis, blades, and rack-mounted servers. Managed Objects represent any physical or logical entity that is configured / managed in the Cisco UCS MIT. For example, physical entities such as Servers, Chassis, I/O cards, Processors and logical entities such as Resource pools, User roles, Service profiles, and Policies are represented as Managed Objects. Every Managed Object is uniquely identified in the tree with its Distinguished Name (Dn) and can be uniquely identified within the context of its parent with its Relative Name (Rn). The Dn identifies the place of the MO in the MIT. A Dn is a concatenation of all the relative names starting from the root to the MO itself. Essentially, Dn = [Rn]/[Rn]/[Rn]/... /[Rn]. In the example below, Dn provides a fully qualified name for adaptor-1 in the model. <dn = sys/chassis-5/blade-2/adaptor-1 /> The above written Dn is composed of the following Rn: topsystem MO: rn="sys" equipmentchassis MO: rn="chassis-[id]" computeblade MO: rn ="blade-[slotid]" adaptorunit MO: rn="adaptor-[id]" A Relative Name (Rn) may have the value of one or more of the MO s properties embedded in it. This allows in differentiating multiple MOs of the same type within the context of the parent. Any properties that form part of the Rn as described earlier are referred to as Naming properties. For instance, multiple blade MOs reside under a chassis MO. The blade MO contains the blade identifier as part of its Rn (blade-[id]), thereby uniquely identifying each blade MO in the context of a chassis References To Managed Objects The contents of the Managed Objects are referred to during the operation of UCS. Some of the MOs are referred to implicitly (PreLoginBanner during login) or as part of deployment of another MO (The Service Profile MO may refer to a template or a VNIC refers to a number of VLAN MOs). A singleton MO type is found utmost once in the entire MIT and is typically referred to implicitly. Non-Singleton MO type may be instantiated one or more times in the MIT. In many cases, when an MO refers to another, the reference is made by name. Depending on the type of the referenced MO, the resolution may be hierarchical. For instance, a service profile template is defined under an Org. Since an org may contain sub-orgs, a sub org may have a service profile template defined with the same name. Now, when a service profile instance refers to a service profile template (by name), the name is looked up hierarchically from the org of the service profile instance up until the root org. The first match is used. If no match is found, then the name default is looked up in the similar way and the first match is used Properties of Managed Objects Properties of Managed Objects can be classified as Configuration or Operational. Configuration properties may be classified as: Naming properties: Form part of the Rn. Needs to be specified only during MO creation and cannot be modified later. Create-Only properties: May be specified only during MO creation and cannot be modified later. If the property is not specified, a default value is assumed Management Information Model 5

10 Read / Write properties: May be specified during MO creation and can also be modified subsequently. Operational properties indicate the current status of the MO / system and are hence read-only Methods Methods are Cisco UCS XML APIs, used to manage and monitor the system. There are methods supported for: Authentication AaaLogin AaaRefresh AaaLogout Configuration Query ConfigConfMo(s) LsClone LsInstantiate* FaultAckFaults ConfigResolveDn(s) ConfigResolveClass(es) ConfigResolveChildren Event Monitor EventSubscribe The class query methods (ConfigResolveClass(es), ConfigResolveChildren) allow a filter to be specified so that a specific set of MOs are matched and returned by the method. The supported filters are: allbits Match if all specified values are present in a multi-valued property anybit Match if any of the specified values are present in a multi-valued property bw Match if the property s value lies between the two values specified eq Match if property s value is the same as the specified value ge Match if property s value is greater than or equal to the specified value gt - Match if property s value is greater than the specified value le Match if property s value is lesser than or equal to the specified value lt Match if property s value is lesser than the specified value ne Match if property s value is not equal to the specified value wcard Match if property s value matches the pattern specified 6 Chapter 1. Table of Contents

11 1.3 Installation Pre-install Checklist Ensure the following are available python >= 2.7 pip Installation Steps Installing the last released version of the SDK from pypi pip install ucsmsdk Installing the latest developer version from github git clone cd ucsmsdk sudo make install 1.4 Uninstallation Uninstallation Steps Irrespective of the method that was used to install the SDK, it can be uninstalled using the below command, pip uninstall ucsmsdk 1.5 Getting Started Connecting Disconnecting from ucsmsdk.ucshandle import UcsHandle # Create a connection handle handle = UcsHandle(" ", "admin", "password") # Login to the server handle.login() # Logout from the server handle.logout() Refer UcsHandle API Reference for detailed parameter sets to UcsHandle 1.3. Installation 7

12 1.5.2 Base APIs The SDK provides APIs to enable CRUD operations. Create an object - add_mo Retrieve an object - query_dn,query_classid,query_dns,query_classids Update an object - set_mo Delete an object - delete_mo The above APIs can be bunched together in a transaction (All or None). commit_mo commits the changes made using the above APIs. All these methods are invoked on a UcsHandle instance. We refer it by handle in all the examples here-after. Refer to the Connecting Disconnecting to create a new handle Creating Objects Creating managed objects is done via add_mo API. Example: The below example creates a new Service Profile(LsServer) Object under the parent org-root from ucsmsdk.mometa.ls.lsserver import LsServer sp = LsServer(parent_mo_or_dn="org-root", name="sp_demo") handle.add_mo(sp) note: the changes will only be sent to server when handle.commit() is called. Add Mo API reference Querying Objects Querying Objects via Distinguished Name (DN) object = handle.query_dn("org-root/ls-sp_demo") Querying Multiple Objects via Multiple Distinguished Names (DN) The returned object is a dictionary in {dn:object} format object_dict = handle.query_dn("org-root/ls-sp_demo1", "org-root") Querying Objects via class Id The below returns all objects of type orgorg object_array = handle.query_classid("orgorg") Querying Objects via multiple class Ids The below returns all objects of type orgorg and fabricvlan. {classid: [objects]} The output is a dictionary of format object_dict = handle.query_classid("orgorg", "fabricvlan") 8 Chapter 1. Table of Contents

13 Query DN API reference Query DNs API reference Query Class Id API reference Query Class Ids API reference Querying Objects With Filters Filter is passed as string parameter to query_dn,query_dns,query_classid,query_classids methods Basic usage: A basic filter string is of (prop_name, prop_value) format, filter_str = '(name, "demo_1")' sp = handle.query_classid(class_id="lsserver", filter_str=filter_str) Specific usage: To have more control on the filter behaviour use the extended filter format, (prop_name, prop_value, filter_type) filter_type: re: Default, regex match. eq: equal, exact match. ne: not equal ge: greater than and equal to gt: greater than le: less than and equal to lt: less than An example of an exact match, filter_str = '(name, "demo_1", type="eq")' sp = handle.query_classid(class_id="lsserver", filter_str=filter_str) Complex filters - combination of multiple conditions: The below checks for (name == "demo") or (name == *demo_1* and name == [0-9]_1) filter_str = '''(name, "demo", type="eq") or ((name, "demo_1") and (name, "[0-9]_1"))''' sp = handle.query_classid(class_id="lsserver", filter_str=filter_str) note: ''' here is used as a multiline string Modifying Objects set_mo is used for updating an existing object 1.5. Getting Started 9

14 # Query for an existing Mo sp = handle.query_dn("org-root/ls-sp_demo") # Update description of the service profile sp.descr = "demo_descr" # Add it to the on-going transaction handle.set_mo(sp) note: The changes will not be sent to the server until a commit() is invoked. Set Mo API reference Deleting Objects remove_mo is used for removing an object # Query for an existing Mo sp = handle.query_dn("org-root/ls-sp_demo") # Remove the object handle.remove_mo(sp) note: The changes will not be sent to the server until a commit() is invoked. Remove Mo API reference Transaction API operations are batched together by default until a commit() is invoked. In the below code, the objects are created only when commit is invoked. If there is a failure in one of the steps, then no changes are committed to the server. from ucsmsdk.mometa.ls.lsserver import LsServer sp1 = LsServer(parent_mo_or_dn="org-root", name="sp_demo1") handle.add_mo(sp1) sp2 = LsServer(parent_mo_or_dn="org-root", name="sp_demo2") handle.add_mo(sp2) # commit the changes to server handle.commit() 1.6 Convert To Ucs Python Wouldn t it be cool if you did not have to know the SDK much to be able to automate operations based off it? Welcome the convert_to_ucs_python API. Assumption: User knows to do an operation via the JAVA based UCSM GUI 10 Chapter 1. Table of Contents

15 UCSM UI and convert_to_ucs_python should be launched on the same client machine. Basic Idea: launch the JAVA based UCSM UI launch the python shell and invoke convert_to_ucs_python perform the desired operation on the UI convert_to_ucs_python monitors the operation and generates equivalent python script for the same. How it works: UCSM GUI logs all the activities that are performed via it, and the python shell monitors that log to generate the equivalent python script. Since the logging is local to the machine where the UI is running, convert_to_ucs_python also must run on the same machine. Sample Usage: Step 1 - Launch the UCSM GUI. from ucsmsdk.utils.ucsguilaunch import ucs_gui_launch from ucsmsdk.ucshandle import UcsHandle # Login to the server handle = UcsHandle(<ip>, <username>, <password>) handle.login() # launch the UCSM GUI ucs_gui_launch(handle) Step 2 - Run convert_to_ucs_python The CLI will go into a listen mode until Ctrl+C is pressed again. Until then it prints equivalent script for operations done on the UI. Print the equivalent script to console from ucsmsdk.utils.converttopython import convert_to_ucs_python convert_to_ucs_python() Print the equivalent script to console, also print the XMLs that the UI sends out from ucsmsdk.utils.converttopython import convert_to_ucs_python convert_to_ucs_python(dump_xml=true) Output the script to a file from ucsmsdk.utils.converttopython import convert_to_ucs_python file_path = r /home/user/pythoncode.py convert_to_ucs_python(dump_to_file=true, dump_file_path=file_path) XML to python xml_str= <configconfrename dn= org-root/ls-ra1 (continues on next page) 1.6. Convert To Ucs Python 11

16 innewname= ra2 inhierarchical= false > </configconfrename> (continued from previous page) convert_to_ucs_python(xml=true, request=xml_str) API documentation: convert_to_ucs_python note: The path of UCSM UI logs differs based on the OS and so sometimes the convert_to_ucs_python API may not be able to autodetect the path. The following workaround can be applied in such cases, Manually find the path to UCSM UI logs $ sudo find / -name '.ucsm'./library/application Support/Oracle/Java/Deployment/log/.ucsm $ Run convert_to_ucs_python by specifying the path from ucsmsdk.utils.converttopython import convert_to_ucs_python convert_to_ucs_python(gui_log=true, path=<path that was found above>) 1.7 Retrieving Meta Information get_meta_info is useful for getting information about a Managed object. from ucsmsdk.ucscoreutils import get_meta_info class_meta = get_meta_info("fabricvlan") print class_meta The below sample output starts with a tree view of where FabricVlan fits, its parents and childrens, followed by MO information. It then shows information about properties of the MO. Mo Property information: xml_attribute - the name of the property as expected by the server. field_type - type of the field min_version - Ucs server release in which the property was first introduced access - defines if a property is interal/user-readable/user-writable property restrictions: sample output: (truncated) * min_length - minimum length for string property type * max_length - maximum length for string property type * pattern - allowed patterns, regexs * value_set - set of allowed values for this property * range_val - range for int/uint values 12 Chapter 1. Table of Contents

17 [FabricEthEstc] [FabricEthEstcCloud] [FabricEthLan] [FabricLanCloud] -FabricVlan -FabricEthMonFiltEp -FabricEthMonSrcEp -FabricEthVlanPc -FaultInst -FabricEthVlanPortEp -FaultInst -FabricPoolableVlan -FabricSwSubGroup -FabricEthVlanPortEp -FaultInst -FabricFcoeVsanPortEp -FaultInst -FaultInst ClassId FabricVlan xml_attribute :fabricvlan rn :net-[name] min_version :1.0(1e) access :InputOutput access_privilege :['admin', 'ext-lan-config', 'ext-lan-policy'] parents :[u'fabricethestc', u'fabricethestccloud', u 'fabricethlan', u'fabriclancloud'] children :[u'fabricethmonfiltep', u'fabricethmonsrcep', u 'fabricethvlanpc', u'fabricethvlanportep', u'fabricpoolablevlan', u'fabricswsubgroup ', u'faultinst'] Property assoc_primary_vlan_state xml_attribute :assocprimaryvlanstate field_type :string min_version :2.2(2c) access :READ_ONLY min_length :None max_length :None pattern :None value_set :['does-not-exists', 'is-empty', 'is-in-error-state', 'is-not-primary-type', 'ok'] range_val :[] Property assoc_primary_vlan_switch_id xml_attribute :assocprimaryvlanswitchid field_type :string min_version :2.2(2c) access :READ_ONLY min_length :None max_length :None pattern :None value_set :['A', 'B', 'NONE'] range_val :[] 1.7. Retrieving Meta Information 13

18 1.8 Watch Ucs Events Wait Until Condition wait_for_event is used to wait until a specific condition. It works by monitoring the Ucs Event Channel or by periodically polling the server. Polling mode is used when poll_sec argument is specified. Specifying a timeout is highly recommended. Arguments: mo: object that is monitored prop: prop to check value: success value cb: done callback timeout: (Optional) timeout in seconds poll_sec: (Optional) polling interval in seconds when using poll mode def done_callback(mo_change_event): print mo_change_event.mo sp_mo = handle.query_dn("org-root/ls-sp_demo") # call done_callback when (sp_mo.descr == "demo") handle.wait_for_event(sp_mo, "descr", "demo", done_callback) 1.9 Backup And Import Backup Ucs backup_ucs is used to take backup of a Ucs server Type of backups: fullstate config-logical config-system config-all from ucsmsdk.utils.ucsbackup import backup_ucs backup_dir = /home/user/backup backup_filename = config_backup.xml backup_ucs(handle, backup_type= config-logical, file_dir= backup_dir, file_name= backup_filename) Backup Ucs API Reference 14 Chapter 1. Table of Contents

19 1.9.2 Import Ucs import_ucs_backup is used to import an existing backup to a Ucs server from ucsmsdk.utils.ucsbackup import import_ucs_backup import_dir = /home/user/backup import_filename = config_backup.xml import_ucs_backup(handle, file_dir=import_dir, file_name=import_filename) Import Ucs API Reference 1.10 Start GUI Session ucs_gui_launch is used to launch UCSM JAVA GUI. This method assumes that the required JAVA installation for UCSM UI is already present. from ucsmsdk.utils.ucsguilaunch import ucs_gui_launch ucs_gui_launch(handle) Start UCS GUI API Reference note: This method is specific to launching UCSM JAVA GUI. It does not work for UCSM HTML UI 1.11 Start KVM Session ucs_kvm_launch is used to launch KVM for a service profile or a server(blade/rack) Launch KVM for a specified service profile MO from ucsmsdk.utils.ucskvmlaunch import ucs_kvm_launch # sp_mo is of type LsServer ucs_kvm_launch(handle, service_profile=sp_mo) Launch KVM for a specified Blade server from ucsmsdk.utils.ucskvmlaunch import ucs_kvm_launch # blade_mo is of type ComputeBlade ucs_kvm_launch(handle, blade=blade_mo) launch KVM for a specified Rack server from ucsmsdk.utils.ucskvmlaunch import ucs_kvm_launch # rack_mo is of type ComputeRackUnit ucs_kvm_launch(handle, rack_unit=rack_mo) Start KVM Session API Reference Start GUI Session 15

20 1.12 Technical Support get_tech_support facilitates technical support for UCSM and related components. option parameter defines the type of technical support that is desired. **kwargs are key1=val1, key2=val2 type named arguments that need to be specified depending on the component for which technical support is being trigerred. For example, if the user wants to trigger technical support for option=chassis, then he/she will also need to pass chassis_id=1, cimc_id=1 or chassis_id=1, iom_id=1. The below examples show the corresponding arguments that apply to the component for which tech support is being taken. Please note that these parameters should only be specified towards the end and not before the existing named paramters. Create Tech Support for UCSM from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="ucsm", file_dir='.', file_name="ucsm.tar", timeout=1800) Create Tech Support for UCSM-MGMT from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="ucsm-mgmt", file_dir='.', file_name="ucsm.tar", timeout=1800) Create Tech Support for Chassis-CIMC from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="chassis", file_dir='.', file_name="cimc.tar", timeout=1800, chassis_id=1, cimc_id=1, adapter_id="all" ) Create Tech Support for Chassis-IOM from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="chassis", file_dir='.', file_name="cimc.tar", timeout=1800, chassis_id=1, iom_id=1, ) Create Tech Support for Rackserver 16 Chapter 1. Table of Contents

21 from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="rack-server", file_dir='.', file_name="cimc.tar", timeout=1800, rack_server_id=1, rack_adapter_id="all" ) Create Tech Support for Fabric Extender from ucsmsdk.utils.ucstechsupport import get_tech_support get_tech_support(handle, option="fabric-extender", file_dir='.', file_name="fex.tar", timeout=1800, fex_id=1 ) 1.13 Advanced Features Compare And Sync UCS compare_ucs_mo is used to compare objects with same dn across different Ucs Domains. Compare objects with same DN on different domains dn_to_compare = org-root/ls-sp ref_mo = [ref_handle.query_dn(dn=dn_to_compare)] diff_mo = [diff_handle.query_dn(dn=dn_to_compare)] difference = compare_ucs_mo(ref_mo, diff_mo) sync_ucs_mo is used to sync changes that are found using compare_ucs_mo # difference parameter is the output of compare_ucs_mo sync_ucs_mo(ref_handle, difference=difference, delete_not_present=true) Multiple Parallel Transactions Optional tag parameter in add_mo, set_mo, remove_mo, commit provides a scope to transaction. This enables multiple parallel transactions, handle.add_mo(mo1, tag="trans_1") handle.add_mo(mo2, tag="trans_2") handle.add_mo(mo3, tag="trans_1") handle.remove_mo(mo4, tag="trans_2") (continues on next page) Advanced Features 17

22 # Commit transaction #2 handle.commit(tag="trans_2") (continued from previous page) handle.add_mo(mo5, tag="trans_1") # Commit transaction #1 handle.commit(tag="trans_1") Threading Mode This mode is useful, when the application that uses the SDK is threaded and it intends to use the SDK using its multiple threads. Enable threaded mode handle.set_mode_threading() Disable threaded mode handle.unset_mode_threading() When threading mode is enabled the transaction context isolation is automatically provided on a thread level (even when the tag parameter is not explicitly specified). Thread names are automatically used as tag parameter internally. 18 Chapter 1. Table of Contents

23 CHAPTER 2 Contributing Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways: 2.1 Types of Contributions Report Bugs Report bugs at If you are reporting a bug, please include: Your operating system name and version. Any details about your local setup that might be helpful in troubleshooting. Detailed steps to reproduce the bug Submitting pull requests to change the documentation or code Changes can be proposed by sending a pull request (PR). A maintainer will review the changes and provide feedback. The pull request will be merged into the master branch after discussion. Please make sure to run the tests and that the tests pass before submitting the PR. Please keep in mind that some changes might not be merged if the maintainers decide they can t be merged. Please squash your commits to one commit per fix or feature. The resulting commit should have a single meaningful message. 19

24 2.1.3 Commit message guidelines The short summary should include the name of the directory or file affected by the commit (e.g.: utils: added a new utility method to get status). A longer description of what the commit does should start on the third line when such a description is deemed necessary. If you have trouble with the appropriate git commands to handle these requirements, please let us know! We re happy to help Legal Stuff: Sign your work You must sign off on your work by adding your signature at the end of the commit message. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. If you set your user.name and user. git configuration options, you can sign your commits automatically with git commit -s. git config user.name Joe Smith git config user. joe.smith@ .com git commit -s should be used now to sign the commits automatically, instead of git commit Submit Feedback The best way to send feedback is to file an issue at If you are proposing a feature: Explain in detail how it would work. Keep the scope as narrow as possible, to make it easier to implement. Remember that this is a volunteer-driven project, and that contributions are welcome :) 20 Chapter 2. Contributing

25 CHAPTER 3 Credits 3.1 Development Lead Vikrant Balyan<vvb@cisco.com> 3.2 Contributors Rahul Gupta<ragupta4@cisco.com> 21

26 22 Chapter 3. Credits

27 CHAPTER 4 History 23

28 24 Chapter 4. History

29 CHAPTER ( ) Fixes for python 3 compatibility 25

30 26 Chapter ( )

31 CHAPTER ( ) Support for UCSM release 3.2(3a) Support for accepting array arguments in query_classids, query_dns Support for setting response timeout for the UCSM operations (query/config) Handling auto_refresh flag in unfreeze Fixing issue with None value check of property by removing None check from validation of property/check_prop_match Fixing issue where error happens with commit when threading is enabled and commit buffer is empty Fixing issue where ssl with Only TLS 1.2 does not work 27

32 28 Chapter ( )

33 CHAPTER ( ) Removed jsonpickle dependency 29

34 30 Chapter ( )

35 CHAPTER ( ) Support for estimating impact of a transaction - handle.estimate_impact Support for TLS 1.1, 1.2 Newer UCSM releases support TLS1.2. HTTPS connection to the servers with newer releases might fail in absence of TLS1.1/1.2 support. Added command line script to make running convert_to_ucs_python easier. bin/watch_ucs.py in the github repo. Special characters like <,>,& in XML values are deemed invalid and cause failure in parsing XML. Added a recovery logic if these exist in the XML value fields. Support for serialization, deserialization of UcsHandle Support for UCSM inventory via get_inventory API 31

36 32 Chapter ( )

37 CHAPTER ( ) Support for UCSM 3.1(2b) Adds Support for Generating python APIs from a Ucs backup xml - convert_from_backup Adds Infra to facilitate and notify users of API deprecation Allows the ucsmsdk/apis layer APIs to pass in None values to indicate that no change is rquested to those specific params Adds a method to check if the handle.cookie is still valid Fix in eventhandlers, where some events were not getting processed Fix in eventhandlers, where timeout was not getting triggered until new events Fix in get_ucs_tech_support, where techsupport for rack server was failing Fix in logout, where a Ctrl+C was causing stale connections on the server Deprecated get_ucs_tech_support in favour of get_tech_support. The newer API simplifies the API 33

38 34 Chapter ( )

39 CHAPTER ( ) Support for UCSM Simplified event handlers to a single wait_for_event method. UcsEventHandler internals are hidden from user. Support for showing progress for upload/download operations Support for multi-threading in SDK. An application can run multiple threads that can use SDK methods in parallel. Support for multiple parallel transactions via the tag parameter in add_mo, set_mo, remove_mo, commit_mo Fix for convert_to_ucs_python exception in some scenarios Fix for convert_to_ucs_python not displaying python script for Java6u45 Fix for event handlers not trigerring for some events Added more unit and system tests Better Documentation 35

40 36 Chapter ( )

41 CHAPTER ( ) Support for UCSM Support for Python 3.x Support for Comparing and Syncing Objects across Ucs Domains - compare_ucs_mo sync_ucs_mo Support for filter_str in query_children method Support to drill down into Managed Object Meta and Property Meta details - get_meta_info Support to monitor any/all change(s) in a ManagedObject with UcsEventHandler Fix for Unable to make unsecured connection when redirection was enabled on the server Fix for issues with the usage of force parameter in Login method Fix for not filter not generating filter request Fix for TechSupport not getting removed from server even when remove_from_ucs=true Fix for convert_to_ucs_python not redirecting output to a file Fix for convert_to_ucs_python not working correctly when gui_log=true More PEP8 compliance related fixes 37

42 38 Chapter ( )

43 CHAPTER ( ) Python SDK for UCS server management and related automation Supports every Managed Object exposed by Ucs APIs for CRUD operations simplified Support for server side filters made simpler Support for eventhandlers Runtime memory usage is reduced Nosetests for unit testing Samples directory for more real world use cases Integrating the sphinx framework for documentation PEP8 Compliance 39

44 40 Chapter ( )

45 CHAPTER 13 Indices and tables genindex modindex search 41