Cisco UCS C Series Manual

Cisco UCS C-Series Servers REST API Programmer's Guide
First Published: 2016-12-14
Last Modified: 2019-05-22
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: [phone]
800 553-NETS (6387)
Fax: [phone]

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of
the UNIX operating system. All rights reserved. Copyright ©1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com
go trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any
other company. (1721R)
©2019 Cisco Systems, Inc. All rights reserved.

CONTENTS
Preface v
PREFACE
Audience v
Document Organization v
Related Documentation v
Documentation Feedback vi
Cisco IMC REST API Overview 1
CHAPTER 1
Introduction 1
Redfish™Architecture 1
Management Standard 2
Key Technologies 3
Operational Model 3
Cisco IMC REST API Examples 5
CHAPTER 2
Examples of Server Tasks 5
Examples of Server Tasks for 3.1(3) 51
Examples of Server Tasks for 4.0(4) 84
Cisco UCS C-Series Servers REST API Programmer's Guide
iii

Cisco UCS C-Series Servers REST API Programmer's Guide
iv
Contents

Preface
This chapter includes the following sections:
•Audience, on page v
•Document Organization, on page v
•Related Documentation, on page v
•Documentation Feedback, on page vi
Audience
This guide is intended for software engineers with a background in programming and the use of APIs. Engineers
should have knowledge of XML, data systems, networking protocols, and storage protocols.
Document Organization
This REST API Reference Guide is organized into the following chapters:
•Cisco IMC REST API Overview, on page 1
•Cisco IMC REST API Examples, on page 5
Related Documentation
For a complete list of all C-Series documentation, see the Cisco UCS C-Series Servers Documentation Roadmap
available at the following URL: http://www.cisco.com/go/unifiedcomputing/c-series-doc.
The Cisco UCS C-Series Servers Integrated Management Controller GUI Configuration Guide and the Cisco
UCS C-Series Servers Integrated Management Controller CLI Command Reference provide an overview of
Cisco IMC. This is important background information for XML API software developers.
Note
Cisco UCS C-Series Servers REST API Programmer's Guide
v

Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to [email protected]. We appreciate your feedback.
Cisco UCS C-Series Servers REST API Programmer's Guide
vi
Preface
Documentation Feedback

CHAPTER 1
Cisco IMC REST API Overview
This chapter includes the following sections:
•Introduction, on page 1
•Redfish™Architecture, on page 1
•Management Standard, on page 2
•Key Technologies, on page 3
•Operational Model, on page 3
Introduction
Representational state transfer (REST) or RESTful web services allow you to provide interoperability between
computer systems on the Internet. Using the REST-compliant web services you can request systems to access
and manipulate textual representations of web resources using a uniform and predefined set of stateless
operations. Cisco has now built capabilities of using RESTful APIs to configure the UCS C-series servers
using the Redfish™technology.
Redfish™is an open industry standard specification and schema that specifies a RESTful interface and utilizes
JSON and OData to help customers integrate solutions within their existing tool chains. It utilizes a range of
scalable IT technologies that are widely used, and by using these accepted technologies, it makes the use of
Redfish™easier. Redfish™is sponsored and controlled by the Distributed Management Task Force, Inc.
(DMTF), a peer-review standards body recognized throughout the industry.
For more information on DMTF and Redfish™standards, see DMTF and Redfish™
Redfish™Architecture
The Redfish™API comprises a folder structure that starts with the Redfish root at “/redfish/”. In case of a
C-Series server, the root is accessed through the URI https://<Cisco IMC IP>/redfish/v1/ - the “v1” at the end
of the URI denotes the version of the API.
The URI is the primary unique identifier of resources. Redfish™URIs consist of three parts as described in
RFC3986: Part one defines the scheme and authority of the URI, part two specifies the root service and version,
and part three defines a unique resource identifier.
For example, in the following URI: https://mgmt.vendor.com/redfish/v1/Systems/SvrID:
• https://mgmt.vendor.com is the scheme and authority
Cisco UCS C-Series Servers REST API Programmer's Guide
1

• /redfish/v1 is the root and version
• /Systems/SvrID is the resource identifier
Redfish™Tree Structure
The Redfish tree structure comprises a top-level root from where the RESTful interface branches out to cover
a number of “Collections” that subsequently include multiple levels within, creating a tree-like structure. You
can navigate down to this structure to find information and settings.
For example, accessing the Redfish™structure for the controller on a C-Series server would be navigated by
using the following path: https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/SimpleStorage/SLO
T-HBA
Some portions of an API path could vary depending on the hardware configuration. For example, “SLO
T-HBA” may be different when another type of RAID controller is installed in the managed server.
Note
Redfish™Operations
Redfish™uses the HTTPS method to perform operations of a RESTful API. You can specify the type of
request being made. It adheres to a standard CRUD (Create, Retrieve, Update, and Delete) format. Depending
on the desired result, you can issue the following types of commands:
•GET: View data
•POST: Create resources or use actions
•PATCH: Change one or more properties on a resource
•DELETE: Remove a resource
Currently, HEAD and PUT operations are not supported for Redfish™URIs.
Note
Management Standard
IT solution models have evolved over the years and given way to several Out-of-Band (OOB) systems
management standards, or lights-out management (LOM) systems that work within emerging programming
standards and can be implemented in the embedded systems. While this has worked fairly well, there was still
a need for a single management standard that could handle the various demands of IT solutions robustly.
Expanded scale, higher security, and multi-vendor openness call for equally diverse DevOps tools and processes.
Keeping these requirements in mind, the DMTF took on the responsibility of creating a new management
interface standard, which resulted in Redfish™version 1.0, which was formally launched in July, 2015.
Key features of the Redfish™management standard include:
• Simple to use and highly secure
• Encrypted connections and generally heightened security
• Simple programmatic interface that can be easily managed using scripts
Cisco UCS C-Series Servers REST API Programmer's Guide
2
Cisco IMC REST API Overview
Management Standard

• Meets Open Compute Project’s Remote Machine Management requirements
• Based on widely-used standards for web APIs and data formats
Redfish™can support an entire range of server architectures, right from monolithic servers to converged
infrastructure and hyper-scale architecture. The Redfish™data model is vendor neutral, and defines its own
structure and format of data that comprises server status, inventory and existing operational functions. You,
as an administrator can then automate management scripts to manage any Redfish™compliant server, resulting
in the efficient operation of a heterogeneous server fleet.
In terms of security, Redfish™offers a highly secure and reliable communication opportunity with its use of
HTTPS encryption as opposed to conventional management protocols. You can convey all Redfish™network
traffic, including event notifications across the network in an encrypted packet, reducing threats significantly.
Key Technologies
HTTPS Communications
The Hypertext Transfer Protocol or HTTP is an application protocol for distributed, collaborative, hypermedia
information systems and forms the foundation of data communication for the World Wide Web. Secure HTTP
or HTTPS is a secure version of HTTP that enables secure communications by operating HTTP within a
network connection encrypted by TLS or SSL. By utilizing HTTPS, Redfish™significantly enhances the
security of server management especially in comparison to legacy server management protocols.
RESTful Application Programming Interface
Representational State Transfer (REST) or RESTful API is a programming interface that uses the HTTP
request to retrieve information with the help of GET, POST, and DELETE data. Many IT companies use the
RESTful architecture. Leveraging this standardized approach, Redfish™implements a RESTful API for
accessing management information and for issuing commands to change the configuration or operational state
of a server.
Operational Model
Redfish™operations are initiated by a client using HTTPS for GET, POST, PATCH and DELETE operations
and are capable of interpreting JSON responses from the managed server. The responses provide the requested
information and indications of success or failure of the requested operation.
Redfish™Client
RESTful API goes by the principle "Everything is a Resource". This means that every Uniform Resource
Identifier or URI represents a resource of a specific type - a service, a collection or an individual entity. Within
the Redfish™context however, a resource can be thought of as the content of the HTTPS message returned
when accessing a URI. A variety of REST Clients can be used for gaining access to Redfish™resources such
as:
• Applications such as the “Advanced REST Client” and “Postman” from the Google Chrome web store.
• “REST Easy” and “RESTClient” plug-ins for the Firefox browser.
• cURL, Python, and other scripting or programming languages that provide support for dealing with URIs
and for parsing JSON payloads.
Cisco UCS C-Series Servers REST API Programmer's Guide
3
Cisco IMC REST API Overview
Key Technologies

Cisco UCS C-Series Servers REST API Programmer's Guide
4
Cisco IMC REST API Overview
Operational Model

CHAPTER 2
Cisco IMC REST API Examples
This chapter includes the following sections:
•Examples of Server Tasks, on page 5
•Examples of Server Tasks for 3.1(3), on page 51
•Examples of Server Tasks for 4.0(4), on page 84
Examples of Server Tasks
This chapter includes the following examples on how to use the REST API to perform common server tasks:
•Establishing Session-based Authentication, on page 7
•Retrieving Redfish Version without Authentication, on page 9
•Retrieving Service Root without Authentication, on page 10
•Retrieving Metadata without Authentication, on page 10
•Retrieving 'odata' without Authentication, on page 13
•Retrieving Chassis Details, on page 13
•Retrieving Chassis Power Details, on page 14
•Retrieving Chassis Thermal Details, on page 16
•Retrieving Chassis Log Services Details, on page 17
•Retrieving Chassis SEL Details, on page 17
•Retrieving Chassis SEL Entries Details, on page 18
•Retrieving Details of a Specific SEL Entry, on page 19
•Retrieving Manager Details, on page 19
•Retrieving Cisco IMC Information, on page 20
•Retrieving Serial Interface Details, on page 20
•Retrieving Network Protocol Details, on page 21
•Retrieving Ethernet Interfaces Details, on page 22
Cisco UCS C-Series Servers REST API Programmer's Guide
5

•Retrieving Message Registry Information, on page 22
•Enabling an Event Service, on page 23
•Configuring Event Subscribers, on page 24
•Retrieving a List of Subscribers, on page 24
•Retrieving Information about an Event Subscriber with Subscription Key, on page 25
•Updating Event Subscribers, on page 25
•Deleting an Event Subscription, on page 25
•Testing if an Event Receiver is Ready, on page 26
•Retrieving OEM Specific Actions, on page 26
•Retrieving Task Service, on page 27
•Retrieving Tasks, on page 28
•Updating BIOS Firmware, on page 28
•Retrieving BIOS Firmware Update Status, on page 29
•Updating Cisco IMC Firmware, on page 29
•Retrieving Cisco IMC Firmware Update Status, on page 29
•Triggering Cisco IMC Technical Support, on page 30
•Retrieving Cisco IMC Technical Support Status, on page 30
•Exporting Cisco IMC Configuration, on page 31
•Exporting Cisco IMC Configuration Status, on page 31
•Importing Cisco IMC Configuration, on page 31
•Importing Cisco IMC Configuration Status, on page 32
•Setting an Asset Tag Value, on page 32
•Setting an Indicator LED Value to 'Lit', on page 33
•Viewing Session Service, on page 34
•Sessions, on page 34
•Viewing Server ID, on page 34
•Viewing Specific System information, on page 34
•Viewing Processor Information, on page 35
•Viewing Storage Information, on page 37
•Viewing User Accounts, on page 38
•Viewing User Accounts, on page 38
•Roles, on page 39
Cisco UCS C-Series Servers REST API Programmer's Guide
6
Cisco IMC REST API Examples
Examples of Server Tasks

•Logservices, on page 40
•Thermal, on page 41
•Establishing a Session, on page 48
•Accessing the Session Details, on page 49
•Accessing Details of a Particular Session, on page 49
•Adding User, on page 50
•Deleting User, on page 50
•Modifying User, on page 50
•Powering Off a Server, on page 50
•Powering On a Server, on page 50
•Clearing an SEL Log, on page 50
Establishing Session-based Authentication
Request:
curl -XPOST https://10.10.10.10/redfish/v1/SessionService/
Sessions --header "Content-Type: application/json;
charset=utf-8" -d'{"UserName": "admin", "Password": "admin123456"}'
--insecure -v
Response:
* About to connect() to 10.10.10.10 port 222 (#0)
* Trying 10.10.10.10... connected
* Connected to 10.10.10.10 (10.10.10.10) port 222 (#0)
* Initializing NSS with certpath: sql:/etc/pki/nssdb
* warning: ignoring value of ssl.verifyhost
* skipping SSL peer certificate verification
* SSL connection using TLS_RSA_WITH_AES_256_CBC_SHA256
* Server certificate:
* subject: E=null@null,CN=VASU-SL2,OU=PID,O=Cisco
Self Signed,L=San Jose,ST=California,C=US
* start date: Dec 08 05:21:25 2016 GMT
* expire date: Dec 07 05:21:25 2021 GMT
* common name: VASU-SL2
* issuer: E=null@null,CN=VASU-SL2,OU=PID,
O=Cisco Self Signed,L=San Jose,ST=California,C=US
> POST /redfish/v1/SessionService/Sessions HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu)
libcurl/7.19.7 NSS/3.19.1 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: 10.10.10.10
> Accept: */*
> Content-Type: application/json; charset=utf-8
> Content-Length: 47
>
< HTTP/1.1 200 OK
< Server: Monkey
< Date: Fri, 09 Dec 2016 06:01:12 GMT
Cisco UCS C-Series Servers REST API Programmer's Guide
7
Cisco IMC REST API Examples
Examples of Server Tasks

< Transfer-Encoding: Chunked
< X-Auth-Token: 801854885944ad40a8544885a4950d8a
< Status: 201
< Content-Type: application/json
< Content-Length:140
<
{
"@odata.id":"/redfish/v1/SessionService/Sessions/27",
"Description":"Session of user: admin",
"Name":"User Session #27",
"Id":27
}
Request:
curl -GET https://10.10.10.10/redfish/v1/Managers --header
"Authorization: OAuth 801854885944ad40a8544885a4950d8a" --insecure
Response:
{
"Members":[{
"@odata.id":"/redfish/v1/Managers/CIMC"
}],
"Description":"Collection of Managers",
"@odata.type":"#Manager.1.0.0.ManagerCollection",
"@odata.id":"/redfish/v1/Managers",
"[email protected]":1,
"Name":"Manager Collection",
"@odata.context":"/redfish/v1/$metadata#Managers"
}
Request:
curl -GET https://10.10.10.10/redfish/v1/Managers
/CIMC --header "Authorization: OAuth 801854885944ad40a8544885a4950d8a" --insecure
Response:
{
"DateTimeLocalOffset":"UTC+0000",
"Id":"CIMC",
"Links":{
"ManagerForChassis":["/redfish/v1/Chassis/1"],
"ManagerForServers":["/redfish/v1/Systems/FCH1623V07J"]
},
"ManagerType":"CIMC",
"@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity",
"@odata.id":"/redfish/v1/Managers/CIMC",
"VirtualMedia":{
"@odata.id":"/redfish/v1/Managers/CIMC/VirtualMedia"
},
"Description":"VASU-SL2",
"LogServices":{
Cisco UCS C-Series Servers REST API Programmer's Guide
8
Cisco IMC REST API Examples
Examples of Server Tasks

"@odata.id":"/redfish/v1/Managers/CIMC/LogServices"
},
"SerialInterfaces":{
"@odata.id":"/redfish/v1/Managers/CIMC/SerialInterfaces"
},
"FirmwareVersion":"3.0(1S12)",
"UUID":"B2686A10-D5B1-43A3-A808-CC88380DD77B",
"Status":{
"State":"Enabled",
"Health":"OK"
},
"ManagerNetworkProtocol":{
"@odata.id":"/redfish/v1/Managers/CIMC/ManagerNetworkProtocol"
},
"Name":"Cisco Integrated Management Controller",
"Actions":{
"#Oem.ImportBmcConfig":{
"[email protected]":["TFTP","SCP","SFTP","FTP","HTTP"],
"[email protected]":["Passphrase"],
"[email protected]":["Remote Server Username"],
"[email protected]":["Valid Remote Share Path"],
"[email protected]":["Valid Hostname/IP Address"],
"Target":"/redfish/v1/Managers/CIMC/Actions/Oem.ImportBmcConfig",
"[email protected]":["Remote Server Password"]
},
"#Oem.BmcFwUpdate":{
"[email protected]":["TFTP","SCP","SFTP","FTP","HTTP"],
"Target":"/redfish/v1/Managers/CIMC/Actions/Oem.BmcFwUpdate",
"[email protected]":["Remote Server Username"],
"[email protected]":["Valid Remote Share Path"],
"[email protected]":["Valid Hostname/IP Address"],
"[email protected]":["Remote Server Password"]
},
.
.
.
"CommandShell":{
"MaxConcurrentSessions":4,
"ConnectTypesSupported":["SSH","Telnet","IPMI","XML API"],
"ServiceEnabled":true
},
"SerialConsole":{
"MaxConcurrentSessions":4,
"ConnectTypesSupported":["SSH","Telnet","IPMI","XML API"],
"ServiceEnabled":true
},
"Model":"UCSC-C240-M3L",
"EthernetInterfaces":{
"@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces"
}
}
Retrieving Redfish Version without Authentication
Request:
curl -GET https://10.10.10.10/redfish -k
Response:
Cisco UCS C-Series Servers REST API Programmer's Guide
9
Cisco IMC REST API Examples
Examples of Server Tasks

{
"v1":"/redfish/v1/"
}
Retrieving Service Root without Authentication
Request:
curl -GET https://10.10.10.10/redfish/v1 -k
Response:
{
"Chassis":{
"@odata.id":"/redfish/v1/Chassis"
},
"@odata.id":"/redfish/v1/",
"JSONSchemas":{
"@odata.id":"/redfish/v1/JSONSchemas"
},
"RedfishVersion":"1.0.0",
"EventService":{
"@odata.id":"/redfish/v1/EventService"
},
"Systems":{
"@odata.id":"/redfish/v1/Systems"
},
"Description":"Root Service",
"Name":"Cisco RESTful Root Service",
"Links":{
"Sessions":{
"@odata.id":"/redfish/v1/SessionService/Sessions"
}
},
"TaskService":{
"@odata.id":"/redfish/v1/TaskService"
},
"Managers":{
"@odata.id":"/redfish/v1/Managers"
},
"@odata.type":"#ServiceRoot.1.0.0.ServiceRoot",
"SessionService":{
"@odata.id":"/redfish/v1/SessionService"
},
"@odata.context":"/redfish/v1/$metadata#ServiceRoot",
"Id":"RootService",
"AccountService":{
"@odata.id":"/redfish/v1/AccountService"
},
"MessageRegistry":{
"@odata.id":"/redfish/v1/MessageRegistry"
}
}
Retrieving Metadata without Authentication
Request:
Cisco UCS C-Series Servers REST API Programmer's Guide
10
Cisco IMC REST API Examples
Examples of Server Tasks

curl -GET https://10.10.10.10/redfish/v1/\$metadata -k
Response:
<?xml version="1.0" encoding="UTF-8"?><!--
Copyright 2014-2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved.-->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
<edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/
v4.0/cs01/vocabularies/Org.OData.Core.V1.xml">
<edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource.xml">
<edmx:Include Namespace="Resource.1.0.0" />
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions.xml">
<edmx:Include Namespace="RedfishExtensions.1.0.0" Alias="Redfish"/>
<edmx:Include Namespace="Validation.1.0.0" Alias="Validation"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/EventService.xml">
<edmx:Include Namespace="EventService"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/AccountService.xml">
<edmx:Include Namespace="AccountService"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ComputerSystemCollection.xml">
<edmx:Include Namespace="ComputerSystemCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ChassisCollection.xml">
<edmx:Include Namespace="ChassisCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerCollection.xml">
<edmx:Include Namespace="ManagerCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TaskService.xml">
<edmx:Include Namespace="TaskService"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SessionService.xml">
<edmx:Include Namespace="SessionService"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Message.xml">
<edmx:Include Namespace="Message"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/JsonSchemaFileCollection.xml">
<edmx:Include Namespace="JsonSchemaFileCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/MessageRegistryFileCollection.xml">
<edmx:Include Namespace="MessageRegistryFileCollection"/>
</edmx:Reference>
<edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SessionCollection.xml">
<edmx:Include Namespace="SessionCollection"/>
</edmx:Reference>
<edmx:DataServices>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ServiceRoot">
<EntityType Name="ServiceRoot" BaseType="Resource.1.0.0.Resource">
<Annotation Term="OData.Description"
String="This object represents the root Redfish service."/>
Cisco UCS C-Series Servers REST API Programmer's Guide
11
Cisco IMC REST API Examples
Examples of Server Tasks

<Annotation Term="OData.LongDescription"
String="This object represents the root Redfish service.
All values for resources described by this schema shall comply to the requirements
as described in the Redfish specification."/>
</EntityType>
</Schema>
<Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="ServiceRoot.1.0.0">
<EntityContainer Name="ServiceContainer">
<Singleton Name="Service" Type="ServiceRoot.ServiceRoot"/>
<Singleton Name="Systems" Type="ComputerSystemCollection.ComputerSystemCollection"/>
<Singleton Name="Chassis" Type="ChassisCollection.ChassisCollection"/>
<Singleton Name="Managers" Type="ManagerCollection.ManagerCollection"/>
<Singleton Name="Tasks" Type="TaskService.TaskService"/>
<Singleton Name="AccountService" Type="AccountService.AccountService"/>
<Singleton Name="SessionService" Type="SessionService.SessionService"/>
<Singleton Name="EventService" Type="EventService.EventService"/>
<Singleton Name="Registries"
Type="MessageRegistryFileCollection.MessageRegistryFileCollection"/>
<Singleton Name="JsonSchemas"
Type="JsonSchemaFileCollection.JsonSchemaFileCollection"/>
<Singleton Name="Sessions" Type="SessionCollection.SessionCollection"/>
</EntityContainer>
<EntityType Name="ServiceRoot" BaseType="ServiceRoot.ServiceRoot">
<Annotation Term="OData.Description"
String="This object represents the root Redfish service."/>
<Annotation Term="OData.LongDescription"
String="This object represents the root Redfish service.
All values for resources described by this schema shall comply to the
requirements as described in the Redfish specification."/>
<Property Name="RedfishVersion" Type="Edm.String" Nullable="false">
<Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
<Annotation Term="OData.Description" String="The version of the Redfish service"/>
<Annotation Term="OData.LongDescription" String="The value of this string shall
represent the version of the Redfish service.
The format of this string shall be of the format majorversion.minorversion.errata
in compliance with Protocol Version section of the Redfish specification. "/>
<Annotation Term="Validation.Pattern" String="^\\d+\\.\\d+\\.\\d+$"/>
.
.
.
</Property>
</EntityType>
<ComplexType Name="Links" BaseType="Resource.Links">
<NavigationProperty Name="Sessions" Type="SessionCollection.SessionCollection">
<Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
<Annotation Term="OData.Description" String="Link to a collection of Sessions"/>
<Annotation Term="OData.LongDescription"
String="This property shall contain the link to a collection of Sessions."/>
<Annotation Term="OData.AutoExpandReferences"/>
</NavigationProperty>
</ComplexType>
</Schema>
</edmx:DataServices>
Cisco UCS C-Series Servers REST API Programmer's Guide
12
Cisco IMC REST API Examples
Examples of Server Tasks

</edmx:Edmx>
Retrieving 'odata' without Authentication
Request:
curl -GET https://10.10.10.10/redfish/v1/odata -k
Response:
{
"Value":[{
"url":"/redfish/v1",
"name":"Service",
"kind":"Singleton"
},{
"url":"/redfish/v1/Systems",
"name":"Systems",
"kind":"Singleton"
},{
"url":"/redfish/v1/Chassis",
"name":"Chassis",
"kind":"Singleton"
},{
"url":"/redfish/v1/Managers",
"name":"Managers",
"kind":"Singleton"
},{
"url":"/redfish/v1/TaskService",
"name":"TaskService",
"kind":"Singleton"
},{
"url":"/redfish/v1/EventService",
"name":"EventService",
"kind":"Singleton"
},{
"url":"/redfish/v1/AccountService",
"name":"AccountService",
"kind":"Singleton"
},{
"url":"/redfish/v1/SessionService",
"name":"SessionService",
"kind":"Singleton"
},{
"url":"/redfish/v1/JSONSchemas",
"name":"JSONSchemas",
"kind":"Singleton"
},{
"url":"/redfish/v1/MessageRegistry",
"name":"MessageRegistry",
"kind":"Singleton"
}],
"@odata.context":"/redfish/v1/$metadata"
}
Retrieving Chassis Details
Request:
Cisco UCS C-Series Servers REST API Programmer's Guide
13
Cisco IMC REST API Examples
Examples of Server Tasks

curl -GET https://10.10.10.10/redfish/v1/Chassis -k -u admin:Admin123
{
"Members":[{
"@odata.id":"/redfish/v1/Chassis/1"
}],
"@odata.type":"#Chassis.1.0.0.ChassisCollection",
"@odata.id":"/redfish/v1/Chassis",
"Name":"Chassis Collection",
"[email protected]":"1",
"@odata.context":"/redfish/v1/$metadata#Chassis"
}
{
"SerialNumber":"FCH2005V1EN",
"Links":{
"PoweredBy":["/redfish/v1/Chassis/1/Power"],
"CooledBy":["/redfish/v1/Chassis/1/Thermal"],
"ComputerSystems":["/redfish/v1/Systems/FCH2005V1EN"],
"ManagedBy":["/redfish/v1/Managers/CIMC"]
},
"@odata.id":"/redfish/v1/Chassis/1",
"Status":{
"State":"Enabled",
"Health":"Warning"
},
"AssetTag":"Unknown",
"Thermal":{
"@odata.id":"/redfish/v1/Chassis/1/Thermal"
},
"@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity",
"Power":{
"@odata.id":"/redfish/v1/Chassis/1/Power"
},
"LogServices":{
"@odata.id":"/redfish/v1/Chassis/1/LogServices"
},
"@odata.type":"#Chassis.1.0.0.Chassis",
"ChassisType":"Rack",
"Actions":{
"#Chassis.Reset":{
"Target":"/redfish/v1/Chassis/1/Actions/Chassis.Reset",
"[email protected]":["On","ForceOff"]
}
},
"IndicatorLED":"Off",
"Model":"UCS C240 M4S",
"Id":"1"
}
Retrieving Chassis Power Details
Request:
curl -GET https://10.10.10.10/redfish/v1/Chassis/1/Power -k -u
admin:Admin123
{
"Voltages":[{
"@odata.id":"/redfish/v1/Chassis/1/Power#/Voltages/PSU1_VOUT",
"Status":{
"State":"Enabled",
"Health":"OK"
},
"Name":"PSU1_VOUT",
Cisco UCS C-Series Servers REST API Programmer's Guide
14
Cisco IMC REST API Examples
Examples of Server Tasks