Cisco UCS C Series Programmer's Guide

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

Cisco UCS C Series Specifications

General

Brand	Cisco
Model	UCS C Series
Category	Server
Language	English