Table of Contents

  1. Overview
  2. Management Information Model
    1. Managed Objects
    2. References To Managed Objects
    3. Properties Of Managed Objects
    4. Methods
  3. Installation
    1. Pre-install Checklist
    2. Installation Steps
  4. Uninstallation
    1. Uninstallation Steps
  5. Getting Started
    1. Connecting Disconnecting
    2. Base APIs
    3. Creating Objects
    4. Querying Objects
    5. Querying Objects With Filters
    6. Modifying Objects
    7. Deleting Objects
    8. Transaction
  6. Convert To Ucs Python
  7. Retrieving Meta Information
  8. Watch Ucs Events
    1. Wait Until Condition
  9. Backup And Import
    1. Backup Ucs
    2. Import Ucs
  10. Start GUI Session
  11. Start KVM Session
  12. Advanced Features
    1. Compare And Sync UCS
    2. Multiple Parallel Transactions
    3. Threading Mode


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.

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

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.
  • 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 are Cisco UCS XML APIs, used to manage and monitor the system. There are methods supported for:

  • Authentication
    • AaaLogin
    • AaaRefresh
    • AaaLogout
  • Configuration
    • ConfigConfMo(s)
    • LsClone
    • LsInstantiate*
    • FaultAckFaults
  • Query
    • 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


Pre-install Checklist

Ensure the following are available

python >= 2.7

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


Uninstallation Steps

Irrespective of the method that was used to install the SDK, it can be uninstalled using the below command,

pip uninstall ucsmsdk

Getting Started

Connecting Disconnecting

from ucsmsdk.ucshandle import UcsHandle

# Create a connection handle
handle = UcsHandle("", "admin", "password")

# Login to the server

# Logout from the server

Refer UcsHandle API Reference for detailed parameter sets to UcsHandle

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.


The below example creates a new Service Profile(LsServer) Object under the parent org-root

from import LsServer

sp = LsServer(parent_mo_or_dn="org-root", name="sp_demo")

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. The output is a dictionary of format {classId: [objects]}

    object_dict = handle.query_classid("orgOrg", "fabricVlan")

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)


    • 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

# 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

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

note: The changes will not be sent to the server until a commit() is invoked.

Remove Mo API reference


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 import LsServer

sp1 = LsServer(parent_mo_or_dn="org-root", name="sp_demo1")

sp2 = LsServer(parent_mo_or_dn="org-root", name="sp_demo2")

# commit the changes to server

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.


  • User knows to do an operation via the JAVA based UCSM GUI
  • 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>)

# launch the UCSM GUI

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

  • Print the equivalent script to console, also print the XMLs that the UI sends out
from ucsmsdk.utils.converttopython import convert_to_ucs_python

  • Output the script to a file
from ucsmsdk.utils.converttopython import convert_to_ucs_python

file_path = r”/home/user/”

convert_to_ucs_python(dump_to_file=True, dump_file_path=file_path)
  • XML to python

convert_to_ucs_python(xml=True, request=xml_str)

API documentation: convert_to_ucs_python


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

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:
      • 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

sample output: (truncated)

     |  |-FaultInst
     |  |-FaultInst
     |  |-FabricEthVlanPortEp
     |  |  |-FaultInst
     |  |-FabricFcoeVsanPortEp
     |     |-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                       :[]

Watch Ucs Events

Wait Until Condition

wait_for_event is used to wait until a specific condition.


  • mo: object that is monitored
  • prop: prop to check
  • value: success value
  • cb: done callback
  • timeout: (Optional) timeout in seconds
def done_callback(mo_change_event):

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)

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”

             file_dir= backup_dir,
             file_name= backup_filename)

Backup Ucs API Reference

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 API Reference

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


Start UCS GUI API Reference

note: This method is specific to launching UCSM JAVA GUI. It does not work for UCSM HTML UI

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

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

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

# Commit transaction #2

handle.add_mo(mo5, tag="trans_1")

# Commit transaction #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

  • Disable threaded mode


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.