EasyUCS is a toolbox to help deploy and manage Cisco UCS/Intersight devices.
It can :
- deploy a configuration on a running UCS device / Intersight instance:
- UCS system (UCS Manager)
- UCS IMC (Integrated Management Controller) for standalone servers
- UCS Central
- Intersight (SaaS or Appliance)
- perform the initial setup of an "out of the box" UCS device (UCSM or CIMC)
- reset the configuration of an UCS device before configuring it
- fetch a configuration and export it in JSON format
- fetch an inventory and export it in JSON format
- perform maintenance actions on a UCS device (regenerate self-signed certificate, clear user sessions, clear SEL logs)
- claim/unclaim UCS devices to/from Intersight
- create pictures of equipment and infrastructure schemas
- create Technical Architecture Documentation (TAD) in Word/PDF formats
These instructions will get you a copy of the project up and running on your local machine.
Minimum versions of UCS devices :
- UCS Manager: 3.2(1d) or above
- UCS IMC: 3.0(1c) or above
- UCS Central: 2.0(1a) or above
- Intersight SaaS (no prerequisite) & Appliance: 1.0.9-675 or above
This tool requires Python 3.8+ to work. Python 2.x is not supported.
Python can be used on Windows, Linux/Unix, Mac OS X and more.
You can download the latest version of Python 3 on the official website.
EasyUCS can be installed using any of ways below:
Click "Clone or Download" and "Download ZIP" on the GitHub website to download the whole project.
Uncompress the zip and put the folder on your system.
You need to have Git on your system (not necessarily installed by default on all types of system).
Navigate to your desired path where you want EasyUCS to be placed on and clone it through your command-line console,
git clone https://github.com/vesposito/easyucs.git
EasyUCS requires some Python modules dependencies. The file requirements.txt contains all of these requirements.
Use Python Pip to install all of them.
- for Max OS X, Unix, Linux:
pip install -r requirements.txt
- for Windows:
python -m pip install -r requirements.txt
EasyUCS can be used with command line interface or via a Web GUI.
Push config file config_ucsm.json to UCS system
python easyucs.py config push -t ucsm -i 192.168.0.1 -u admin -p password -f configs/config_ucsm.json
Push config file config_cimc.json to UCS IMC
python easyucs.py config push -t cimc -i 192.168.0.2 -u admin -p password -f configs/config_cimc.json
Perform initial setup of UCS system using DHCP IP addresses 192.168.0.11 & 192.168.0.12 and push config file config_ucsm.json
python easyucs.py config push -t ucsm -f configs/config_ucsm.json -s 192.168.0.11 192.168.0.12
Reset UCS system, perform initial setup using DHCP IP addresses 192.168.0.11 & 192.168.0.12 and push config file config_ucsm.json
python easyucs.py config push -t ucsm -i 192.168.0.1 -u admin -p password -f configs/config_ucsm.json -r -s 192.168.0.11 192.168.0.12
Fetch config from UCS system and save it to output/configs/config_ucsm.json
python easyucs.py config fetch -t ucsm -i 192.168.0.1 -u admin -p password -o output/configs/config_ucsm.json
Fetch inventory from UCS IMC and save it to output/inventories/inventory_cimc.json
python easyucs.py inventory fetch -t cimc -i 192.168.0.2 -u admin -p password -o output/inventories/inventory_cimc.json
Create schemas from UCS system and save them to output/schemas folder
python easyucs.py schemas create -t ucsm -i 192.168.0.1 -u admin -p password -o output/schemas
Create report from UCS system and save it to output/reports folder (also creates schemas)
python easyucs.py report generate -t ucsm -i 192.168.0.1 -u admin -p password -o output/reports
Regenerate expired Self-signed Certificate of UCS system
python easyucs.py device regenerate_certificate -t ucsm -i 192.168.0.1 -u admin -p password
Clear SEL Logs of all discovered servers of UCS system
python easyucs.py device clear_sel_logs -t ucsm -i 192.168.0.1 -u admin -p password
Clear Intersight Device Connector claim status for UCS system
python easyucs.py device clear_intersight_claim_status -t ucsm -i 192.168.0.1 -u admin -p password
The Web GUI is hosted by your machine, in order to launch it you need to use the file easyucs_api.py.
python easyucs_api.py
- ucsmsdk - The UCS Manager Python SDK
- imcsdk - The UCS IMC Python SDK
- ucscsdk - The UCS Central Python SDK
- intersight-python - The Intersight Python SDK
- Add support for subnet-level configuration for IP Pools in Intersight config
- Add support for User Labels on Chassis & Domain Profiles in Intersight config
- Add support for Physical NIC mode in Adapter Config Policy in Intersight config
- Add support for Hybrid Slots configuration in Storage Policy in Intersight config
- Add support for FlexMMC in Boot Policy in Intersight config
- Bump up minimum Intersight Appliance required version to 1.0.9-675
- Miscellaneous bug fixes and improvements
- Add support for regenerating SSL certificates for UCSM & CIMC devices in CLI & GUI
- Add support for cleaning an Intersight account (removes all pools, policies, profiles & templates) in GUI
- Add support for UCS M7 servers with Emerald Rapids CPUs
- Add support for VIC QinQ & SRIOV in Intersight config
- Add support for UCSM custom OUI for FC configuration
- Bump up minimum Intersight Appliance required version to 1.0.9-655
- Miscellaneous bug fixes and improvements
- Add support for Organization Sharing in Intersight config
- Add support for X410c M7 & new VIC 15000 series adapters
- Bump up minimum Intersight Appliance required version to 1.0.9-631
- Miscellaneous bug fixes and improvements
- Add support for HTTP boot, Simple Placement mode for VIC 1300 in Intersight config
- Add support for Fabric Port-Channel vHBA Reset in UCSM & Intersight config
- Add support for BIOS Tokens up to UCS Central 2.0(1t)
- Add support for XFM inventory/draw & Server Personality in UCSM inventory
- Bump up minimum Intersight Appliance required version to 1.0.9-615
- Prevent fetching Intersight config with Shared Orgs (not yet supported)
- Miscellaneous bug fixes and improvements
Sorry for the delay in updating this tool! We were busy working on the IMM Transition Tool which uses EasyUCS as its backend.
- HUGE rework of many parts of EasyUCS. It would be too long to list them all here!
This also means that there are a few breaking changes in the JSON format for UCSM files. Sorry about this! - Fully redesigned & dynamic GUI
- Repository backend for multi-device management (used by the GUI)
- EasyUCS also now has an OpenAPI-based API (used by the GUI) to easily automate your tasks
- Add support for UCS Central config fetch/push of most policies/profiles/templates/pools. UCS Central is now a first class citizen in EasyUCS.
- Add support for Intersight config fetch/push of all Server/Chassis/Domain policies/profiles/templates/pools. You can now use EasyUCS for Intersight Managed servers! (Standalone & FI-Attached)
- Add support for M6, M7 & X-Series (UCSM) in the schemas generation as well as the report.
- Add support for generating reports in PDF format (on top of Word format)
- Add support for BIOS Tokens up to UCSM 4.3(2b)
- Add support for (un)claiming CIMC/UCSM devices to Intersight using the API/GUI
- Add support for taking backups using the API/GUI (for UCSM and UCS Central)
- Fix CIMC push of Admin Networking config section
- Add support for SNMP users/traps & Syslog in CIMC config
- Update SDK requirements to fix compatibility issues
- Add inventory of PCIe risers for rack servers
- Cleanup of all catalog files
- Add flag for Intersight Managed Mode support status per equipment in UCSM inventory
- Add support for UCS C240 M5SD
- Add support for BIOS Tokens up to UCSM 4.1(3a)
- Add inventory of memory errors per DIMM in UCSM inventory
- Miscellaneous bug fixes and improvements
- Add support for Authentication (Native & Authentication Domains) in UCSM config
- Move Intersight Device Connector config to common structure between UCSM & IMC
- Add missing "Storage Config. Deployment Policy" attribute in Maintenance Policies in UCSM config
- Other small bug fixes and improvements
- Add support for Intersight Device Connector in inventory & config for UCSM & IMC
- Add Device Connector section in UCSM & IMC report
- Add support for clearing Intersight Claim Status for UCSM & IMC Device Connector
- Miscellaneous bug fixes
- Add device actions in CLI ("regenerate_certificate", "clear_sel_logs", "clear_user_sessions")
- Add "Policies" section in UCSM report with Server Policies (Boot, BIOS, Local Disk Config, Scrub, etc.)
- Add support for System Profile & Policies settings in UCS Central config (Interfaces, DNS, Date&Time, Remote Access, Syslog)
- Add support for System Profile & Policies settings in Domain Groups in UCS Central config (DNS, Date&Time, Remote Access, Equipment Policies, Syslog)
- Add support for User Settings in UCS Central config (Password Profile, Local Users, Roles & Locales)
- Add support for User Settings in Domain Groups in UCS Central config (Roles & Locales)
- Add support for SNMP settings in UCS Central config & Domain Groups
- Add support for Syslog & Global Fault Policy settings in UCSM config
- Add support for Azure Stack environments
- Add support for C4200 in UCSM report
- Add inventory of HBA adapters in IMC inventory
- Major reorganization of report code
- Multiple bug fixes and improvements
- Add support for UCSM 4.1(1) specific features (FI 64108 & Unified Ports, Fan Control Policy, new BIOS Tokens, Writable vMedia Mount)
- Add support for fetching Reserved VLAN Start ID for FI 6400 (push is planned for a future release)
- Add VLAN Port Count information in inventory and report
- Add IMC S3260 I/O Expander in inventory
- Add SSD stats in inventory when available
- Memory consumption optimization for schemas generation
- Multiple bug fixes and improvements
- Add support for UCSM 4.0(4) specific features (M.2 HWRAID, Persistent Memory Policies, Alternate KVM Port)
- Add support for configuring up to 16 Unified Ports on FI 6454
- Add support for VSANs on UCS Central
- Add preliminary support for upcoming FI 64108
- Reorganization of device, config and inventory folders to clean up files
- Bump up requirements packages versions
- Miscellaneous bug fixes and improvements (including fix for missing dependency on tkinter package)
- Add support for "comment" field in all sections of a configuration file for easily add comments to specific items of a configuration
- Add support for Fabric Interconnect port licenses in inventory and report
- Add support for 1st Gen Fabric Interconnects 6120XP/6140XP
- Add support for UCS Central inventory fetch (will fetch inventories of all registered domains)
- Support up to 32 Service Profile Templates when generating schemas
- Bump up requirements packages versions
- Miscellaneous bug fixes and improvements
- Include Storage Enclosures & drives of S3260 in report
- Add support for UEFI Boot Parameters in SAN Boot (Boot Policies)
- Remove admin password from report (for security reasons)
- Change "generate report" command argument to specify directory instead of report file name. All required files will be written in that directory
- Automatically export config & inventory to JSON files when generating report
- Lots of bug fixes and improvements
- Include portions of Logical Configuration in Technical Architecture Documentation, including Networking, Organizations, Identities and Service Profiles
- Add support for Dynamic vNIC Connection Policies in UCS Manager
- Add preliminary support for S3260 in IMC for config fetch/push - works for single server node only for now
- Add support for C4200 and C125 server node
- Various bug fixes and improvements
- Add automatic Technical Architecture Documentation creation (containing detailed inventory and architecture schemas)
- Add support for LAN & SAN Global Policies in UCS Manager (VLAN Port Count Optimization, VLAN Org Permissions, Inband Profile)
- Rework of NVMe drives support in inventory (now displayed in its own nvme_drives section instead of being in storage_controllers)
- Add support for IOM 2408, HXAF220C All NVMe, C480 M5 ML
- Various bug fixes and improvements
Initial release
- Marc Abu El Ghait - Initial work - github account link
- Franck Bonneau - Initial work - github account link
- Vincent Esposito - Initial work - github account link
- Shashank Pandey - Repository, DB, API, Intersight, ... - github account link
- Valentin Pereira - Redesigned GUI - github account link
- Mohamed Ismayil - Intersight support
- Syeda Mehar Naseer - UCS Central/Manager & Intersight support
- Anjana Devi Chilukuri - UCS Central/Manager & Intersight support
- Ananta Surendra Babu - UCS Central/Manager & Intersight support
- Simon Mathai - UCS Central/Manager & Intersight support
- Kistareddy Gari Sreelatha - UCS Central/Manager & Intersight support
- Tony Frank - PDF reporting
- Prabhu Ganesh - Various enhancements
- Rushab Mohanlal Jain - Various enhancements
- Abhinav Sinha - Various enhancements
- Jayasree Vulavala - Various enhancements
This project is licensed under the GPLv2 License - see the LICENSE file for details