Cisco UCS C Series Programmer's Manual
  1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Server
  5. UCS C Series
  6. Programmer's manual

Cisco UCS C Series Programmer's Manual

Rest api
Hide thumbs Also See for UCS C Series:
Table of Contents

Advertisement

Quick Links

See also: Configuration Manual , Troubleshooting Tips
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: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the UCS C Series and is the answer not in the manual?

Questions and answers

Related Manuals for Cisco UCS C Series

Summary of Contents for Cisco UCS C Series

  • Page 1 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 http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883...
  • Page 2 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...

  • Page 3: Table Of Contents

    Key Technologies Operational Model C H A P T E R 2 Cisco IMC REST API Examples Examples of Server Tasks Examples of Server Tasks for 3.1(3) Examples of Server Tasks for 4.0(4) Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 4 Contents Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 5: P R E F A C E Preface

    • 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. Note 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.

  • Page 6: Documentation Feedback

    Preface Documentation Feedback Documentation Feedback To provide technical feedback on this document, or to report an error or omission, please send your comments to ucs-docfeedback@external.cisco.com. We appreciate your feedback. Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 7: Cisco Imc Rest Api Overview

    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.

  • Page 8: Management Standard

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

  • Page 9: Key Technologies

    • 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...
  • Page 10 Cisco IMC REST API Overview Operational Model Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 11: Examples Of Server Tasks

    • 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...
  • Page 12 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 •...

  • Page 13: Establishing Session-Based Authentication

    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...
  • Page 14 "Description":"Collection of Managers", "@odata.type":"#Manager.1.0.0.ManagerCollection", "@odata.id":"/redfish/v1/Managers", "Members@odata.count":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...

  • Page 15: Retrieving Redfish Version Without Authentication

    "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "RemotePassword@Redfish.AllowableValues":["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...

  • Page 16: Retrieving Service Root Without Authentication

    "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...
  • Page 17 </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...
  • Page 18 <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...

  • Page 19: Retrieving 'Odata' Without Authentication

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

  • Page 20: Retrieving Chassis Power Details

    "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", "ResetType@Redfish.AllowableValues":["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...
  • Page 21 "Name":"PVPP_GH", "UpperThresholdNonCritical":"N/A", "MemberID":33, "LowerThresholdFatal":"N/A", "LowerThresholdCritical":"2.797", "UpperThresholdCritical":"N/A", "LowerThresholdNonCritical":"2.431", "ReadingVolts":"2.620", "UpperThresholdFatal":"N/A" "@odata.id":"/redfish/v1/Chassis/1/Power", "@odata.type":"#Cisco_Power", "PowerSupplies":[{ "SerialNumber":"DCH2012T0SR", "FirmwareVersion":"10031006", "@odata.id":"/redfish/v1/Chassis/1/Power#/PowerSupplies/PSU1", "LineInputVoltage":"230", "Name":"PSU1", "MemberID":1, "PartNumber":"341-0631-01", "PowerSupplyType":"AC", "Model":"DPST-1200DB A", "LastPowerOutputWatts":"144" "SerialNumber":"DCH2012T0F9", "FirmwareVersion":" 1006", "@odata.id":"/redfish/v1/Chassis/1/Power#/PowerSupplies/PSU2", "LineInputVoltage":"0", "Name":"PSU2", "MemberID":2, "PartNumber":"341-0631-01", "PowerSupplyType":"AC", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 22: Retrieving Chassis Thermal Details

    "MemberID":1, "LowerThresholdNonCritical":"1600", "LowerThresholdCritical":"1200", "ReadingRPM":"5500", "UpperThresholdCritical":"N/A", "UpperThresholdNonCritical":"N/A", "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Fans/1" "UpperThresholdFatal":"N/A", "Status":{ "State":"Enabled", "Health":"OK" "FanName":"FAN2_SPEED", "LowerThresholdFatal":"N/A", "PhysicalContext":"Backplane", "MemberID":2, "LowerThresholdNonCritical":"1600", "LowerThresholdCritical":"1200", "ReadingRPM":"5500", "UpperThresholdCritical":"N/A", "UpperThresholdNonCritical":"N/A", "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Fans/2" "ReadingCelsius":"37.0", "Status":{ "State":"Enabled", "Health":"OK" "Name":"RISER1_OUTLETTMP", "UpperThresholdNonCritical":"N/A", "MemberID":18, "LowerThresholdFatal":"N/A", "LowerThresholdCritical":"70.0", "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Temperatures/RISER1_OUTLET TMP", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 23: Retrieving Chassis Log Services Details

    "Name":"Log Service Collection", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/LogSer vices" Retrieving Chassis SEL Details Request: curl -GET https://10.10.10.10/redfish/v1/Chassis/1/LogServices/SEL -k -u admin:Admin123 "@odata.id":"/redfish/v1/Chassis/1/LogServices/SEL", "Entries":{ "@odata.id":"/redfish/v1/Chassis/1/LogServices/SEL/Entries" "Name":"SEL Log Service", "ServiceEnabled":true, "MaxNumberOfRecords":3008, "DateTime":"Tue Aug 23 23:06:50 2016\n", "@odata.type":"#LogService.1.0.0", "OverWritePolicy":"NeverOverWrites", "Id":"SEL", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/LogSer Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 24: Retrieving Chassis Sel Entries Details

    "Created":"2016-08-23 22:43:26 " "@odata.id":"/redfish/v1/Managers/1/LogSerivce/SEL/Entries/1247", "Id":"1247", "EntryType":"SEL", "Severity":"Informational", "Message":"LED_FAN_STATUS: Platform sensor, AMBER was deasserted", "Created":"2016-08-23 22:43:26 " "@odata.id":"/redfish/v1/Managers/1/LogSerivce/SEL/Entries/1246", "Id":"1246", "EntryType":"SEL", "Severity":"Informational", "Message":"LED_FAN_STATUS: Platform sensor, FAST BLINK event was deasserted", "Created":"2016-08-23 22:43:26 " Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 25: Retrieving Details Of A Specific Sel Entry

    "EntryType":"SEL", "Message":"LED_PSU_STATUS: Platform sensor, GREEN was asserted", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/LogSer vices/Members/$entity/Entries/Members/$entity", "@odata.type":"#LogEntry.1.0.0", "Severity":"Informational", "Id":"1201", "Created":"2016-04-08 05:21:44 " Retrieving Manager Details Request: curl -GET https://10.10.10.10/redfish/v1/Managers -k -u admin:Admin123 "Members":[{ "@odata.id":"/redfish/v1/Managers/CIMC" "@odata.type":"#Manager.1.0.0.ManagerCollection", "@odata.id":"/redfish/v1/Managers", "Name":"Manager Collection", "@odata.context":"/redfish/v1/$metadata#Managers" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 26: Retrieving Cisco Imc Information

    "ServiceEnabled":true "DateTime":"Tue Aug 23 23:20:10 2016\n", "@odata.type":"#Manager.1.0.0.Manager", "GraphicalConsole":{ "MaxConcurrentSessions":4, "ConnectTypesSupported":["KVMIP","WebUI"], "ServiceEnabled":true "@odata.id":"/redfish/v1/Managers/CIMC", "SerialConsole":{ "MaxConcurrentSessions":4, "ConnectTypesSupported":["SSH","Telnet","IPMI","XML API"], "ServiceEnabled":true "Actions":{ "#Manager.Reset":{ "Target":"/redfish/v1/Managers/CIMC/Actions/Manager.Reset", "ResetType@Redfish.AllowableValues":["On","ForceOff"] "EthernetInterfaces":{ "@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces" Retrieving Serial Interface Details Request: curl -GET https://10.10.10.10/redfish/v1/Managers/CIMC/SerialInterfaces - Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 27: Retrieving Network Protocol Details

    "Parity":"None", "Description":"Management for Serial Interface" Retrieving Network Protocol Details Request: curl -GET https://10.10.10.10/redfish/v1/Managers/CIMC/ManagerNetworkProtocol -k -u admin:Admin123 "@odata.id":"/redfish/v1/Managers/CIMC/ManagerNetworkProtocol", "KVMIP":{ "ProtocolEnabled":true, "Port":2068 "SNMP":{ "ProtocolEnabled":false, "Port":161 "Id":"ManagerNetworkProtocol", "@odata.type":"#ManagerNetworkProtocol.1.0.0", "Name":"Manager Network Protocol", "@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity/Manag erNetworkProtocol", "httpsS":{ "ProtocolEnabled":true, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 28: Retrieving Ethernet Interfaces Details

    "Description":"Collection of EthernetInterfaces for this Manager", "Name":"Ethernet Intefaces Collection", "@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity/Ether netInterfaces" Retrieving Message Registry Information Request: curl -GET https://10.10.10.10/redfish/v1/MessageRegistry -u admin:password --insecure Response: "RegistryVersion":"1.0.0", "OwningEntity":"Cisco Systems Inc.", "Name":"Message Registry", "@odata.context":"/redfish/v1/$metadata#MessageRegistry", "@odata.id":"/redfish/v1/MessageRegistry", "@odata.type":"#MessageRegistry.1.0.0.MessageRegistry", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 29: Enabling An Event Service

    "Description":"Fan speed for fan-x is lower critical" "F0424":{ "Oem":{ "MessageId":20 "Message":"", "NumberOfArgs":0, "Severity":"major", "Resolution":"Replace Battery", "Description":"Battery voltage level is lower critical" "Id":"Message Registry", "Description":"This registry defines the Fault messages for Redfish" Enabling an Event Service Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 30: Configuring Event Subscribers

    "HttpHeaders":["Authorization:BasicYWRtaW46cGFzc3dvcmQ=", "X-MyHeader:123"]}' -u admin:password -insecure Response: "subscriberKey":"351357385644ea45d8544885d7655a8d" Retrieving a List of Subscribers Request: curl -GET https://10.10.10.10/redfish/v1/EventService /Subscriptions -u admin:password -k Response: "Members":[{ "@odata.id":"/redfish/v1/EventService/Subscriptions /771756785144ea475854488556157a85" "@odata.id":"/redfish/v1/EventService/Subscriptions /881856885144ea489854488596158a49" "Description":"List of Event subscriptions", "@odata.type":"#EventService.1.0.0.EventDestinationCollection", "@odata.id":"/redfish/v1/EventService/Subscriptions", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 31: Retrieving Information About An Event Subscriber With Subscription Key

    Updating Event Subscribers Request: curl -XPATCH https://10.10.10.10/redfish/v1 /EventService/Subscriptions /351357385644ea45d8544885d7655a8d -d '{"Context":"Cisco"}' -u admin:password --insecure Response: "Descritiom":"Event Subscription Details", "Context":"Cisco", "Id":"351357385644ea45d8544885d7655a8d", "Destination":"10.104.255.59", "Protocol":"Redfish", "Name":"EventSubscription 351357385644ea45d8544885d7655a8d", "EventTypes":["Alert"] Deleting an Event Subscription Request: curl -XDELETE https://10.10.10.10/redfish/v1/EventService Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 32: Testing If An Event Receiver Is Ready

    "Message":"Test event from Cisco IMC Redfish Engine", "Context":"mike-alert" Retrieving OEM Specific Actions Request: curl -GET https://10.10.10.10/redfish/v1/Managers/CIMC --insecure -u admin:password Response: "DateTimeLocalOffset":"UTC+0530", "Id":"CIMC", "Links":{ "ManagerForChassis":["/redfish/v1/Chassis/1"], "ManagerForServers":["/redfish/v1/Systems/FCH2005V1E4"] "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":"", "LogServices":{ "@odata.id":"/redfish/v1/Managers/CIMC/LogServices" "SerialInterfaces":{ "@odata.id":"/redfish/v1/Managers/CIMC/SerialInterfaces" "FirmwareVersion":"3.0(1S8)", "UUID":"E320FC46-31AC-4D93-BA64-C7FE5A139628", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 33: Retrieving Task Service

    "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "Target":"/redfish/v1/Managers/CIMC/Actions/Oem.ExportBmcConfig", "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] "#Oem.BmcTechSupportExport":{ "Protocol@Redfish.AllowableValues":["TFTP","SCP","SFTP","FTP","HTTP"], "Target":"/redfish/v1/Managers/CIMC/Actions/Oem.BmcTechSupportExport", "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] Retrieving Task Service Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 34: Retrieving Tasks

    "Status":{ "State":"Enabled", "Health":"OK" "Description":"Tasks Service" Retrieving Tasks Request: curl -GET https://10.10.10.10/redfish/v1/TaskService/ Tasks -u admin:password -k Response: "Members":[{ "@odata.id":"/redfish/v1/TaskService/Tasks/BmcFwUpdate" "@odata.id":"/redfish/v1/TaskService/Tasks/BiosFwUpdate" "@odata.id":"/redfish/v1/TaskService/Tasks/BmcTechSupportExport" "@odata.id":"/redfish/v1/TaskService/Tasks/ImportBmcConfig" "@odata.id":"/redfish/v1/TaskService/Tasks/ExportBmcConfig" "Description":"Tasks", "@odata.type":"#TaskCollection.1.0.0.TaskCollection", "@odata.id":"/redfish/v1/TaskService/Tasks", "Members@odata.count":5, "Name":"Tasks", "@odata.context":"/redfish/v1/$metadata#TaskService/Tasks" Updating BIOS Firmware Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 35: Retrieving Bios Firmware Update Status

    Oem.BmcFwUpdate -d '{"RemoteHostname":"10.10.10.10", "RemotePath":"mike/FW/upd-pkg-c220-m4-cimc.full.3.0.0.275.bin", "Protocol":"TFTP"}' --insecure admin:password Response: Note: curl with verbose option enabled receives an http response '202 Accepted' for the above query. Retrieving Cisco IMC Firmware Update Status Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 36: Triggering Cisco Imc Technical Support

    '202 Accepted' for the above query. Retrieving Cisco IMC Technical Support Status Request: curl -GET https://10.10.10.10/redfish/v1/TaskService/Tasks/ BmcTechSupportExport --insecure -u admin:password Response: "@odata.id":"/redfish/v1/TaskService/Tasks/BmcTechSupportExport", "Name":"Task BmcTechSupportExport", "@odata.context":"/redfish/v1/$metadata#TaskService/Tasks/Members/$entity", "TaskStatus":"OK", "@odata.type":"#Task.1.0.0", "Id":"BmcTechSupportExport", "TaskState":"Running", "Oem":{ "RemoteHostName":"10.10.10.10", "RemotePath":"/home/mike/dan/techSupport.tar.gz", "ExportStatus":"Collecting Data (0%)", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 37: Exporting Cisco Imc Configuration

    Response: "@odata.id":"/redfish/v1/TaskService/Tasks/ExportBmcConfig", "Name":"Task ExportBmcConfig", "@odata.context":"/redfish/v1/$metadata#TaskService/Tasks/Members/$entity", "TaskStatus":"OK", "@odata.type":"#Task.1.0.0", "Id":"ExportBmcConfig", "TaskState":"Completed", "Oem":{ "ExportStatus":"Completed" "Description":"Export BMC Configuration" Importing Cisco IMC Configuration Request: curl -POST https://10.10.10.10/redfish/v1/Managers/CIMC/Actions/ Oem.ImportBmcConfig -d '{"RemoteHostname":"10.10.10.10", "RemotePath":"/home/mike/tom/cimc_export.xml", "Passphrase":"testtest","Protocol":"scp", "RemoteUsername":"mike", "RemotePassword":"1234game"}' --insecure -u admin:password Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 38: Importing Cisco Imc Configuration Status

    -XPATCH https://10.10.10.10/redfish/v1/Systems /FCH2005V1E4 -d '{"AssetTag":"Cisco123"}' --insecure -u admin:password Response: "SerialNumber":"FCH2005V1E4", "Boot":{ "BootSourceOverrideEnabled":"Disabled", "BootSourceOverrideTarget":"None" "Id":"FCH2005V1E4", "AssetTag":"Cisco123", "PowerState":"On", "SystemType":"Physical", "ProcessorSummary":{ "Model":"Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz", "Count":2 "HostName":"C240-FCH2005V1E4", "MemorySummary":{ "TotalSystemMemoryGiB":128, "State":{ "HealthRollup":"OK", "Health":"OK" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 39: Setting An Indicator Led Value To 'Lit

    "PowerState":"On", "SystemType":"Physical", "ProcessorSummary":{ "Model":"Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz", "Count":2 "HostName":"C240-FCH2005V1E4", "MemorySummary":{ "TotalSystemMemoryGiB":128, "State":{ "HealthRollup":"OK", "Health":"OK" "Description":"", "UUID":"E320FC46-31AC-4D93-BA64-C7FE5A139628", "Status":{ "State":"Enabled", "Health":"Warning" "Name":"UCS C240 M4S", "Manufacturer":"Cisco Systems", "IndicatorLED":"Lit", "Model":"UCS C240 M4S", "BiosVersion":"C240M4.2.0.9b.0.012520161828" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 40: Viewing Session Service

    Viewing Server ID Request: curl -GET https://10.10.10.10/redfish/v1/Systems -k -u admin:Admin123 "Members":[{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN" "@odata.type":"#Cisco_ComputerSystemCollection", "@odata.id":"/redfish/v1/Systems", "Name":"Computer System Collection", "@odata.context":"/redfish/v1/$metadata#Systems" Viewing Specific System information Request: curl -GET https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN -k -u admin:Admin123 "SerialNumber":"FCH2005V1EN", "Boot":{ "BootSourceOverrideEnabled":"Disabled", "BootSourceOverrideTarget":"None" "Id":"FCH2005V1EN", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 41: Viewing Processor Information

    "ManagedBy":["/redfish/v1/Managers/CIMC"] "Name":"UCS C240 M4S", "BiosVersion":"C240M4.2.0.9b.0.012520161828", "LogServices":{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/LogServices" "Actions":{ "#System.Reset":{ "Target":"/redfish/v1/Systems/FCH2005V1EN/Actions/System.Reset", "ResetType@Redfish.AllowableValues":["On","ForceOff","GracefulShutdown ","ForceRestart","Nmi"] "@odata.type":"#Cisco_ComputerSystem", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity", "@odata.id":"/redfish/v1/Systems/FCH2005V1EN", "IndicatorLED":"Off", "Model":"UCS C240 M4S", "EthernetInterfaces":{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/EthernetInterfaces" Viewing Processor Information Request: curl -GET https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/Processors - k -u admin:Admin123 Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 42 "Description":"Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz/90W 8C/20MB Cache/DDR4 1866MHz", "ProcessorArchitecture":"x86", "Status":{ "State":"Enabled" "ProcessorType":"CPU", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Proces sors/Members/$entity", "TotalThreads":"16", "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/Processors/CPU2", "TotalCores":"8", "@odata.type":"#Cisco_ComputerProcessor", "Id":"2", "Manufacturer":"Intel(R) Corporation", "MaxSpeedMHz":"4000", "Model":"Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz", "Socket":"CPU2" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 43: Viewing Storage Information

    T-HBA -k -u admin:Admin123 "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/SimpleStorage/SLOTHBA", "Id":"SLOT-HBA", "@odata.type":"#Cisco_ComputerStorage", "Devices":[{ "Status":{ "State":"Enabled", "Health":"Good" "Name":"PD-1", "Manufacturer":"HITACHI" "Status":{ "State":"Enabled", "Health":"Good" "Name":"PD-2", "Manufacturer":"HITACHI" "Name":"PD-3", "Status":{ "State":"Absent" "Name":"PD-4", "Status":{ "State":"Absent" "Name":"PD-5", "Status":{ "State":"Absent" "Name":"PD-6", "Status":{ "State":"Absent" "Name":"PD-7", "Status":{ "State":"Absent" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 44: Viewing User Accounts

    "@odata.id":"/redfish/v1/AccountService/Accounts" "Id":"AccountService", "Name":"Account Service", "@odata.context":"/redfish/v1/$metadata#AccountService", "@odata.type":"#AccountService.1.0.0", "Roles":{ "@odata.id":"/redfish/v1/AccountService/Roles" "ServiceEnabled":true, "@odata.id":"/redfish/v1/AccountService", "Description":"Account Service" Viewing User Accounts Request: curl -GET https://10.10.10.10/redfish/v1/AccountService/Accounts -k -u admin:Admin123 "Members":[{ "@odata.id":"/redfish/v1/AccountService/Accounts/1" "@odata.id":"/redfish/v1/AccountService/Accounts/2" "@odata.id":"/redfish/v1/AccountService/Accounts/3" "@odata.type":"#ManagerAccountCollection.1.0.0.ManagerAccountCollectio n", "@odata.id":"/redfish/v1/AccountService/Accounts", "Name":"Account Collection", "@odata.context":"/redfish/v1/$metadata#AccountService/Accounts" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 45: Roles

    "@odata.id":"/redfish/v1/AccountService/Accounts/2", "Links":{ "Role":["/redfish/v1/AccountService/Roles/user"] "Name":"User Account", "@odata.context":"/redfish/v1/$metadata#AccountService/Accounts/Member s/$entity", "@odata.type":"#ManagerAccount.1.0.0", "RoleId":"user", "Description":"User Account", "Id":"2", "Enabled":true, "Locked":false, "UserName":"username" Roles Request: curl -GET https://10.10.10.10/redfish/v1/AccountService/Roles -k -u admin:Admin123 "Members":[{ "@odata.id":"/redfish/v1/AccountService/Roles/admin" "@odata.id":"/redfish/v1/AccountService/Roles/user" "@odata.id":"/redfish/v1/AccountService/Roles/read-only" "@odata.type":"#RoleCollection.1.0.0.RoleCollection", "@odata.id":"/redfish/v1/AccountService/Roles", "Name":"Roles Collection", "@odata.context":"/redfish/v1/$metadata#AccountService/Roles" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 46: Logservices

    "@odata.context":"/redfish/v1/$metadata#AccountService/Roles/Members/$ entity", "@odata.type":"#Role.1.0.0", "OEMPrivileges":[], "Id":"read-only", "Description":"ReadOnly User Role" Logservices Request: curl -GET https://10.10.10.10/redfish/v1/Chassis/1/LogServices/SEL/Entries\?\$ top=2 -k -u admin:Admin123 "Members":[{ "@odata.id":"/redfish/v1/Managers/1/LogSerivce/SEL/Entries/1250", "Id":"1250", "EntryType":"SEL", "Severity":"Normal", "Message":"Node Manager: Operational Capabilities, Policy Interface:Available Monitoring:Available Power Limiting:Available ", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 47: Thermal

    "Description":"Log Entry 278", "Name":"Log Entry 278", "Severity":"Normal", "Id":"278", "Created":"2016-12-09 04:11:24 " "@odata.count":"281", "@odata.id":"/redfish/v1/Managers/CIMC/LogServices/SEL/Entries", "@odata.type":"#LogEntry.1.0.0.LogEntryCollection", "Members@odata.count":2, "@odata.context":"/redfish/v1/$metadata#Managers /Members/$entity/LogServices/Members/$entity/Entries" Thermal Request: curl -GET https://10.10.10.10/redfish/v1/Chassis/1/Thermal#/Temperatures/MLOM_ TMP -k -u admin:Admin123 "Fans": [ "UpperThresholdFatal": "N/A", "Status": { Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 48 "UpperThresholdNonCritical": "N/A", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/3" "UpperThresholdFatal": "N/A", "Status": { "State": "Enabled", "Health": "OK" "FanName": "FAN4_SPEED", "LowerThresholdFatal": "N/A", "PhysicalContext": "Backplane", "MemberID": 4, "LowerThresholdNonCritical": "1600", "LowerThresholdCritical": "1200", "ReadingRPM": "5700", "UpperThresholdCritical": "N/A", "UpperThresholdNonCritical": "N/A", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/4" Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 49 "Health": "OK" "Name": "MLOM_TMP", "UpperThresholdNonCritical": "N/A", "MemberID": 1, "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "90.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/MLOM_TMP", "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "85.0", "UpperThresholdFatal": "N/A" "ReadingCelsius": "26.0", "Status": { "State": "Enabled", "Health": "OK" "Name": "FP_TEMP_SENSOR", "UpperThresholdNonCritical": "N/A", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 50 "ReadingCelsius": "32.0", "Status": { "State": "Enabled", "Health": "OK" "Name": "DDR4_P1_C1_TEMP", "UpperThresholdNonCritical": "N/A", "MemberID": 5, "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "85.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/DDR4_P1_C1_TEMP", "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "65.0", "UpperThresholdFatal": "N/A" "ReadingCelsius": "31.0", "Status": { "State": "Enabled", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 51 "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "65.0", "UpperThresholdFatal": "N/A" "ReadingCelsius": "33.0", "Status": { "State": "Enabled", "Health": "OK" "Name": "DDR4_P2_G1_TEMP", "UpperThresholdNonCritical": "N/A", "MemberID": 9, "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "85.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/DDR4_P2_G1_TEMP", "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "65.0", "UpperThresholdFatal": "N/A" Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 52 "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "82.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/P2_TEMP_SENS", "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "77.0", "UpperThresholdFatal": "N/A" "ReadingCelsius": "32.0", "Status": { "State": "Enabled", "Health": "OK" "Name": "PSU1_TEMP", "UpperThresholdNonCritical": "N/A", "MemberID": 13, "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "65.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/PSU1_TEMP", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 53 "Name": "RISER2_INLET_TMP", "UpperThresholdNonCritical": "N/A", "MemberID": 16, "LowerThresholdFatal": "N/A", "LowerThresholdCritical": "70.0", "@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/RISER2_INLET_TMP", "LowerThresholdNonCritical": "N/A", "UpperThresholdCritical": "60.0", "UpperThresholdFatal": "N/A" "ReadingCelsius": "33.0", "Status": { "State": "Enabled", "Health": "OK" "Name": "RISER1_INLET_TMP", "UpperThresholdNonCritical": "N/A", "MemberID": 17, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 54: Establishing A Session

    '-d{"Username": "admin", "Password": "password123"}' –insecure –v > POST /redfish/v1/SessionService/Sessions https/1.1 > User-Agent: curl/7.19.7 (i386-redhat-linux-gnu) libcurl/7.19.7 NSS/3.14.0.0 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: 46 > Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 55: Accessing The Session Details

    Accessing Details of a Particular Session Request: curl -GET https://10.10.10.10/redfish/v1/SessionService/Sessions/117 --header 'Authorization: OAuth a81a53a75544d448d7544775d355840d' --insecure "Id":"117", "Name":"User Session #117", "@odata.context":"/redfish/v1/$metadata#SessionService/Sessions/Member s/$entity", "Oem":{ "SessionType":"redfish", "RemoteIP":"10.10.10.10" "@odata.type":"#Session.1.0.0", "UserName":"admin", "@odata.id":"/redfish/v1/SessionService/Sessions/117", "Description":"redfish session for user admin" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 56: Adding User

    Powering Off a Server Request: curl -vv https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/Actions/System.Reset -d '{"ResetType":"ForceOff"}' --insecure -u admin:Admin123 Powering On a Server Request: curl -vv https://10.10.10.10/redfish/v1/Systems /FCH2005V1EN/Actions/System.Reset -d '{"ResetType":"On"}' --insecure -u admin:Admin123 Clearing an SEL Log Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 57: Examples Of Server Tasks For 3.1(3)

    Viewing Specific System Information Response: "SerialNumber":"FCH1845V1X6", "Id":"FCH1845V1X6", "IndicatorLED":"Off", "PowerState":"On", "ProcessorSummary":{ "Model":"Intel(R) Xeon(R) CPU E5-2695 v3 @ 2.30GHz", "Count":2 "NetworkInterfaces":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/NetworkInterfaces" "Storage":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage" "BIOS":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/BIOS" "UUID":"C68B1C5B-C012-4C08-BACC-A45BFE15CC8F", "Name":"UCS C220 M4L", "@odata.type":"#Cisco_ComputerSystem", "Manufacturer":"Cisco Systems", "Actions":{ "#ComputerSystem.Reset":{ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 58: Host

    "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeFunctions/L" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeFunctions/MLOM" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeFunctions/HBA" "SystemType":"Physical", "BiosVersion":"C220M4.4.0.1b.0.0629181250", "HostName":"svbu-qa-blr-dn1-103-bmc", "MemorySummary":{ "TotalSystemMemoryGiB":64, "State":{ "HealthRollup":"OK", "Health":"OK" "Processors":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Processors" "PCIeFunctions@odata.count":3, "Description":"", "SimpleStorage":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/SimpleStorage" "PCIeDevices":[{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeDevices/L" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeDevices/MLOM" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/PCIeDevices/HBA" "Status":{ "State":"Enabled", "Health":"Ok" "Links":{ "CooledBy":["/redfish/v1/Chassis/1/Thermal"], "Chassis":["/redfish/v1/Chassis/1"], "PoweredBy":["/redfish/v1/Chassis/1/Power"], "ManagedBy":["/redfish/v1/Managers/CIMC"] "SecureBoot":{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/SecureBoot" "LogServices":{ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 59: Retrieving Chassis

    The non-cpu/device centric parts of the schema are all accessed either directly or indirectly through this resource", "Thermal": { "@odata.id": "/redfish/v1/Chassis/1/Thermal" "Links": { "Drives": [ "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-1", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-2", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-3", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-4", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-5", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-6", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-7", "/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-8", "/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0/Drives/SLOT-1", "/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0/Drives/SLOT-2" "CooledBy": [ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 60: Retrieving Chassis Power Details

    "ResetType@Redfish.AllowableValues": [ "On", "ForceOff" "Manufacturer": "Cisco Systems Inc.", "IndicatorLED": "Off", "Model": "UCS C240 M4S", "Id": "1" Retrieving Chassis Power Details Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Chassis/1/Power | json_reformat Response: <SNIP> "PowerControl":{ "PhysicalContext":"PowerSupply", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 61: Retrieving Cisco Imc Information

    "MemberID": 1, "LastPowerOutputWatts": "168", "SparePartNumber": "341-0631-01", "PartNumber": "341-0631-01", "PowerSupplyType": "AC", "Model": "DPST-1200DB A", "LineInputVoltageType": "AC" Retrieving Cisco IMC Information Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Managers/CIMC Response: "DateTimeLocalOffset":"UTC+0000", "Id":"CIMC", "Links":{ "ManagerForChassis":["/redfish/v1/Chassis/1"], "ManagerForServers":["/redfish/v1/Systems/WZP21080FBD"], "ManagerInChassis":["/redfish/v1/Chassis/1"] Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 62 "Target":"/redfish/v1/Managers/CIMC/Actions/Oem.BiosFwUpdate", "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] "#Oem.ExportBmcConfig":{ "Protocol@Redfish.AllowableValues":["TFTP","SCP","SFTP","FTP","HTTP"], "Passphrase@Redfish.AllowableValues":["Passphrase"], "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "Target":"/redfish/v1/Managers/CIMC/Actions/Oem.ExportBmcConfig", "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] "#Oem.BmcTechSupportExport":{ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 63: Retrieving Details Of A Specific Sel Entry

    "EventTimestamp":"2018-07-17 23:38:32 ", "Id":"1", "EntryType":"SEL", "Name":"Log Entry 1", "@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity/LogServices/Members/$entity/Entries/Members/$entity", "EventType":"StatusChange", "@odata.type":"#LogEntry.1.0.0", "EventId":"1", "Message":"FRU_RAM SEL_FULLNESS: Event Log sensor for FRU_RAM, Log Area Reset/Cleared was asserted", "Description":"Log Entry 1", "Severity":"Normal", "@odata.id":"/redfish/v1/Managers/CIMC/LogServices/SEL/Entries/1", "Created":"2018-07-17 23:38:32 " Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 64: Retrieving Service Root Without Authentication

    "Name":"Cisco RESTful Root Service", "Description":"Root Service", "TaskService":{ "@odata.id":"/redfish/v1/TaskService" "MessageRegistry":{ "@odata.id":"/redfish/v1/MessageRegistry" "@odata.type":"#ServiceRoot.1.2.0.ServiceRoot", "SessionService":{ "@odata.id":"/redfish/v1/SessionService" "@odata.context":"/redfish/v1/$metadata#ServiceRoot", "Managers":{ "@odata.id":"/redfish/v1/Managers" "AccountService":{ "@odata.id":"/redfish/v1/AccountService" "Id":"RootService" Viewing User Accounts Response: "Accounts":{ "@odata.id":"/redfish/v1/AccountService/Accounts" "AccountLockoutThreshold":0, "Id":"AccountService", "AccountLockoutDuration":0, "MaxPasswordLength":20, "MinPasswordLength":8, "AccountLockoutCounterResetAfter":0, "Description":"Account Service", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 65: Examples Of New Additions In 3.1(3) Release

    This section includes the following examples on how to use the REST API to perform common server tasks for 3.1(3) release: • Retrieving Cisco IMC Managers Ethernet Interfaces and NICS, on page 60 • Retrieving Cisco IMC Log Entries, on page 61 •...

  • Page 66: Retrieving Cisco Imc Managers Ethernet Interfaces And Nics

    Configuring Port and Protocol Enabled in Manager Network Protocol, on page 79 • Retrieving PCIe Devices, on page 80 • Retrieving PCIe Functions, on page 81 • Retrieving Privilege Map, on page 81 Retrieving Cisco IMC Managers Ethernet Interfaces and NICS Request: curl -k -u admin:xxxx https://10.10.10.10/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs Response: "FQDN":"svbu-qa-blr-dn1-103-bmc", "IPv6DefaultGateway":"::", "Id":"NICs", "NameServers":["171.70.168.183","171.68.226.120"],...

  • Page 67: Retrieving Cisco Imc Log Entries

    "@odata.id":"/redfish/v1/Managers/CIMC/LogServices/CIMC/Entries/2", "Created":"2019 May 3 11:29:41 UTC" "EventTimestamp":"2019 May 3 11:29:41 UTC", "Id":3, "EntryType":"CIMC", "Name":"Log Entry 3", "EventType":"Alert", "EventId":3, "Message":" obj/../../src/LogAgent.cc:956:CIMC log clear\n", "Description":"Log Entry 3", "Severity":"Notice", "@odata.id":"/redfish/v1/Managers/CIMC/LogServices/CIMC/Entries/3", "Created":"2019 May 3 11:29:41 UTC" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 68: Retrieving Bios Tokens

    3 11:29:45 UTC" Retrieving BIOS Tokens Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/BIOS Response: "Id":"BiosToken", "Name":"BiosToken", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/BIOS", "@odata.type":"#Cisco_BiosToken", "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/BIOS", "Attributes":{ "IntelVT":"Enabled", "PcieSlotRiser1LinkSpeed":"GEN3", "AllLomPortControl":"Enabled", "NUMAOptimize":"Enabled", "PchUsb30Mode":"Disabled", "cdnEnable":"Disabled", "EnhancedIntelSpeedStep":"Enabled", "LegacyUSBSupport":"Enabled", "PcieSlotMLOMLinkSpeed":"GEN3", "QPILinkFrequency":"Auto", "UsbPortRear":"Enabled", "IntelHyperThread":"Enabled", "SrIov":"Enabled", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 69 "UsbPortKVM":"Enabled", "ProcessorC1E":"Enabled", "UsbPortFront":"Enabled", "AdjacentCacheLinePrefetch":"Enabled", "TerminalType":"VT100", "BaudRate":"115200", "MemoryMappedIOAbove4GB":"Enabled", "CpuEngPerfBias":"Balanced Performance", "PassThroughDMA":"Disabled", "LomOpromControlPort0":"Enabled", "UsbPortVMedia":"Enabled", "QpiSnoopMode":"Auto", "HWPMEnable":"Disabled", "DcuIpPrefetch":"Enabled", "PcieSlotMLOMOptionROM":"Enabled", "InterruptRemap":"Enabled", "DemandScrub":"Enabled", "DirectCacheAccess":"Auto", "CmciEnable":"Enabled", "AutonumousCstateEnable":"Disabled", "ChannelInterLeave":"Auto", "IntelTurboBoostTech":"Enabled", "PcieSlotN1OptionROM":"Enabled", "IntelVTD":"Enabled", "ATS":"Enabled", "ExecuteDisable":"Enabled", "DcuStreamerPrefetch":"Enabled", "PCIeSSDHotPlugSupport":"Disabled", "PcieSlot2OptionROM":"Enabled", "LomOpromControlPort1":"Enabled", "CoreMultiProcessing":"All", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 70: Configuring Bios Tokens

    "State":"Enabled", "Health":"OK" "Attributes":{ "TPMAdminCtrl":"Disabled", "POPSupport":"Disabled", "OSBootWatchdogTimerPolicy":"Power Down", "OSBootWatchdogTimerTimeout":"15 mins", "FRB-2":"Enabled", "OSBootWatchdogTimer":"Enabled", "IntelVT":"Enabled", "AllLomPortControl":"Enabled", "NUMAOptimize":"Enabled", "PchUsb30Mode":"Disabled", "cdnEnable":"Disabled", "CmciEnable":"Disabled", "LegacyUSBSupport":"Enabled", "PcieSlotHBAOptionROM":"Enabled", "PcieSlot5OptionROM":"Disabled", "QPILinkFrequency":"Auto", "UsbPortRear":"Enabled", "IntelHyperThread":"Disabled", "SrIov":"Enabled", "PCIROMCLP":"Disabled", "SelectMemoryRAS":"Mirroring", "DirectCacheAccess":"Enabled", "PcieOptionROMs":"Enabled", "RedirectionAfterPOST":"Always Enable", "UsbEmul6064":"Enabled", "FlowCtrl":"None", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 71 "CpuEngPerfBias":"Performance", "PassThroughDMA":"Disabled", "LomOpromControlPort0":"Enabled", "PcieSlot6OptionROM":"Disabled", "DcuIpPrefetch":"Enabled", "HWPMEnable":"Disabled", "DemandScrub":"Enabled", "PcieSlotMLOMOptionROM":"Enabled", "InterruptRemap":"Enabled", "HardwarePrefetch":"Enabled", "PcieSlotRiser2Slot4LinkSpeed":"GEN3", "LocalX2Apic":"XAPIC", "ChannelInterLeave":"Auto", "ConsoleRedir":"COM 0", "PcieSlotFLOMLinkSpeed":"GEN3", "CoherencySupport":"Disabled", "IntelVTD":"Disabled", "DcuStreamerPrefetch":"Enabled", "ExecuteDisable":"Enabled", "LomOpromControlPort1":"Enabled", "PCIeSSDHotPlugSupport":"Disabled", "PackageCstateLimit":"C6 Retention", "CoreMultiProcessing":"All", "PcieSlotRiser1Slot1LinkSpeed":"GEN3", "VgaPriority":"Onboard", "Altitude":"300 M", "AutonumousCstateEnable":"Disabled", "PcieSlotSSDSlot1LinkSpeed":"GEN3", "EnhancedIntelSpeedStep":"Enabled", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 72: Resetting Bios Action

    "Description":"Collection of storage resource instances for this system", "@odata.type":"#Cisco_StorageCollection", "@odata.id":"/redfish/v1/Systems/ FCH2005V1EN /Storage", "Members@odata.count":2, "Name":"Storage Collection", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage" Retrieving Individual Storage Controller Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA Response: "Drives":[{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-1" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-2" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-3" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-4" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 73: Retrieving Individual Drives

    "Model":"Cisco 12G SAS Modular Raid Controller", "FirmwareVersion":"4.620.00-7309" "Actions":{ "#Storage.SetEncryptionKey":{ "SecurityKey@Redfish.AllowableValues":["Security Key"], "target":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Actions/Storage.SetEncryptionKey", "SecurityKeyId@Redfish.AllowableValues":["Security Key Identifier"] "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity" Retrieving Individual Drives Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-1 Response: "SerialNumber":"Z1W2Q2J20000W502J4QN", "Id":"PD-1", "IndicatorLED":"Off", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity/Drives/Members/$entity", "CapableSpeedGbs":"6.0", "Location":"SLOT-1", "StatusIndicator":"OK", "MediaType":"HDD", "Actions":{ "#Drive.SecureErase":{ "target":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-1/Actions/Drive.SecureErase" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 74: Performing Secureerase On Drives

    Performing SecureErase on Drives Request: curl -XPOST -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/Storage/SLOT-HBA/Drives/PD-8/Actions/Drive.SecureErase -d'{}' Response: "error":{ "message":"Specified physical drive is not FDE capable", "code":"InternalError" Retrieving Volumes Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Volumes Response: "Members":[{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Volumes/VD-0" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 75: Retrieving Individual Volumes

    "Encrypted":"false", "Status":{ "State":"Enabled", "Health":"OK" "Operations":{ "PercentageComplete":"0", "OperationName":"No operation in progress" "Name":"", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity/Volumes/Members/$entity", "Actions":{ "#Volume.Initialize":{ "target":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Volumes/VD-0/Actions/Volume.Initialize" "@odata.type":"#Cisco_Volumes", "CapacityBytes":998999326720, "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Volumes/VD-0", "Links":{ "Drives":[{ "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-1" "@odata.id":"/redfish/v1/Systems/FCH1845V1X6/Storage/SLOT-HBA/Drives/PD-2" "Drives@odata.count":2 "Id":"0", "VolumeType":"Mirrored", "BlockSizeBytes":65536 Performing Initialize Action on Volumes Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 76: Performing Setencryptionkey Action On Storage Controller

    "Drives":[{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0/Drives/SLOT-1" "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0/Drives/SLOT-2" "Links":{ "Enclosures":["/redfish/v1/Chassis/1"] "@odata.type":"#Cisco_Storage", "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0", "Volumes":[], "StorageControllers":{ "SupportedControllerProtocols":"USB", "MemberId":"FlexFlash", "Status":{ "State":"Disabled", "Health":"OK", "HealthRollup":"OK" "Name":"Cisco FlexFlash", "FirmwareVersion":"1.3.2 build 169", "Model":"Cisco FlexFlash", "Manufacturer":"Cypress" "Actions":{ "#Storage.SetEncryptionKey":{ "SecurityKey@Redfish.AllowableValues":["Security Key"], "Target":"/redfish/v1/Systems/FCH2005V1EN/Storage/FlexFlash-0/Actions/Storage.SetEncryptionKey", "SecurityKeyId@Redfish.AllowableValues":["Security Key Identifier"] "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 77: Getting Dhcp And Ntp In Managernetworkprotocol

    "HTTP":{ "ProtocolEnabled":true, "Port":80 "DHCP":{ "ProtocolEnabled":false, "Port":"null" "HTTPS":{ "ProtocolEnabled":true, "Port":443 "SSH":{ "ProtocolEnabled":true, "Port":22 "@odata.type":"#ManagerNetworkProtocol.1.0.0", "IPMI":{ "ProtocolEnabled":true, "Port":623 "Name":"Manager Network Protocol", "@odata.id":"/redfish/v1/Managers/CIMC/ManagerNetworkProtocol", "NTP":{ "ProtocolEnabled":false, "Port":123, "NTPServers":[" "," "," "," "] Retrieving Memory Collection Request: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 78: Retrieving Individual Dimm

    "Name":"Memory Collection", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Memory" Retrieving Individual DIMM Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH1845V1X6/Memory/DIMM_A1 Response: "SerialNumber":"01E7998C", "MemoryDeviceType":"DDR4", "Id":"1", "Links":{ "Chassis":["/redfish/v1/Chassis/1"] "MemoryMedia":"DRAM", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Memory/Members/$entity", "PartNumber":"M393A1G40DB0-CPB ", "CapacityMiB":"8192", "MemoryLocation":{ "Channel":"0", "Slot":"0", "Socket":"0" "MemoryType":"DRAM", "DeviceLocator":"DIMM_A1", "Name":"DIMM_A1", "@odata.type":"#Cisco_ComputerMemory", "DataWidthBits":"64", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 79: Retrieving Network Adapter Collection

    "Name":"NetworkAdapter Collection", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapter" Retrieving Network Adapter Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Chassis/1/NetworkAdapter/MLOM Response: "SerialNumber":"FCH18457F1M", "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM", "NetworkPorts":{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkPorts" "Name":"Adapter Card MLOM", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapter/Members/$entity", "NetworkDeviceFunctions":{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions" "Controllers":{ "ControllerCapabilities":{ "NetworkDeviceFunctionCount":4, "NetworkPortCount":2 "FirmwarePackageVersion":"4.3(1a)", "Links":{ "NetworkPorts":[{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkPorts/Port-0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkPorts/Port-1" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 80: Performing Reset Settings To Default Action On Network Adapter

    -XPOST -k -u admin:password https://10.10.10.10/redfish/v1/Chassis/1/NetworkAdapter/MLOM/Actions/ NetworkAdapter.ResetSettingsToDefault -d'{}' Retrieving Network Device Function Collection Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Chassis/1/NetworkAdapter/ MLOM/NetworkDeviceFunctions Response: "Members":[{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions/eth0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions/eth1" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions/fc0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions/fc1" "Description":"Collection of NetworkDeviceFunction resource instances for this system", "@odata.type":"#Cisco_NetworkDeviceFunctionCollection", "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 81: Retrieving Network Device Function

    " @ o d a t a . c o n t e x t " : " / r e d f i s h / v 1 / $ m e t a d a t a # C h a s s i s / M e m b e r s / $ e n t i t y / N e t w o r k A d a p t e r / M e m b e r s / $ e n t i t y / N e t w o r k D e v i c e F u n c t i o n s / M e m b e r s / $ e n t i t y " , "@odata.type":"#Cisco_NetworkDeviceFunction", "FibreChannel":{ "WWNSource":"ConfiguredLocally", "WWPN":"", "FCoELocalVLANId":"NONE", "BootTarget":{ "BootPriority":"", "LUNID":"", "WWPN":"" "WWNN":"" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkDeviceFunctions/eth0", "iSCSIBoot":{ "IPAddressType":"", "SecondaryTargetName":"", "InitiatorDefaultGateway":"", "InitiatorIPAddress":"", "SecondaryLUN":"", "PrimaryTargetIPAddress":"", "PrimaryLUN":"", "SecondaryDNS":"", "AuthenticationMethod":"None", "InitiatorName":"", "PrimaryTargetName":"", "IPMaskDNSViaDHCP":true, "InitiatorNetmask":"", "PrimaryTargetTCPPort":"", "TargetInfoViaDHCP":false, "SecondaryTargetTCPPort":"", "SecondaryTargetIPAddress":"", "PrimaryDNS":"" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 82: Retrieving Network Ports Collection

    "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapter/Members/$entity/NetworkPorts" Retrieving Network Ports Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkPorts/Port-0 Response: "AssociatedNetworkAddresses":"00:78:88:F0:94:BA", "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapter/MLOM/NetworkPorts/Port-0", "Name":"Port-0", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapter/Members/$entity/NetworkPorts/Members/$entity", "@odata.type":"#Cisco_NetworkPort", "LinkStatus":"Down", "Id":"0", "SupportedLinkCapabilities":{ "LinkSpeedMbps":"-", "LinkNetworkTechnology":"Ethernet" "PhysicalPortNumber":"0" Retrieving Update Service Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/UpdateService Response: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 83: Retrieving Firmware Inventory

    "ServiceEnabled":"true" Retrieving Firmware Inventory Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/UpdateService/FirmwareInventory/CIMC Response: "@odata.context":"/redfish/v1/$metadata#UpdateService/FirmwareInventory/Members/$entity", "@odata.type":"#Cisco_FirmwareInventory", "@odata.id":"/redfish/v1/UpdateService/FirmwareInventory/CIMC", "Updateable":"true", "Name":"CIMC", "Version":"3.1(2.129)" Retrieving Software Inventory Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/UpdateService/SoftwareInventory/PID-Catalog Response: "@odata.type":"#Cisco_SoftwareInventory", "@odata.id":"/redfish/v1/UpdateService/SoftwareInventory/PID-Catalog", "Updateable":"true", "Name":"PID-Catalog", "@odata.context":"/redfish/v1/$metadata#UpdateService/SoftwareInventory/Members/$entity" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 84: Retrieving Network Interface In System

    Retrieving Individual Network Interface Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH2005V1EN/NetworkInterfaces/MLOM Response: "Id":"UCSC-MLOM-CSC-02", "Status":{ "State":"Enabled", "Health":"Ok" "Links":{ "NetworkAdapter":["/redfish/v1/Chassis/1/NetworkAdapter/MLOM"] "Name":"Adapter Card MLOM", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/NetworkInterfaces/Members/$entity", "@odata.type":"#Cisco_NetworkInterface", "NetworkPorts":{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/NetworkInterfaces/MLOM/NetworkPorts" "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/NetworkInterfaces/MLOM", "NetworkDeviceFunctions":{ "@odata.id":"/redfish/v1/Systems/FCH2005V1EN/NetworkInterfaces/MLOM/NetworkDeviceFunctions" "Description":"It represents the properties for Adapter Card MLOM" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 85: Retrieving Secure Boot

    "Description":"UEFI SecureBoot configuration of this system" Configuring Port and Protocol Enabled in Manager Network Protocol Request: curl -k -u admin:password -XPATCH https://10.10.10.10/redfish/v1/Managers/CIMC/ManagerNetworkProtocol -d '{"SSH":{"Port":"300","ProtocolEnabled":"Disabled"}, "SNMP":{"Port":"100","ProtocolEnabled":"Disabled"}}' Response: "FQDN":"C240-FCH2005V1ENN", "SNMP":{ "ProtocolEnabled":false, "Port":100 "Id":"ManagerNetworkProtocol", "NTP":{ "ProtocolEnabled":true, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 86: Retrieving Pcie Devices

    "VirtualMedia":{ "ProtocolEnabled":true, "Port":2068 "Description":"Manager Network Service" Retrieving PCIe Devices Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/Systems/FCH2005V116/PCIeDevices/HBA Response: "FirmwareVersion":"0x80000B16-1.808.2", "@odata.id":"/redfish/v1/Systems/FCH2005V116/PCIeDevices/L", "Status":{ "State":"Enabled", "Health":"Ok" "Links":{ "Chassis":"/redfish/v1/Chassis/1", "PCIeFunction":[{ "@odata.id":"/redfish/v1/Systems/FCH2005V116/PCIeFunctions/L" "PCIeFunction@odata.count":1 "Name":"Intel(R) I350 1 Gbps Network Controller", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 87: Retrieving Pcie Functions

    "@odata.id":"/redfish/v1/Systems/FCH2005V116/EthernetInterfaces/L.1" "@odata.id":"/redfish/v1/Systems/FCH2005V116/EthernetInterfaces/L.2" "Name":"Intel(R) I350 1 Gbps Network Controller", "SubsystemVendorId":"0x1137", "@odata.type":"#Cisco_PCIeFunctions", "SubsystemId":"0x00d6", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/PCIeFunctions/Members/$entity", "@odata.id":"/redfish/v1/Systems/FCH2005V116/PCIeFunctions/L", "DeviceId":"0x1521", "Description":"This gives information of PCIeFunctions on the system" Retrieving Privilege Map Request: curl -k -u admin:password https://10.10.10.10/redfish/v1/AccountService/PrivilegeMap Response: Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 88 "Entity":"Manager", "OperationMap":{ "POST":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"Chassis", "OperationMap":{ "PATCH":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "POST":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents", "OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"Systems", "OperationMap":{ "PATCH":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "POST":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"JSONSchemas", "OperationMap":{ "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"EventService", "OperationMap":{ Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 89 "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"SessionService", "OperationMap":{ "DELETE":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "POST":{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"TaskService", "OperationMap":{ "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"AccountService", "OperationMap":{ "GET":{ "Privilege":["Login","ConfigureManager","ConfigureUsers", "ConfigureSelf","ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "@odata.type":"#PrivilegeRegistry.v1_1_0.json", "@odata.id":"/redfish/v1/AccountService/PrivilegeMap", "OEMPrivilegesUsed":["OemClearLog","OemPowerControl","OemAccessVirtualMedia"], "Description":"This resource represents the operation to privilege mappings" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 90: Examples Of Server Tasks For 4.0(4)

    Retrieving Individual DIMM, on page 104 • Retrieving PCIe Functions, on page 105 • Retrieving Individual Storage Controller, on page 106 • Retrieving Individual Drives, on page 106 • Retrieving Individual Volumes, on page 107 Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 91: Roles

    "Product":"UCS C240 M5SX", "Links":{ "Sessions":{ "@odata.id":"/redfish/v1/SessionService/Sessions" "Name":"Cisco RESTful Root Service", "Description":"Root Service", "Tasks":{ "@odata.id":"/redfish/v1/TaskService" "Registries":{ "@odata.id":"/redfish/v1/Registries" "@odata.type":"#ServiceRoot.1.4.0.ServiceRoot", "SessionService":{ "@odata.id":"/redfish/v1/SessionService" "@odata.context":"/redfish/v1/$metadata#ServiceRoot", "Managers":{ "@odata.id":"/redfish/v1/Managers" "AccountService":{ "@odata.id":"/redfish/v1/AccountService" "Id":"RootService" Roles Request: curl -k -u admin:Password https://10.10.10.10/redfish/v1/AccountService/Roles Response: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 92: Retrieving Privilege Map

    "ConfigureSelf","ConfigureComponents"], "Name":"User Role", "@odata.context":"/redfish/v1/$metadata#AccountService/Roles/Members/$entity", "RoleId":"admin", "OemPrivileges":["OemClearLog","OemPowerControl","OemAccessVirtualMedia"], "@odata.type":"#Role.v1_2_2.Role", "Id":"admin", "Description":"Admin User Role" Retrieving Privilege Map Response: "PrivilegesUsed":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"], "Id":"PrivilegeMap", "Name":"Privilege Registry", "@odata.context":"/redfish/v1/$metadata#AccountService/PrivilegeMap", "Mappings":[{ "Entity":"Manager", "OperationMap":{ "POST":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":[{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"Chassis", "OperationMap":{ "PATCH":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 93 "Entity":"Systems", "OperationMap":{ "PATCH":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "POST":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":[{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"JSONSchemas", "OperationMap":{ "GET":[{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"EventService", "OperationMap":{ "PATCH":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "POST":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] "GET":[{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"UpdateService", "OperationMap":{ "GET":[{ "Privilege":["Login","ConfigureManager","ConfigureUsers","ConfigureSelf", "ConfigureComponents","OemClearLog","OemPowerControl","OemAccessVirtualMedia"] "Entity":"SessionService", "OperationMap":{ "DELETE":[{ "Privilege":["ConfigureManager","ConfigureUsers","ConfigureSelf","ConfigureComponents"] Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 94: Viewing User Accounts

    "@odata.type":"#PrivilegeRegistry.v1_1_2.PrivilegeRegistry", "@odata.id":"/redfish/v1/AccountService/PrivilegeMap", "OEMPrivilegesUsed":["OemClearLog","OemPowerControl","OemAccessVirtualMedia"], "Description":"This resource represents the operation to privilege mappings" Viewing User Accounts Response: "Members":[{ "@odata.id":"/redfish/v1/AccountService/Accounts/1" "@odata.id":"/redfish/v1/AccountService/Accounts/2" "@odata.id":"/redfish/v1/AccountService/Accounts/3" "@odata.id":"/redfish/v1/AccountService/Accounts/4" "@odata.id":"/redfish/v1/AccountService/Accounts/5" "@odata.id":"/redfish/v1/AccountService/Accounts/6" "@odata.id":"/redfish/v1/AccountService/Accounts/7" "@odata.id":"/redfish/v1/AccountService/Accounts/8" "Description":"Collection of Accounts", "@odata.type":"#ManagerAccountCollection.ManagerAccountCollection", "@odata.id":"/redfish/v1/AccountService/Accounts", "Members@odata.count":8, "Name":"Account Collection", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 95: Retrieving Chassis Details

    The non-cpu/device centric parts of the schema are all accessed either directly or indirectly through this resource", "Thermal":{ "@odata.id":"/redfish/v1/Chassis/1/Thermal" "Links":{ "Drives":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/MRAID/Drives/PD-3" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/MRAID/Drives/PD-4" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/MRAID/Drives/PD-25" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/MRAID/Drives/PD-26" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Drives/microSD" "CooledBy":[{ "@odata.id":"/redfish/v1/Chassis/1/Thermal" "ComputerSystems":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1" "PCIeDevices":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/1" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 96: Retrieving Chassis Power Details

    "Name":"Computer System Chassis", "HeightMm":87, "Power":{ "@odata.id":"/redfish/v1/Chassis/1/Power" "WidthMm":482, "@odata.type":"#Chassis.v1_8_0.Chassis", "Actions":{ "#Chassis.Reset":{ "target":"/redfish/v1/Chassis/1/Actions/Chassis.Reset", "ResetType@Redfish.AllowableValues":["On","ForceOff"] "Manufacturer":"Cisco Systems Inc.", "@odata.id":"/redfish/v1/Chassis/1", "Model":"UCS C240 M5SX", "AssetTag":"Test<>Test" Retrieving Chassis Power Details Response: "Id":"Power", "Name":"Power", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/Power", "PowerControl":[{ "PhysicalContext":"PowerSupply", "PowerMetrics":{ "MinConsumedWatts":212, "AverageConsumedWatts":227, Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 97 "@odata.id":"/redfish/v1/Chassis/1/Power#/Voltages/PSU2_VOUT", "Status":{ "State":"Enabled", "Health":"OK" "UpperThresholdCritical":14, "Name":"PSU2_VOUT", "ReadingVolts":0 "@odata.id":"/redfish/v1/Chassis/1/Power#/Voltages/P12V", "Status":{ "State":"Enabled", "Health":"OK" "SensorNumber":210, "Name":"P12V", "PhysicalContext":"PowerSupply", "MemberId":"3", "ReadingVolts":11.774, "UpperThresholdCritical":13.166, "LowerThresholdCritical":10.788 "@odata.id":"/redfish/v1/Chassis/1/Power#/Voltages/P3V_BAT_SCALED", "Status":{ "State":"Enabled", "Health":"OK" "SensorNumber":211, "Name":"P3V_BAT_SCALED", "PhysicalContext":"PowerSupply", "MemberId":"4", "ReadingVolts":3.011, "UpperThresholdCritical":3.588, "LowerThresholdCritical":2.543 "@odata.type":"#Power.v1_5_1.Power", "Description":"Power", "@odata.id":"/redfish/v1/Chassis/1/Power", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 98: Retrieving Chassis Sel Details

    "InputRanges":[{ "InputType":"AC", "OutputWattage":1600, "MaximumFrequencyHz":63, "MaximumVoltage":264, "MinimumVoltage":180, "MinimumFrequencyHz":47 "FirmwareVersion":"10152429", "@odata.id":"/redfish/v1/Chassis/1/Power#/PowerSupplies/PSU2", "PowerOutputWatts":0, "LineInputVoltage":0, "Name":"PSU2", "Status":{ "State":"Disabled" "PowerInputWatts":0, "Manufacturer":"Cisco Systems Inc", "LastPowerOutputWatts":0, "MemberId":"2", "PartNumber":"341-0732-02", "PowerSupplyType":"AC", "Model":"CIS-S-1600ADE000-301", "SparePartNumber":"341-0732-02" Retrieving Chassis SEL Details Response: "DateTimeLocalOffset":"+05:30", "LogEntryType":"SEL", "Id":"SEL", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 99: Retrieving Chassis Sel Entries Details

    "EntryCode":"Device Inserted / Device Present", "EventTimestamp":"2019-04-05 15:43:39 IST", "@odata.id":"/redfish/v1/Chassis/1/LogServices/SEL/Entries/3176", "EntryType":"SEL", "Name":"Log Entry 3176", "EventType":"ResourceAdded", "EventId":"3176", "Message":"FRU_VIC_SLOT2 VIC_SLOT2_PRS: Presence sensor for FRU_VIC_SLOT2, Device Inserted / Device Present was asserted", "Description":"Log Entry 3176", "Id":"3176", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 100: Retrieving Chassis Thermal Details

    "Health":"OK" "ReadingUnits":"RPM", "Reading":7272, "PhysicalContext":"Fan", "MemberId":"1", "Name":"MOD1_FAN1_SPEED" "RelatedItem":[{ "@odata.id":"/redfish/v1/Chassis/1" "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Fans/MOD1_FAN1", "Status":{ "State":"Enabled", "Health":"OK" "ReadingUnits":"RPM", "Reading":7272, "PhysicalContext":"Fan", "MemberId":"2", "Name":"MOD1_FAN1_SPEED" <SNIP> "RelatedItem":[{ "@odata.id":"/redfish/v1/Chassis/1" "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Fans/MOD6_FAN2", "Status":{ "State":"Enabled", "Health":"OK" "ReadingUnits":"RPM", "Reading":7546, "PhysicalContext":"Fan", "MemberId":"12", "Name":"MOD6_FAN2_SPEED" "Id":"Thermal", "Status":{ "State":"Enabled", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 101: Retrieving Network Adapter

    "Name":"VIC_SLOT2_TEMP", "PhysicalContext":"NetworkingDevice", "MemberId":"2", "UpperThresholdCritical":90, "ReadingCelsius":41 <SNIP> "RelatedItem":[{ "@odata.id":"/redfish/v1/Chassis/1" "@odata.id":"/redfish/v1/Chassis/1/Thermal#/Temperatures/RISER1_INLET_TMP", "Status":{ "State":"Enabled", "Health":"OK" "SensorNumber":250, "Name":"RISER1_INLET_TMP", "PhysicalContext":"SystemBoard", "MemberId":"16", "UpperThresholdCritical":70, "ReadingCelsius":30 "@odata.id":"/redfish/v1/Chassis/1/Thermal", "Temperatures@odata.count":16, "Fans@odata.count":10, "Description":"Represents the properties for Temperature and Cooling" Retrieving Network Adapter Response: Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 102: Retrieving Network Device Function

    "NetworkPortCount":2 "FirmwarePackageVersion":"4.3(1.9)", "Links":{ "NetworkPorts":[{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkPorts/Port-0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkPorts/Port-1" "NetworkDeviceFunctions@odata.count":4, "NetworkDeviceFunctions":[{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkDeviceFunctions/eth0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkDeviceFunctions/eth1" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkDeviceFunctions/fc0" "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkDeviceFunctions/fc1" "NetworkPorts@odata.count":2 "@odata.type":"#NetworkAdapter.v1_2_0.NetworkAdapter", "Actions":{ "#NetworkAdapter.ResetSettingsToDefault":{ "target":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/Actions/NetworkAdapter.ResetSettingsToDefault" "Manufacturer":"Cisco Systems Inc", "PartNumber":"73-17793-05", "Model":"UCS VIC 1387", "Id":"UCSC-MLOM-C40Q-03" Retrieving Network Device Function Response: "Ethernet":{ "MACAddress":"28:AC:9E:7C:EA:C9" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 103: Retrieving Network Ports

    Retrieving Network Device Function Response: "Ethernet":{ "MACAddress":"28:AC:9E:7C:EA:C7", "VLAN":{ "VLANEnable":true "MTUSize":1500 "@odata.type":"#NetworkDeviceFunction.v1_3_0.NetworkDeviceFunction", "Id":"eth0", "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkDeviceFunctions/eth0", "Links":{ "PhysicalPortAssignment":{ "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkPorts/Port-0" "Name":"eth0", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapters/Members/$entity/ NetworkDeviceFunctions/Members/$entity" Retrieving Network Ports Response: "AssociatedNetworkAddresses":["28:AC:9E:7C:EA:BC"], "@odata.id":"/redfish/v1/Chassis/1/NetworkAdapters/MLOM/NetworkPorts/Port-1", "Name":"Port-1", "@odata.context":"/redfish/v1/$metadata#Chassis/Members/$entity/NetworkAdapters/ Members/$entity/NetworkPorts/Members/$entity", "@odata.type":"#NetworkPort.v1_2_0.NetworkPort", "LinkStatus":"Down", "Id":"1", "SupportedLinkCapabilities":[{ "LinkNetworkTechnology":"Ethernet" "PhysicalPortNumber":"1" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 104: Retrieving Cisco Imc Information

    "NetworkProtocol":{ "@odata.id":"/redfish/v1/Managers/CIMC/NetworkProtocol" "VirtualMedia":{ "@odata.id":"/redfish/v1/Managers/CIMC/VirtualMedia" "Description":"Test&quot;123~`!@#$\\", "SerialInterfaces":{ "@odata.id":"/redfish/v1/Managers/CIMC/SerialInterfaces" "LogServices":{ "@odata.id":"/redfish/v1/Managers/CIMC/LogServices" "FirmwareVersion":"66.77(67.1554096047)", "UUID":"20634E24-2D58-4462-93FF-9EB4C43B5BEC", "Status":{ "State":"Enabled", "Health":"OK" "RemoteAccountService":{ "@odata.id":"/redfish/v1/AccountService" "Name":"Cisco Integrated Management Controller", "Actions":{ "#Manager.Reset":{ "target":"/redfish/v1/Managers/CIMC/Actions/Manager.Reset", "ResetType@Redfish.AllowableValues":["ForceRestart"] "Oem":{ "#CiscoUCSExtensions.BmcFwUpdate":{ "Protocol@Redfish.AllowableValues":["TFTP","SCP","SFTP","FTP","HTTP"], "target":"/redfish/v1/Managers/CIMC/Actions/Oem/CiscoUCSExtensions.BmcFwUpdate", "@odata.type":"CiscoUCSExtensions.v1_0_0.CiscoUCSExtensions", "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 105 "@odata.type":"CiscoUCSExtensions.v1_0_0.CiscoUCSExtensions", "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] "#CiscoUCSExtensions.ExportBmcConfig":{ "Protocol@Redfish.AllowableValues":["TFTP","SCP","SFTP","FTP","HTTP"], "Passphrase@Redfish.AllowableValues":["Passphrase"], "@odata.type":"CiscoUCSExtensions.v1_0_0.CiscoUCSExtensions", "RemoteUsername@Redfish.AllowableValues":["Remote Server Username"], "RemotePath@Redfish.AllowableValues":["Valid Remote Share Path"], "RemoteHostname@Redfish.AllowableValues":["Valid Hostname/IP Address"], "target":"/redfish/v1/Managers/CIMC/Actions/Oem/CiscoUCSExtensions.ExportBmcConfig", "RemotePassword@Redfish.AllowableValues":["Remote Server Password"] Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 106: Retrieving Ethernet Interfaces Details

    "Model":"UCSC-C240-M5SX", "EthernetInterfaces":{ "@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces" Retrieving Ethernet Interfaces Details Response: "Members":[{ "@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs" "Description":"Collection of EthernetInterfaces for this Manager", "@odata.type":"#EthernetInterfaceCollection.EthernetInterfaceCollection", "@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces", "Members@odata.count":1, "Name":"Ethernet Interfaces Collection", "@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity/EthernetInterfaces" Retrieving Network Protocol Details Response: "SNMP":{ "ProtocolEnabled":true, "Port":100 "Id":"ManagerNetworkProtocol", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 107: Retrieving Update Service

    "ProtocolEnabled":false, "Port":null "@odata.type":"#ManagerNetworkProtocol.v1_3_0.ManagerNetworkProtocol", "SSH":{ "ProtocolEnabled":true, "Port":22 "IPMI":{ "ProtocolEnabled":true, "Port":623 "DHCP":{ "ProtocolEnabled":false, "Port":null "@odata.id":"/redfish/v1/Managers/CIMC/NetworkProtocol", "NTP":{ "ProtocolEnabled":true, "Port":123, "NTPServers":["ntp.esl.cisco.com","ntp.esli.cisco.com"] Retrieving Update Service Response: "FirmwareInventory":{ "@odata.id":"/redfish/v1/UpdateService/FirmwareInventory" "@odata.id":"/redfish/v1/UpdateService", "SoftwareInventory":{ "@odata.id":"/redfish/v1/UpdateService/SoftwareInventory" "@odata.context":"/redfish/v1/$metadata#UpdateService", "@odata.type":"#UpdateService.v1_3_0.UpdateService", "ServiceEnabled":true, "Name":"Update Service", "Id":"UpdateService" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 108: Retrieving Firmware Inventory

    PowerState":"On", "ProcessorSummary":{ "Model":"Intel(R) Xeon(R) Silver 4110 CPU @ 2.10GHz", "Count":2 "MemoryDomains":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains" "Storage":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage" "Bios":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Bios" "UUID":"20634E24-2D58-4462-93FF-9EB4C43B5BEC", "Name":"UCS C240 M5SX", "HostWatchdogTimer":{ "Status":{ "State":"Disabled" "WarningAction":"None", "FunctionEnabled":false, "TimeoutAction":"PowerDown" "@odata.type":"#ComputerSystem.v1_5_1.ComputerSystem", "Manufacturer":"Cisco Systems", "Actions":{ "#ComputerSystem.Reset":{ "target":"/redfish/v1/Systems/WZP220607R1/Actions/ComputerSystem.Reset", Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 109 "PCIeFunctions":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/1" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/2" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/MLOM" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/MRAID" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/L" "SystemType":"Physical", "BiosVersion":"C240M5.4.0.2.203.1211182056", "HostName":"C240-WZP220607R", "MemorySummary":{ "TotalSystemMemoryGiB":64, "Status":{ "HealthRollup":"OK", "Health":"OK" "Processors":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Processors" "PCIeFunctions@odata.count":5, "Description":"Test\"123~`!@#$\\", "SimpleStorage":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/SimpleStorage" "PCIeDevices":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/1" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/2" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/MLOM" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/MRAID" "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/L" "Status":{ "State":"Enabled", "Health":"Warning" "Links":{ "CooledBy":[{ "@odata.id":"/redfish/v1/Chassis/1/Thermal" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 110: Retrieving Individual Dimm

    "Status":{ "Health":"OK" "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity", "Memory":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory" "PCIeDevices@odata.count":5 Retrieving Individual DIMM Response: "SerialNumber":"374D54EC", "MemoryDeviceType":"DDR4", "Id":"1", "Links":{ "Chassis":{ "@odata.id":"/redfish/v1/Chassis/1" "MemoryMedia":["DRAM"], "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Memory/Members/$entity", "PartNumber":"M393A2G40EB2-CTD ", "CapacityMiB":16384, "MemoryLocation":{ "Channel":0, "Slot":0, "Socket":0 "MemoryType":"DRAM", "OperatingMemoryModes":["Volatile"], "DeviceLocator":"DIMM_A1", "Name":"DIMM_A1", "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/DIMM_A1", "@odata.type":"#Memory.v1_6_0.Memory", "DataWidthBits":64, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 111: Retrieving Pcie Functions

    "@odata.id":"/redfish/v1/Systems/WZP220607R1/NetworkInterfaces/2/NetworkDeviceFunctions/fc1" "NetworkDeviceFunctions@odata.count":4, "StorageControllers@odata.count":0, "Drives@odata.count":0, "EthernetInterfaces@odata.count":2, "PCIeDevice@odata.count":1, "PCIeDevice":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/2" "EthernetInterfaces":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/EthernetInterfaces/2.0" "@odata.id":"/redfish/v1/Systems/WZP220607R1/EthernetInterfaces/2.1" "Name":"UCS VIC1385 40Gbps 2 port CNA QSFP+", "SubsystemVendorId":"0x1137", "@odata.type":"#Cisco_PCIeFunctions", "SubsystemId":"0x014d", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/PCIeFunctions/Members/$entity", "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/2", "DeviceId":"0x0042", "Description":"This gives information of PCIeFunctions on the system" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 112: Retrieving Individual Storage Controller

    "Name":"Cisco Flexutil", "Model":"Cisco Flexutil", "Manufacturer":"Cisco" "Name":"Flexutil", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity", "@odata.type":"#Storage.v1_5_0.Storage", "Links":{ "Enclosures":[{ "@odata.id":"/redfish/v1/Chassis/1" "Actions":{ "#Storage.SetEncryptionKey":{ "SecurityKey@Redfish.AllowableValues":["Security Key"], "target":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Actions/Storage.SetEncryptionKey", "SecurityKeyId@Redfish.AllowableValues":["Security Key Identifier"] "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil" Retrieving Individual Drives Response: "SerialNumber":"0x1d406aa", "Id":"1", "Links":{ "Volumes":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/SCU" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/Diagnostics" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/HUU" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/Drivers" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/UserPartition" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 113: Retrieving Individual Volumes

    "Status":{ "Health":"OK" "BlockSizeBytes":512, "Name":"microSD", "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Drives/microSD", "Revision":"3.0", "EncryptionAbility":"None", "CapacityBytes":32111591424, "HotspareType":"None", "Manufacturer":"PH", "EncryptionStatus":"Unencrypted", "Model":"SD32G", "FailurePredicted":false Retrieving Individual Volumes Response: "Encrypted":false, "Status":{ "State":"Enabled", "Health":"OK" "Links":{ "Drives":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Drives/microSD" "Drives@odata.count":1 "Name":"UserPartition", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/Storage/Members/$entity/ Volumes/Members/$entity", "Actions":{ "#Volume.Initialize":{ "target":"/redfish/v1/Systems/WZP220607R1/Storage/Flexutil/Volumes/UserPartition/Actions/ Volume.Initialize" Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 114 "Model":"Intel(R) Xeon(R) Silver 4110 CPU @ 2.10GHz", "@odata.type":"#Processor.v1_3_1.Processor", "Id":"1", "Manufacturer":"Intel(R) Corporation", "MaxSpeedMHz":4000, "TotalCores":8, "Socket":"CPU1" Retrieving PCIe Devices Response: "@odata.type":"#PCIeDevice.v1_3_0.PCIeDevice", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/PCIeDevices/Members/$entity", "FirmwareVersion":"0x80002B50-1.812.1", "Id":"1", "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeDevices/1", "Links":{ "Chassis":[{ "@odata.id":"/redfish/v1/Chassis/1" "PCIeFunctions@odata.count":1, "PCIeFunctions":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/PCIeFunctions/1" "Name":"Cisco(R) Ethernet Converged NIC X710-DA4", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 115: Examples Of New Additions In 4.0(4) Release

    Retrieving Base Registries, on page 114 • Retrieving Cisco UCS Faults Registries, on page 115 • Retrieving Cisco UCS Fault Codes Registries, on page 115 • Retrieving Cisco UCS Message Registries, on page 116 • Retrieving Cisco Bios Attribute Registries, on page 119 •...

  • Page 116: Retrieving Event Service

    Eject VMedia, on page 131 Retrieving Event Service Request: curl -k -u admin:Password https://10.10.10.10/redfish/v1/EventService Response: "Subscriptions":{ "@odata.id":"/redfish/v1/EventService/Subscriptions" "Id":"EventService", "Status":{ "State":"Disabled", "Health":"OK" "Name":"Event Service", "ServiceEnabled":false, "Description":"Event Service represents the properties for the service", "@odata.type":"#EventService.v1_2_0.EventService", "DeliveryRetryIntervalSeconds":30, "@odata.context":"/redfish/v1/$metadata#EventService", "DeliveryRetryAttempts":3, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 117: Retrieving Individual Event Service

    "F0392","F0393","F0394","F1040","F0174","F0185","F0460","F0461","F0462","F0868","F0434","F0389","F0391"], "Descritiom":"Event Subscription Details", "@odata.type":"#EventDestination.1.0.0.EventDestination", "SubscriptionType":"RedfishEvent", "Destination":"10.10.10.10", "@odata.context":"/redfish/v1/$metadata#EventService/Subscriptions/Members/$entity", "@odata.id":"/redfish/v1/EventService/Subscriptions/66c6596b56aa18a60b5aabb509656800", "EventTypes":["Alert"] Retrieving Individual Tasks Details Request: curl -k -u admin:Password https://10.10.10.10/redfish/v1/TaskService/Tasks/ExportBmcConfig Response: "@odata.id":"/redfish/v1/TaskService/Tasks/ExportBmcConfig", "Name":"Task ExportBmcConfig", "@odata.context":"/redfish/v1/$metadata#TaskService/Tasks/Members/$entity", "TaskStatus":"OK", "@odata.type":"#Task.v1_3_0.Task", "Id":"ExportBmcConfig", "TaskState":"Completed", "Oem":{ "Cisco":{ "ExportStatus":"None" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 118: Retrieving Nic Details

    "PrefixLength":119, "AddressOrigin":"Static" "FullDuplex":true, "StaticNameServers":["10.126.164.234","72.163.128.140","2001:420:5446:2014:2aac:9eff:fe22:8"], "DHCPv4":{ "UseDNSServers":false, "UseGateway":false, "UseNTPServers":false, "UseDomainName":false, "DHCPEnabled":false, "UseStaticRoutes":false "IPv4Addresses":[{ "Gateway":"10.10.10.1", "Address":"10.10.10.10", "SubnetMask":"255.255.255.0", "AddressOrigin":"Static" "VLAN":{ "VLANId":1, "VLANEnable":false "IPv6StaticDefaultGateways":[{ "Address":"2001:420:5446:2014::330:1" "InterfaceEnabled":true, "MACAddress":"28:AC:9E:22:59:40", "Name":"Manager Ethernet Interface", "Links":{ "Chassis":{ "@odata.id":"/redfish/v1/Chassis/1" "@odata.id":"/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs", "DHCPv6":{ "OperatingMode":"Disabled", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 119: Retrieving Individual Ethernet Interfaces Details

    "@odata.id":"/redfish/v1/Systems/WZP220607R1/EthernetInterfaces/1.1", "MACAddress":"3c:fd:fe:b9:ef:fb", "Name":"Ethernet Interface", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/EthernetInterfaces/Members/$entity", "@odata.type":"#EthernetInterface.v1_4_1.EthernetInterface", "Links":{ "Chassis":{ "@odata.id":"/redfish/v1/Chassis/1" "Id":"1.1", "PermanentMACAddress":"3c:fd:fe:b9:ef:fb", "Description":"Network Interface" Retrieving Virtual Media Details Request: curl -XGET -k -u admin:Password https://10.10.10.10/redfish/v1/Managers/CIMC/VirtualMedia/TEST Response: "ConnectedVia":"URI", "Id":"TEST", "Actions":{ "#VirtualMedia.EjectMedia":{ "target":"/redfish/v1/Managers/CIMC/VirtualMedia/TEST/Actions/VirtualMedia.EjectMedia", "Image":"chassis.img", "@odata.context":"/redfish/v1/$metadata#Managers/Members/$entity/VirtualMedia/Members/$entity", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 120: Retrieving Registries

    "Name":"Registry File Collection", "@odata.context":"/redfish/v1/$metadata#Registries" Retrieving Base Registries Request: curl -XGET -k -u admin:Password https://10.10.10.10/redfish/v1/Registries/Base Response: "Id":"Base", "Name":"Base Message Registry file", "@odata.context":"/redfish/v1/$metadata#Registries/Members/$entity", "Languages":["en"], "@odata.type":"#MessageRegistryFile.v1_0_2.MessageRegistryFile", "Location":[{ "Uri":"/redfish/v1/Registries/Base/Base.1.4.0.json", "Language":"en" "@odata.id":"/redfish/v1/Registries/Base", "Description":"Base Message Registry File locations" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 121: Retrieving Cisco Ucs Faults Registries

    "Description":"Faults RegistryFile for this system" Retrieving Cisco UCS Fault Codes Registries Request: curl -XGET -k -u admin:Password https://10.10.10.10/redfish/v1/Registries/CiscoUcsFaults/ CiscoUcsFaultCodes.v1_0_0.json Response: "@Redfish.Copyright":"Copyright 2018-2021 Cisco Systems Inc. All rights reserved.", "RegistryVersion":"1.0.0", "OwningEntity":"Cisco Systems Inc.", "Name":"Cisco UCS Fault Message Registry", "@odata.context":"/redfish/v1/$metadata#Registries/Members/$entity/CiscoUcsFaultCodes.v1_0_0.json", "@odata.id":"/redfish/v1/Registries/CiscoUcsFaults/CiscoUcsFaultCodes.v1_0_0.json", "@odata.type":"#MessageRegistry.v1_2_0.MessageRegistry", "Id":"CiscoUcsFaults.1.0.0",...

  • Page 122: Retrieving Cisco Ucs Message Registries

    "cisco":{ "MessageId":20 "Resolution":"Replace Battery", "NumberOfArgs":0, "Severity":"major", "Message":"", "Description":"Battery voltage level is lower critical" "RegistryPrefix":"CiscoUCSFaults", "Description":"This registry defines the Fault messages for Cisco UCS Redfish implementations." Retrieving Cisco UCS Message Registries Request: curl -XGET -k -u admin:Password https://10.10.10.10/redfish/v1/Registries/ CiscoUcsMessageRegistry Response: "Id":"CiscoUcsMessageRegistry", "Name":"Cisco UCS Message Registry file",...
  • Page 123 "Description":"Indicates that the system is in a state which is incompatible to run given operation." "UnauthorisedPlatform":{ "Resolution":"Call Cisco TAC.", "NumberOfArgs":0, "Severity":"Critical", "Message":"This platform is unauthorized. Please Call Cisco TAC. ( Error : 0x18008080 ).", "Description":"Indicates that the underlying platform is not authorised." "HttpNotSupported":{ "Resolution":"Use HTTPS Protocol.", "NumberOfArgs":0, "Severity":"Critical",...
  • Page 124 "Message":"The string length of value for %1 exceeds the maximum allowed value of %2", "Description":"Indicates that the string length of property value exceeds permissable limits." "ArrayLengthExceeded":{ "Resolution":"Provide a value that is within the specified limits and resubmit the request Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 125: Retrieving Cisco Bios Attribute Registries

    "Message":"The resource %1 does not allow %2 method.", "Description":"Indicates that the method type mentioned in the request body is not allowed on this resource." "RegistryPrefix":"CiscoUCS", "Description":"This registry defines the common messages for Cisco UCS Redfish implementations." Retrieving Cisco Bios Attribute Registries Request: curl -XGET -k -u admin:Password https://10.10.10.10/redfish/v1/Registries/...
  • Page 126 "ProductName":"UCS C240 M5SX", "SystemId":"WZP220607R1" "@odata.id":"/redfish/v1/Registries/CiscoBiosAttributeRegistry.v1_0_0/BiosAttributeRegistry", "OwningEntity":"Cisco Systems Inc.", "Name":"BIOS Attribute Registry", "@odata.context":"/redfish/v1/$metadata#Registries/Members/$entity/BiosAttributeRegistry", "RegistryEntries":{ "Attributes":[{ "DefaultValue":"Enabled", "WriteOnly":false, "ResetRequired":true, "Hidden":false, "DisplayName":"Processor CMCI", "IsSystemUniqueProperty":true, "AttributeName":"ProcessorCMCI", "Immutable":false, "Value":[{ "ValueName":"Enabled", "ValueDisplayName":"Enabled" "ValueName":"Disabled", "ValueDisplayName":"Disabled" "ReadOnly":false, "MinLength":1, "MaxLength":64, "Type":"String" "DefaultValue":"Auto", "WriteOnly":false, Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 127: Retrieving Memory Details

    "IsSystemUniqueProperty":true, "AttributeName":"OSBootWatchdogTimerTimeout", "Immutable":false, "Value":[{ "ValueName":"5 minutes", "ValueDisplayName":"5 minutes" "ValueName":"10 minutes", "ValueDisplayName":"10 minutes" "ValueName":"15 minutes", "ValueDisplayName":"15 minutes" "ValueName":"20 minutes", "ValueDisplayName":"20 minutes" "ReadOnly":false, "MinLength":1, "MaxLength":64, "Type":"String" "@odata.type":"#AttributeRegistry.v1_2_1.AttributeRegistry", "Id":"BiosAttributeRegistry", "RegistryVersion":"1.0.0", "Language":"en" Retrieving Memory Details Request: Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 128 "Slot":0, "Socket":1 "MemoryType":"IntelOptane", "OperatingMemoryModes":["Volatile","PMEM"], "DeviceLocator":"DIMM_G1", "Name":"DIMM_G1", "PersistentRegionSizeMaxMiB":65536, "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/DIMM_G1", "Regions":[{ "SizeMiB":262144, "MemoryClassification":"ByteAccessiblePersistent", "RegionId":"2" "@odata.type":"#Memory.v1_6_0.Memory", "DataWidthBits":64, "Manufacturer":"0xCE00", "OperatingSpeedMhz":2666, "Status":{ "State":"Enabled" "SecurityCapabilities":{ "MaxPassphraseCount":1, "SecurityStates":["Enabled","Disabled","Unlocked","Locked"], "PassphraseCapable":true Request: curl -k -u admin:Password -XGET https://10.10.10.10/redfish/v1/Systems/WZP220607R1 Response: "SerialNumber":"WZP220607R1", "Id":"WZP220607R1", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 129: Retrieving Memory Domains

    "Description":"Collection of Memory Domain resource instances for this system", "@odata.type":"#MemoryDomainCollection.MemoryDomainCollection", "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains", "Members@odata.count":1, "Name":"Memory Domain Collection", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/MemoryDomains" Request: curl -k -u admin:Password -XGET https://10.10.10.10/redfish/v1/Systems/WZP220607R1/MemoryDomains/1 Response: "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains/1", "AllowsBlockProvisioning":false, "Name":"Memory Domain", "InterleavableMemorySets":[{ "MemorySet":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/CPU_MOD1_DIMM_A2" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/CPU_MOD1_DIMM_B2" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/CPU_MOD1_DIMM_D2" "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/CPU_MOD1_DIMM_E2" "MemorySet":[{ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 130: Retrieving Memory Chunks

    Response: "Members":[{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains/1/MemoryChunks/1" "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains/1/MemoryChunks/2" "Description":"Collection of Memory Chunks resource instances for this system", "@odata.type":"#MemoryChunksCollection.MemoryChunksCollection", "@odata.id":"/redfish/v1/Systems/WZP220607R1/MemoryDomains/1/MemoryChunks", "Members@odata.count":2, "Name":"Memory Chunks Collection", "@odata.context":"/redfish/v1/$metadata#Systems/Members/$entity/MemoryDomains/Members/$entity/MemoryChunks" Request: curl -k -u admin:Password -XGET https://10.10.10.10/redfish/v1/Systems/WZP220607R1/MemoryDomains/1/ MemoryChunks/1 Response: "InterleaveSets":[{ "Memory":{ "@odata.id":"/redfish/v1/Systems/WZP220607R1/Memory/CPU_MOD1_DIMM_A2" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 131: Setting Mac-Address (To A Particular Value) And Mtu Size

    "MACAddress":"6C:B2:AE:3A:B2:DE", "MTUSize":2222 Setting MAC-Address (to AUTO) Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Systems/WZP21330G5B/NetworkInterfaces/ 1/NetworkDeviceFunctions/eth0 -d' "Ethernet":{ "MACAddress":"auto" Configuring iSCSI Boot when PXE Boot is Enabled Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Systems/WZP21330G5B/NetworkInterfaces/ Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 132: Editing Iscsi Boot Values

    "SecondaryTargetIPAddress":"10.1.1.1", "SecondaryLUN":30 Editing iSCSI Boot Values Authentication Mode Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Systems/WZP21330G5B/NetworkInterfaces/ 1/NetworkDeviceFunctions/eth0 -d'{ "iSCSIBoot":{ "AuthenticationMethod":"CHAP", "CHAPUsername":"test-CHAP", "CHAPSecret":"testSecret" Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Systems/WZP21330G5B/NetworkInterfaces/ 1/NetworkDeviceFunctions/eth0 -d' "iSCSIBoot":{ "AuthenticationMethod":"None" Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 133: Setting Wwpn And Wwnn To Auto

    "LUNID":"45", "WWPN":"20:5F:6C:B2:AE:3A:B3:5F" Deleting Boot Targets Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Systems/WZP21330G5B/NetworkInterfaces/ 1/NetworkDeviceFunctions/fc0 -d' "FibreChannel":{ "BootTargets":[{ "BootPriority":0 "BootPriority":1, "WWPN":null, "LUNID":null Setting Power Limits Attributes Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Chassis/1/Power -d' Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 134: Setting Dhcpv4 Attributes

    This is not applicable for S3260 M5 servers. Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs {"DHCPv6": { "OperatingMode": "Stateful", "UseDNSServers": true Setting IPv6 Attributes Note This is not applicable for S3260 M5 servers. Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 135: Setting Auto Negotiation, Speed, And Duplex

    “FullDuplex": true Setting Hostname Note This is not applicable for S3260 M5 servers. Request: curl -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs {"HostName": "C220-WZP210606A6z"} Setting DNS Note This is not applicable for S3260 M5 servers. Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 136: Setting Ipv4

    -XPATCH -k -u admin https://10.10.10.10/redfish/v1/Managers/CIMC/EthernetInterfaces/NICs {"VLAN": {"VLANId": 2,"VLANEnable": true}} Setting LDAP Attributes Request: curl -XPATCH -k -u admin:Password https://10.10.10.10/redfish/v1/AccountService -d ' "LDAP":{ "ServiceAddresses":["ldap://WIN-AD.automation.com:389","ldaps://10.10.10.1:6000","ldaps://[2001:420:5446:2014::330:11]:389", “” ], "ServiceEnabled":true, "LDAPService":{ "SearchSettings" : { "GroupsAttribute":"test", "UsernameAttribute":"test", Cisco UCS C-Series Servers REST API Programmer's Guide...

  • Page 137: Setting Systems Attributes

    "FunctionEnabled":false, "TimeoutAction":"PowerDown" "IndicatorLED":"Off", "AssetTag":"TestRedfish", "Boot":{ "BootSourceOverrideTarget" : "None", "BootSourceOverrideEnabled" : "Disabled" Eject VMedia Note This is not applicable for S3260 M5 servers. Request: curl -XPOST -k -u admin:Password https://10.10.10.10/redfish/v1/Managers/ CIMC/VirtualMedia/TEST/Actions/VirtualMedia.EjectMedia -d '{}' Cisco UCS C-Series Servers REST API Programmer's Guide...
  • Page 138 Cisco IMC REST API Examples Examples of Server Tasks for 4.0(4) Cisco UCS C-Series Servers REST API Programmer's Guide...

Table of Contents