reports - cisco · reports thischaptercontainsthefollowingsections: • aboutreports,page1 •...
TRANSCRIPT
Reports
This chapter contains the following sections:
• About Reports, page 1
• Reports and JSON Object Response Samples, page 2
• Using GetAvailableReports to Obtain ReportIds, page 9
• Tabular Reports, page 11
• Historical Reports, page 12
• Snapshot Reports, page 12
• List of Available Cisco UCS Director Reports, page 13
• Using the List of Available Reports, page 30
About ReportsCisco UCS Director reports tend to be in one of three fundamental report formats: Tabular, Historical, orSnapshot. This section includes extensive information about these three formats. This section also showssamples of the different report types, including specialized reports such as the VM report and theAPIWorkFlowStatus report. For more information, see Reports and JSON Object Response Samples, onpage 2.
Cisco UCS Director provides dynamically updated lists of the reports available to you and graphic renderingsof each type of report. For each different Cisco UCSDirector context, a different set of reports (each identifiedby a reportId) is available.
To create an API request for a specific report, you need to use the proper operation name and the following:
• The context of the report (for example, the values for param0 and param1 in a JSON formatted APIrequest with two parameters)
• The reportId value (typically, the last JSON parameter listed in an API report request)
To get the most complete and current list of reports available for a Cisco UCS Director context, use theuserAPIGetAvailableReport API.
Cisco UCS Director REST Developer Guide, Release 5.3 1
For a list of standard Cisco UCS Director contexts and the reports associated with them, see List of AvailableCisco UCS Director Reports, on page 13.
Cisco UCS Director commonly generates context values that are specific to customer sites, includingcontexts that refer to dynamically changing clouds of virtual machines.Workflows also depend on specificcustomer set-up, so you will have to maintain and use your own workflow-related values. To viewcustomer-specific values, you must generate the available report list using the userAPIGetAvailableReportAPI, or obtain the context data from the Report Metadata associated with an existing report in Cisco UCSDirector.
Note
For fundamental information about using context and reportId data to construct an API request, see RequestFormat.
Reports and JSON Object Response SamplesIn addition to the samples provided in this section, some of the JSON objects discussed in JSON ObjectParameter Types can also be rendered into reports.
AvailableReports (a tabular report)
This very useful report returns a comprehensive list of the reports available for a specified Cisco UCSDirectorcontext. It includes report ID, report label and report type.
The following is a sample of this report:
{ "serviceResult":[{"reportLabel":"Summary","reportId":"SUMMARY-V50","reportType":"tabular"},{"reportLabel":"UCS Readiness","reportId":"UCS-READINESS-T50","reportType":"tabular"},{"reportLabel":"Organizations","reportId":"ORGANIZATIONS-T50","reportType":"tabular"},{"reportLabel":"ChassisInventory","reportId":"CHASSIS-INVENTORY-S50","reportType":"snapshot"},{"reportLabel":"Server Inventory","reportId":"SERVER-INVENTORY-S50","reportType":"snapshot"},{"reportLabel":"Fabric Interconnect Inventory","reportId":"FABRIC-INTERCONNECT-INVENTORY-S50",
"reportType":"snapshot"},{"reportLabel":"Servers Associated vs Unassociated ","reportId":"SERVERS-ASSOCIATED-VS-UNASSOCIATED-S50","reportType":"snapshot"},
{"reportLabel":"Chassis","reportId":"CHASSIS-T50","reportType":"tabular"},{"reportLabel":"Servers","reportId":"SERVERS-T50","reportType":"tabular"},{"reportLabel":"Fabric Interconnects","reportId":"FABRIC-INTERCONNECTS-T50","reportType":"tabular"},
{"reportLabel":"Service Profiles","reportId":"SERVICE-PROFILES-T50","reportType":"tabular"},{"reportLabel":"Events","reportId":"EVENTS-T50","reportType":"tabular"},{"reportLabel":"VSANs","reportId":"VSANS-T50","reportType":"tabular"},{"reportLabel":"VLANs","reportId":"VLANS-T50","reportType":"tabular"},{"reportLabel":"Port Channels","reportId":"PORT-CHANNELS-T50","reportType":"tabular"},{"reportLabel":"QOS System Class","reportId":"QOS-SYSTEM-CLASS-T50","reportType":"tabular"},{"reportLabel":"Chassis Discovery Policy","reportId":"CHASSIS-DISCOVERY-POLICY-T50","reportType":"tabular"},
{"reportLabel":"Management IPPool","reportId":"MANAGEMENT-IP-POOL-T50","reportType":"tabular"},{"reportLabel":"Flow Control Policies","reportId":"FLOW-CONTROL-POLICIES-T50","reportType":"tabular"},
{"reportLabel":"Locales","reportId":"LOCALES-T50","reportType":"tabular"},{"reportLabel":"Faults","reportId":"FAULTS-T50","reportType":"tabular"}],"serviceError":null, "serviceName":"InfraMgr", "opName":"userAPIGetAvailableReports" }
Cisco UCS Director REST Developer Guide, Release 5.32
ReportsReports and JSON Object Response Samples
APIReportDefinitionList
This report provides an array of three name-value pairs: reportLabel, reportId, and reportType.
The following is a sample of the JSON Object Response for this report.
[{"reportLabel":"Summary","reportId":"SUMMARY-V1","reportType":"tabular"},{"reportLabel":"Summary","reportId":"SUMMARY-V0","reportType":"tabular"},{"reportLabel":"Active VM Distribution By Cloud","reportId":"ACTIVE-VM-DISTRIBUTION-BY-CLOUD-S0","reportType":"snapshot"},{"reportLabel":"Trend: Storage Capacity, Used & Free","reportId":"TREND-STORAGE-CAPACITY,-USED-&-FREE-H1","reportType":"trend"}
]
APITabularReport
This report provides an array of rows that consist of name-value pairs of columns. The report ID can be pickedfrom userAPIGetAvailableReports.
The following is a sample of this report.
[{"VMId":1,"Month":"October, 2010","Active_VM_Hours":231,"Inactive_VM_Hours":160,"Active_VM_Cost_USD":0,"Inactive_VM_Cost_USD":0,"One_time_Cost_USD":0,"Allocated_CPU_Cost_USD":0,"Reserved_CPU_Cost_USD":0,"Used_CPU_Cost_USD":0,"Allocated_Memory_Cost_USD":0,"Reserved_Memory_Cost_USD":0,"Used_Memory_Cost_USD":0,"Committed_Disk_Cost_USD":0,"Uncommitted_Disk_Cost_USD":0,"Total_Cost_USD":0}]
APIHistoricalReport
This report provides an array of series that consist of the parameter (legend) name and the values of datasamples for a given duration. The valid values for the duration are hourly, daily, weekly, and monthly. ThereportId must be picked from userAPIGetAvailableReports.
The following is a sample of this report.
{"series":[{"paramName":"cpuCapacityGhz","paramLabel":"CPU Capacity (GHz)","values":[
{"timestamp":1285728870845,"min":51.734405256,"max":51.734405256,"avg":51.734405256},{"timestamp":1285732492006,"min":51.734405256,"max":51.734405256,"avg":51.734405256},
Cisco UCS Director REST Developer Guide, Release 5.3 3
ReportsReports and JSON Object Response Samples
{"timestamp":1285736120878,"min":51.734405256,"max":51.734405256,"avg":51.734405256},{"timestamp":1285739726401,"min":51.734405256,"max":51.734405256,"avg":51.734405256}]}]}
APISnapshotReport
This report provides an array of categories that consist of name-value pairs of data samples. This report drillsdown through the data hierarchy. The reportId can be picked from userAPIGetAvailableReports.
The following is a sample of this report.
{"categoryAxisName":null,"valueAxisName":"Active vs Inactive","categories":[
{"categoryName":"","nameValuePairs":[
{"name":"Active VMs","value":"17"},{"name":"Inactive VMs","value":"51"}]}]}
APILoginProfile
This report provides the user ID, first name, last name, email, group name, and role.
The following is a sample of the JSON Object Response for this report.
"userId":"jsmith""firstName":"Smith""lastName":"John""email":"[email protected]""groupName":"test""groupId":"12""role":"GroupAdmin"
userAPIGetVMSummary (tabular report)
This report provides a summary report in tabular format for a specified VM.
The following is a sample of this report.
{"Overview_VM_ID":1,"Overview_Instance_Name":"My-Instance-120","Overview_Status":"UNKNOWN (poweredOn)","Overview_IP_Address":"10.10.1.120","Overview_Hostname":"coud-vc","Overview_Image_ID":"My-Instance-120","Overview_Cloud_Name":"VMware Cloud A","Overview_Cloud_Type":"VMWare","Ownership_Group":"Eng Group","Ownership_vDC":"Eng-SJ-Prd","Ownership_Category":"Application Server","Ownership_Service_Request_ID":"","Ownership_Label":"vCenter 120","Ownership_Provisioned_Time":"","Ownership_Scheduled_Termination_Time":"","Overview_Host_Node":"10.10.1.200","Network_Port_Group":"VM Network","Network_VLAN_ID":"0","Network_No_of_vNics":1,"Network_vNic_Mac_Address":"00:50:56:82:55:69","Network_vNic_Device_Config_Id":"4000",
Cisco UCS Director REST Developer Guide, Release 5.34
ReportsReports and JSON Object Response Samples
"Overview_Boot_Time":"Sep 25, 2010 18:54:23","Overview_Config_Name":"vCenter-Server 120","Overview_VM_Version":"4","Resources_Resource_Pool":"Resources","Resources_Num_Virtual_CPUs":1,"Resources_CPU_Reserved_MHz":2881,"Resources_CPU_Limit_MHz":-1,"Resources_CPU_Overhead_Limit_MHz":0,"Resources_CPU_Shares":"4000","Resources_Memory_MB":2056,"Resources_Memory_Reserved_MB":2050,"Resources_Memory_Limit_MB":0,"Resources_Memory_Overhead_Limit_MB":0,"Resources_Memory_Shares":"2560","Storage_Total_Provisioned_GB":43.02,"Storage_Committed_GB":15.31,"Storage_Uncommitted_GB":27.71,"Storage_Non_shared_GB":15.31,"Storage_Data_Store_Names":"storage2","Storage_VM_Path":"[storage2] VirtualCenter-Clone_Dec_09/VirtualCenter-Clone_Dec_09.vmx","Guest_Information_Guest_OS":"Microsoft Windows Server 2003,Enterprise Edition (32-bit)","Guest_Information_Guest_State":"running","Guest_Information_Tools_Status":"guestToolsRunning","Guest_Information_Tools_Version":"32039","Options_Default_PowerOff_Type":"hard"}
userAPIGetServiceContainerDetails (tabular report)
This report lists the service container details such as network summary, port mapping, virtual machineinformation, event history, and so on.
Input/app/api/rest?formatType=json&opName=fenced:userAPIGetServiceContainerDetails&opData={param0:"ga"}
Output{ "serviceResult":{"rows":[{"Overview_ID":19,"Overview_containerType":null,"Overview_containerName":"ga","Overview_containerLabel":"","Overview_containerState":1,"Template_Name":"temp_asa","Template_Group":"Default Group","Template_CreatedTime":"Mar 20, 2014 03:29:57 UTC","Template_LeasedTime":"","Template_ServiceRequest":193,"Template_Initiatedby":"admin","Template_ServiceRequestStatus":"Complete","Template_OrchestrationFlow":"Fenced Container Setup","Policy_UserAction":null,"Policy_VirtualCompute":"VMware-82 - Default Computing Policy","Policy_VirtualNetwork":"demo_akila","Policy_VirtualStorage":"VMware-82 - Default Storage Policy","Policy_VirtualSystem":"IT Sys","Policy_CostModel":"","vInfraPolicyInfo_PolicyName":"asa_pol","vInfraPolicyInfo_vAccount":"VMware-82","vInfraPolicyInfo_ContainerType":"Fenced Virtual","NetworkSummary_1_NetworkName":"lan0","NetworkSummary_1_VlanIDPool":"100-199","NetworkSummary_1_NetworkIP":"10.10.10.0","NetworkSummary_1_NetworkMask":"255.255.255.0","NetworkSummary_1_GatewayIP":"10.10.10.1","VMs_1_VMName":"asa_vm","VMs_1_ipaddress":"10.10.10.6","PortMapping_1_Protocol":6,"PortMapping_1_MappedPort":222,"PortMapping_1_RemoteIP":"10.10.10.4","PortMapping_1_RemotePort":222,"OutboundACL_1_Protocol":0,
Cisco UCS Director REST Developer Guide, Release 5.3 5
ReportsReports and JSON Object Response Samples
"OutboundACL_1_Network":"lan0","OutboundACL_1_SrcAddress":"0.0.0.0/0","OutboundACL_1_DestAddress":"0.0.0.0/0","OutboundACL_1_SrcPortRange":"0-65535","OutboundACL_1_DestPortRange":"0-65535","OutboundACL_1_Action":"ACCEPT","Options_isSelfServicePowerMgmt":"true","Options_isSelfServiceResize":"true","Options_isSelfServiceSnapshotMgmt":"true","Options_isSelfServiceDeleteVM":"false","Options_isSelfServiceDeleteContainer":"false","Options_isConsoleAccess":"true","Options_supportEmails":""}],"columnMetaData":null},"serviceError":null,"serviceName":"InfraMgr","opName":"fenced:userAPIGetServiceContainerDetails" }
userAPIGetAllVDCs (tabular report)
This report lists all virtual datacenters for the currently logged in user group. No parameters are required.
The following sample report lists the cloud, group, vDC, state, total number of VMs, number of active VMs,and Custom Categories for the user group.
[{"Cloud":"","Group":"Default Group","vDC":"Default vDC","State":"Locked","Total_VMs":67,"Active_VMs":17,"Custom_Categories":0},{"Cloud":"VMware Cloud A","Group":"Eng Group","vDC":"Eng-SJ-Prd","State":"Ok","Total_VMs":1,"Active_VMs":0,"Custom_Categories":0},{"Cloud":"VMware Cloud B","Group":"Eng Group","vDC":"Eng-SJ-161","State":"Ok","Total_VMs":0,"Active_VMs":0,"Custom_Categories":0},{"Cloud":"VMware Cloud B","Group":"Prod","vDC":"checkign delete","State":"Ok","Total_VMs":0,"Active_VMs":0,"Custom_Categories":0},{"Cloud":"VMware Cloud B","Group":"Eng Group","vDC":"Eng-Windows","State":"Ok","Total_VMs":0,"Active_VMs":0,"Custom_Categories":0}]
userAPIGetAllVMs (tabular report)
This report retrieves a report of all VMs for the logged in user and provides some management-level dataabout each VM.
Cisco UCS Director REST Developer Guide, Release 5.36
ReportsReports and JSON Object Response Samples
The following is a sample of this report.
[{"Cloud":"VMware Cloud A","VM_ID":"1","VM_Label":"","Instance_Name":"vCenter-Server 120","Host_Name":"coud-vc.","IP_Address":"10.10.1.120","Image_Id":"vCenter-Server 120","Power_State":"UNKNOWN","Group_Name":"Eng Group","vDC":"Eng-SJ-Prd","Category":"Application Server","Provisioned_Time":"","Scheduled_Termination_Time":"","Last_Status_Update":"Oct 14, 2010 01:19:22"},{"Cloud":"VMware Cloud A","VM_ID":"2","VM_Label":"","Instance_Name":"CentOS-53-HardenedOS","Host_Name":null,"IP_Address":null,"Image_Id":"CentOS-53-HardenedOS","Power_State":"UNKNOWN","Group_Name":"Default Group","vDC":"Default vDC","Category":"Discovered VM","Provisioned_Time":"","Scheduled_Termination_Time":"","Last_Status_Update":"Oct 14, 2010 01:19:22"}]
APIVMAction: userAPIGetAvailableVMActions
This report lists the available VM Actions possible for a given VM-ID.
The following is a sample of this report.
[{"actionName":"reconfigure","actionLabel":"Resize VM","actionType":"reconfigure"},{"actionName":"powerOn","actionLabel":"Power ON","actionType":"vmAction"},{"actionName":"powerOff","actionLabel":"Power OFF","actionType":"vmAction"},{"actionName":"suspend","actionLabel":"Suspend","actionType":"vmAction"},{"actionName":"shutdownGuest","actionLabel":"Shutdown Guest","actionType":"vmAction"},{"actionName":"standby","actionLabel":"Standby","actionType":"vmAction"},{"actionName":"reset","actionLabel":"Reset","actionType":"vmAction"},{"actionName":"reboot","actionLabel":"Reboot","actionType":"vmAction"}]
Cisco UCS Director REST Developer Guide, Release 5.3 7
ReportsReports and JSON Object Response Samples
APIVMActionStatus
This status report provides advice about the specified request for action with respect to a VM, such asinformation about the ActionStatus for a given VMActionRequest.Request. You can request this report withuserAPIGetVMActionStatus.
The following is a sample of this report.
{"vmId":476,"actionName":"powerOn","actionLabel":"Power ON","comment":"Powered ON through API","user":"admin","startTime":"Oct 19, 2010 15:54:08","endTime":"Oct 19, 2010 15:54:19","status":"Completed","message":""}
APIVMList
This report includes the cloud name, VM ID, instance ID, host name, IP address, image ID, power status,status message, and VM type.
The following is a sample of this report.
{ "serviceResult":{"rows":[{"Cloud":"VMware-138","VM_ID":2,"User_Label":"","VM_Name":"SJ-02-Perf-vCenter05","Host_Name":"WIN-0EVDFER0O7E","IP_Address":"172.29.109.138","Image_Id":"SJ-02-Perf-vCenter05","Host_Node":"172.29.109.42","Power_Status":"ON","Group_Name":"Default Group","vDC":"Default vDC","Category":"Discovered VM","Provisioned_Time":"","Scheduled_Termination_Time":"","Last_Status_Update":"Nov 19, 2013 13:47:10 PST","Guest_OS_Type":"Microsoft Windows Server 2008 R2 (64-bit)"
}{"Cloud":"VMware-138","VM_ID":23,"User_Label":"","VM_Name":"CUCSD-4.1.0.0_FuncTest_Agent_2_Jatin","Host_Name":"localhost.localdom","IP_Address":"172.29.109.209","Image_Id":"CUCSD-4.1.0.0_FuncTest_Agent_2_Jatin","Host_Node":"172.29.109.32","Power_Status":"ON","Group_Name":"Default Group","vDC":"Default vDC","Category":"Discovered VM","Provisioned_Time":"","Scheduled_Termination_Time":"","Last_Status_Update":"Nov 19, 2013 13:47:10 PST","Guest_OS_Type":"CentOS 4/5/6 (64-bit)"
}],"columnMetaData":null}, "serviceError":null, "serviceName":"InfraMgr", "opName":"userAPIGetTabularReport"}
APIServiceRequestDetails
This report provides the request ID, request type, initiating user, group name, request time, comments, provisionquantity, provision catalog, provision vDC name, and provision duration hours.
APIWorkFlowStatus
This report provides service request workflow details with workflow status updates. APIWorkFlowStatus hasmultiple parameters that are categorized by the workflow steps.
The following is a sample of this report.
stepId: "Initiated by admin",executionStatus: 3,statusMessage: "",handlerId: 4,startedTime: -1,
Cisco UCS Director REST Developer Guide, Release 5.38
ReportsReports and JSON Object Response Samples
completedTime: 1289962148379,validTill: -1,startAfter: -1
stepId: "Budget Watch",executionStatus: 3,statusMessage: "Budget check successful.",handlerId: 8,startedTime: -1,completedTime: 1289962171550,validTill: -1,startAfter: -1
stepId: "Check Resource Limits",executionStatus: 3,statusMessage: "Resource limit check successful"handlerId: 9,startedTime: -1,completedTime: 1289962189739,validTill: -1,startAfter: -1
stepId: "Resource Allocation",executionStatus: 3,statusMessage: "Allocated Host: 192.168.0.129",handlerId: 6,startedTime: -1,completedTime: 1289962212294,validTill: -1,startAfter: -1
stepId: "Provision",executionStatus: 3,statusMessage: "Provisioning completed",handlerId: 3,startedTime: -1,completedTime: 1289963432562,validTill: -1,startAfter: -1
stepId: "Setup Lifecycle Schedule",executionStatus: 3,statusMessage: null,handlerId: 2,startedTime: -1,completedTime: 1289964123734,validTill: -1,startAfter: -1
stepId: "Notify",executionStatus: 3,statusMessage: null,handlerId: 1,startedTime: -1,completedTime: 1289964161227,validTill: -1,startAfter: -1
Using GetAvailableReports to Obtain ReportIdsIf you need to request a report, the reportId is crucial. One way to get a reportId is to query the report's contextwith userAPIGetAvailableReports. This yields a tabular report that contains the reportId of every reportavailable at the specified context level.
For example, to query all available reports available at the Cisco UCS Director context level, use theuserAPIGetAvailableReports operation and specify that you want the UCS Account Level Reports, as
Cisco UCS Director REST Developer Guide, Release 5.3 9
ReportsUsing GetAvailableReports to Obtain ReportIds
follows: http://localhost:8080/app/api/rest?/formatType=json&opName=userAPIGetAvailableReports&opData={param0:"ucsm",param1:""}
Replace localhost:8080 with the Cisco UCS Director server IP.Note
Here is the API response:
{ "serviceResult":[{"reportLabel":"Summary","reportId":"SUMMARY-V50","reportType":"tabular"},{"reportLabel":"UCS Readiness","reportId":"UCS-READINESS-T50","reportType":"tabular"},{"reportLabel":"Organizations","reportId":"ORGANIZATIONS-T50","reportType":"tabular"},{"reportLabel":"Chassis Inventory","reportId":"CHASSIS-INVENTORY-S50","reportType":"snapshot"},{"reportLabel":"Server Inventory","reportId":"SERVER-INVENTORY-S50","reportType":"snapshot"},{"reportLabel":"Fabric Interconnect Inventory","reportId":"FABRIC-INTERCONNECT-INVENTORY-S50","reportType":"snapshot"},{"reportLabel":"Servers Associated vs Unassociated ","reportId":"SERVERS-ASSOCIATED-VS-UNASSOCIATED-S50","reportType":"snapshot"},{"reportLabel":"Chassis","reportId":"CHASSIS-T50","reportType":"tabular"},{"reportLabel":"Servers","reportId":"SERVERS-T50","reportType":"tabular"},{"reportLabel":"Fabric Interconnects","reportId":"FABRIC-INTERCONNECTS-T50","reportType":"tabular"},{"reportLabel":"Service Profiles","reportId":"SERVICE-PROFILES-T50","reportType":"tabular"},{"reportLabel":"Events","reportId":"EVENTS-T50","reportType":"tabular"},{"reportLabel":"VSANs","reportId":"VSANS-T50","reportType":"tabular"},{"reportLabel":"VLANs","reportId":"VLANS-T50","reportType":"tabular"},{"reportLabel":"Port Channels","reportId":"PORT-CHANNELS-T50","reportType":"tabular"},{"reportLabel":"QOS System Class","reportId":"QOS-SYSTEM-CLASS-T50","reportType":"tabular"},{"reportLabel":"Chassis Discovery Policy","reportId":"CHASSIS-DISCOVERY-POLICY-T50","reportType":"tabular"},{"reportLabel":"Management IP Pool","reportId":"MANAGEMENT-IP-POOL-T50","reportType":"tabular"},{"reportLabel":"Flow Control Policies","reportId":"FLOW-CONTROL-POLICIES-T50","reportType":"tabular"},{"reportLabel":"Locales","reportId":"LOCALES-T50","reportType":"tabular"},{"reportLabel":"Faults","reportId":"FAULTS-T50","reportType":"tabular"}], "serviceError":null, "serviceName":"InfraMgr", "opName":"userAPIGetAvailableReports" }
The report shown above lists all of the reports in the context, providing each report ID and its report format.
To get any particular report at the Cisco UCS Director account context level, use the reportId from the APIoutput above. For example, to query a chassis report at the Cisco UCS Director account context level, call theuserAPIGetTabularReport API, as follows:
http://localhost:8080/app/api/rest?/formatType=json&opName=userAPIGetTabularReport&opData={param0:"ucsm",param1:"ucsm57",param2:"CHASSIS-T50"}
The first through third parameters are the context, query value, and report ID; the param1 query value isin the ID column in the following tabular report.
Note
The following response is returned:
{ "serviceResult":{"rows":[{"ID":"ucsm 57;sys/chassis-1","Account_Name":"ucsm 57","DN":"sys/chassis-1","Serial_Number":"1","Model":"N20-C6508","Power_State":"ok","Operation_State":
Cisco UCS Director REST Developer Guide, Release 5.310
ReportsUsing GetAvailableReports to Obtain ReportIds
"operable","Configuration_State":"ok","License_State":"license-ok","Servers":4,"IO_Modules":2,"PSUs":4,"Fan_Modules":8,"Vendor":"Cisco Systems Inc"},{"ID":"ucsm 57;sys/chassis-2","Account_Name":"ucsm 57","DN":"sys/chassis-2","Serial_Number":"2","Model":"N20-C6508","Power_State":"ok","Operation_State":"operable","Configuration_State":"ok","License_State":"license-ok","Servers":4,"IO_Modules":2,"PSUs":4,"Fan_Modules":8,"Vendor":"Cisco Systems Inc"}],"columnMetaData":null},"serviceError":null, "serviceName":"InfraMgr", "opName":"userAPIGetTabularReport" }Similarly, you can query the available reports at each context by applying the userAPIGetAvailableReportsAPI to other contexts. Then, using one of the reportIds returned in the response, you can request a specificreport using the appropriate API operation and context data.
If you are missing a key piece of information necessary to create an API request for a report (the properoperation name to use in the API request, for example), you can probably fill in that information byreferring to the List of Available Cisco UCS Director Reports, on page 13. With two or more pieces ofthe crucial information (the reportId, the context, the type of report you want), the list may enable you tofill in the information necessary to construct the necessary request. Most reports are of three basic types,and three corresponding operations are used to request them.
Tip
Tabular ReportsThis type of report is either a vertical table (which can provide summary data) or a horizontal table of multiplerows and columns. Essentially, the tabular report is an array of rows consisting of name value pairs. You canget the reportIds for these reports returned as summary data by the operation userAPIGetAvailableReports.The reportIds are suffixed with -V or -T, for Vertical or Tabular (horizontal) respectively. Tabular reportsand Tabular with Action reports are both considered Tabular reports, and you must request them with theuserAPIGetTabularReport method.
The Summary reports that list all available reports within a context have a tabular structure, but you requestthem through the operation userAPIGetAvailableReports. As with other tabular format reports, the namesare suffixed with -V or -T.
Note
Example of a Tabular Report{ "serviceResult":{"rows":[{"ID":"ucsm 57;sys/chassis-1","Account_Name":"ucsm 57","DN":"sys/chassis-1","Serial_Number":"1","Model":"N20-C6508","Power_State":"ok","Operation_State":"operable","Configuration_State":"ok","License_State":"license-ok","Servers":4,"IO_Modules":2,"PSUs":4,"Fan_Modules":8,"Vendor":"Cisco Systems Inc"},{"ID":"ucsm 57;sys/chassis-2","Account_Name":"ucsm 57",
Cisco UCS Director REST Developer Guide, Release 5.3 11
ReportsTabular Reports
"DN":"sys/chassis-2","Serial_Number":"2","Model":"N20-C6508","Power_State":"ok","Operation_State":"operable","Configuration_State":"ok","License_State":"license-ok","Servers":4,"IO_Modules":2,"PSUs":4,"Fan_Modules":8,"Vendor":"Cisco Systems Inc"}],
"columnMetaData":null},"serviceError":null,"serviceName":"InfraMgr","opName":"userAPIGetTabularReport" }
Historical ReportsThe historic report is also known as a trend report. You use this type of report to monitor trends such as theusage of a resource, or the occurrence of events, over time. Typical trend reports present information such asCPU or network usage, or "VM Additions & Deletions" over a given period of time. The response format,APIHistoricalReport, is an array of series consisting of parameter (legend) names and the values of datasamples for a given duration. The valid values for the duration are "hourly", "daily", "weekly" and "monthly".The reportId for this type of report is suffixed with -H.
Example of a Historical Report{"series":[
{"paramName":"cpuCapacityGhz","paramLabel":"CPU Capacity (GHz)","values":[
{"timestamp":1285728870845,"min":51.734405256,"max":51.734405256,"avg":51.734405256},{"timestamp":1285732492006,"min":51.734405256,"max":51.734405256,"avg":51.734405256},{"timestamp":1285736120878,"min":51.734405256,"max":51.734405256,"avg":51.734405256},{"timestamp":1285739726401,"min":51.734405256,"max":51.734405256,"avg":51.734405256}]}]}
Snapshot ReportsThe snapshot report is an instant report about a resource at any given point in time. For example, the snapshotreport of a VM's CPU usage provides the current CPU utilization value. The APISnapshotReport is an arrayof categories which consist of name-value pairs of data samples. Pie Chart and Bar Chart reports are consideredSnapshot reports. You must request a Snapshot report with the userAPIGetInstantDataReport method. ThereportId for this type of report is suffixed with -S.
Cisco UCS Director REST Developer Guide, Release 5.312
ReportsHistorical Reports
Example of a Snapshot Report{"categoryAxisName":null,"valueAxisName":"Active vs Inactive","categories":[
{"categoryName":"","nameValuePairs":[
{"name":"Active VMs","value":"17"},{"name":"Inactive VMs","value":"51"}]}]}
List of Available Cisco UCS Director ReportsIn the following table, reports are grouped by context. The same report (with the same reportID) may be usedfor different contexts, and so may appear in multiple locations in this list.
Report IDs are always single strings without character spaces. Because some of these strings are verylong, they are broken across multiple lines within individual table cells below. If you perform an electronicsearch for a full, exact reportId string, it may not return a result because the break inserts a character space;search instead for a short unique string contained within the full reportId character string.
Note
Report TypeReport IDReport NameContext
SummarySUMMARY-V0SummaryAWS-EC2 cloud
TabularVMS-T0VMsAWS-EC2 cloud
TabularIMAGES-T0ImagesAWS-EC2 cloud
TabularDELETED-VMS-T0Deleted VMsAWS-EC2 cloud
Bar ChartMEMORY-S0MemoryAWS-EC2 cloud
Bar ChartCPU-S0VPUAWS-EC2 cloud
Bar ChartDISK-S0DiskAWS-EC2 cloud
TrendTREND-MEMORY-H0Trend: MemoryAWS-EC2 cloud
TrendTREND-CPU-H0Trend: CPUAWS-EC2 cloud
TrendTREND-CPU-USAGE-H0Trend: CPU UsageAWS-EC2 cloud
TrendTREND-DISK-READS-&-WRITES-(BYTES)-H0
Trend: Disk Reads &Writes (bytes)
AWS-EC2 cloud
TrendTREND-DISK-READS-&-WRITES-(OPS)-H0
Trend: Disk Reads &Writes (ops)
AWS-EC2 cloud
Cisco UCS Director REST Developer Guide, Release 5.3 13
ReportsExample of a Snapshot Report
Report TypeReport IDReport NameContext
TrendTREND-DISK-READS-&-WRITES-(OPS)-H0
Trend: Disk Reads &Writes (ops)
AWS-EC2 cloud
TrendTREND-NETWORK-USAGE-H0Trend: Network UsageAWS-EC2 cloud
TabularGROUPS-WITH-MOST-CPU-USAGE-T0
Groups with Most CPUUsage
AWS-EC2 cloud
TabularVMS-WITH-MOST -CPU-USAGE-T0VMs With MostTrend:CPU Usage
AWS-EC2 cloud
TabularVMS-WITH-OVER-UTILIZED-CPU-USAGE-T0
VMs With Over-UtilizedCPU Usage
AWS-EC2 cloud
TabularVMS-WITH-UNDER-UTILIZED-CPU-USAGE-T0
VMs With Under-UtilizedCPU Usage
AWS-EC2 cloud
Tabular withActions
VOLUMES-X1VolumesAWS-EC2 cloud
Tabular withActions
SNAPSHOTS-X1SnapshotsAWS-EC2 cloud
SummarySUMMARY-V1SummaryAWS-EC2 cloud
TabularSP-STATUS-T0SP StatusAWS-EC2 cloud
Bar ChartCPU-USAGE-(PERCENT)-S0CPU Usage (percent)AWS-EC2 vm
Bar ChartNETWORK-IN-S0Network InAWS-EC2 vm
Bar ChartNETWORK-OUT-S0Network OutAWS-EC2 vm
TrendTREND-CPU-USAGE-H0Trend: CPU UsageAWS-EC2 vm
TrendTREND-DISK-READS-&-WRITES-(BYTES)-H0
Trend: Disk Reads &Writes (bytes)
AWS-EC2 vm
TrendTREND-DISK-READS-&-WRITES-(OPS)-H0
Trend: Disk Reads &Writes (ops)
AWS-EC2 vm
TrendNETWORK-USAGE-H0Network UsageAWS-EC2 vm
TabularDEPLOYABILITY-ASSESSMENT-T45Deployability Assessmentcatalog
TabularVDCS-T0vDCscloud
TabularEVENTS-T0Eventscloud
Cisco UCS Director REST Developer Guide, Release 5.314
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
Bar ChartNUMBER-OF-EVENTS-BY-SEVERITY-S0
Number of Events bySeverity
cloud
TabularGROUPS-WITH-MOST-NUMBER-OF-VMS-T0
GroupsWIthMost Numberof VMs
cloud
TabularVDCS-WITH-MOST-NUMBER-OF-VMS-T0
vDCs With Most Numberof VMs
cloud
TabularVDCS-WITH-MOST-CPU-USAGE-T0vDCs With Most CPUUsage
cloud
TabularVDCS-WITH-MOST-MEMORY-USAGE-T0
vDCs With Most MemoryUsage
cloud
TabularVDCS-WITH-MOST-DISK-USAGE-T0
vDCs With Most DiskUsage
cloud
Tabular withActions
VM-ACTION-REQUESTS-X0VM Action Requestscloud, vm
SummarySUMMARY-V50Summarycompute_chassis
TabularSERVERS-T50Serverscompute_chassis
TabularFAN-MODULES-T50Fan Modulescompute_chassis
TabularIO-MODULES-T50IO Modulescompute_chassis
TabularPOWER-SUPPLY-UNITS-T50Power Supply Unitscompute_chassis
TabularEVENTS-T50Eventscompute_chassis
SummarySUMMARY-V50Summarycompute_fbi
TabularPOWER-SUPPLY-UNITS-T50Power Supply Unitscompute_fbi
TabularFANS-T50Fanscompute_fbi
Tabular withActions
ETHERNET-PORTS-X50Ethernet Portscompute_fbi
Tabular withActions
FIBRE-CHANNEL-PORTS-X50Fibre Channel Portscompute_fbi
TrendTREND-ETHERNET-PORTS-TOTAL-KILO-BYTES-TRANSFERRED/RECEIVED-H50
Trend: Ethernet Ports TotalKilo BytesTransferred/Received
compute_fbi
Cisco UCS Director REST Developer Guide, Release 5.3 15
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TrendTREND-FIBRE-CHANNEL-PORTS-TOTAL-KILO-BYTES-TRANSFERRED/RECEIVED-H50
Trend: Fibre Channel PortsTotal Kilo BytesTransferred/Received
compute_fbi
TrendTREND-CPU-UTILIZATION-H50Trend: CPU Utilizationcompute_fbi
TrendTREND-MEMORY-H50Trend: Memorycompute_fbi
TabularEVENTS-T50Eventscompute_fbi
SummaryPORT-SUMMARY-V50Port Summarycompute_fbi_port
TabularLOCAL-DISKS-T50Local Diskscompute_server
TabularMEMORY-UNITS-T50Memory Unitscompute_server
TabularPROCESSOR-UNITS-T50Processor Unitscompute_server
Tabular withActions
INTERFACE-CARDS-X50Interface Cardscompute_server
TabularSERVICE-REQUEST-DETAILS-T50Service Request Detailscompute_server
TrendTREND-MOTHERBOARD-INPUT-CURRENT-RECEIVED-H50
Trend: MotherBoard InputCurrent Received
compute_server
TrendTREND-MOTHERBOARD-INPUT-VOLTAGE-RECEIVED-H50
Trend: MotherBoard InputVoltage Received
compute_server
TrendTREND-MOTHERBOARD-CONSUMED-POWER-H50
Trend: MotherBoardConsumed Power
compute_server
TrendTREND-MOTHERBOARD-SENS-IO-TEMPERATURE-H50
Trend: MotherBoard SensIO Temperature
compute_server
TrendTREND-MOTHERBOARD-SENS-REAR-TEMPERATURE-H50
Trend: MotherBoard SensRear Temperature
compute_server
TrendTREND-MEMORY-UNIT-TEMPERATURE-H50
Trend: Memory UnitTemperature
compute_server
TrendTREND-PROCESSOR-UNIT-CURRENT-H50
Trend: Processor UnitCurrent
compute_server
TrendTREND-PROCESSOR-UNIT-TEMPERATURE-H50
Trend: Processor UnitTemperature
compute_server
SummarySUMMARY-V50Summarycompute_server
Cisco UCS Director REST Developer Guide, Release 5.316
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularEVENTS-T50Eventscompute_server
TabularDCE-INTERFACES-T50DCE Interfacescompute_server_adapter_unit
TabularHBAS-T50HBAscompute_server_adapter_unit
TabularNICS-T50NICscompute_server_adapter_unit
Tabular withActions
ADD/EDIT-TASKS-X46Add/Edit Taskscustom_actions
TabularSTORAGE-ACCOUNTS-T51Storage Accountsdatacenter
TabularTOP-5-VOLUME-TOTAL-USED-STORAGE-T9999
Top 5 Volume Total-UsedStorage
datacenter
TabularTOP-5-LUN-TOTAL-USED-STORAGE-T9999
Top 5 Lun Total-UsedStorage
datacenter
SummarySUMMARY-V51Summarydatacenter
Bar ChartVOLUMES-TOTAL-VS-USED-S51Volumes: Total vs Useddatacenter
Bar ChartLUNS-TOTAL-VS-USED-S51LUNs: Total vs Useddatacenter
Pie ChartAGGREGATES-FREE-VS -USED-S51Aggregates: Free vs Useddatacenter
Tabular withActions
UCSM-ACCOUNTS-X50UCSM Accountsdatacenter
TabularCHASSIS-T50Chassisdatacenter
TabularFABRIC-INTERCONNECTS-T9999Fabric Interconnectsdatacenter
TabularSERVER-POOLS-T9999Server Poolsdatacenter
SummarySUMMARY-V50Summarydatacenter
TabularSERVICE-PROFILES-T9999Service Profilesdatacenter
TabularPROCESSOR-UNITS-T9999Processor Unitsdatacenter
TabularMEMORY-UNITS-T9999Memory Unitsdatacenter
TabularLOCAL-DISKS-T9999Local Disksdatacenter
Cisco UCS Director REST Developer Guide, Release 5.3 17
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularIO-MODULES-T9999IO Modulesdatacenter
Tabular withActions
MANAGED-NETWORK-ELEMENTS-X52
Managed NetworkElements
datacenter
TabularVTP-STATUS-T52VTP Statusdatacenter
TabularPRIVATE-VLANS-T52Private VLANsdatacenter
TabularL2-NEIGHBORS-T52L2 Neighborsdatacenter
TabularPORT-PROFILES-T52Port Profilesdatacenter
TabularVM-NETWORK-DETAILS-T52VM Network Detailsdatacenter
TabularHOST-NETWORK-DETAILS-T52Host Network Detailsdatacenter
TabularVSANS-T52VSANsdatacenter
Tabular withActions
VLANS-X52VLANsdatacenter
Tabular withActions
HP-ACCOUNTS-X50HP Accountsdatacenter
TabularDHCP-LOG-T50DHCP Logdatacenter
Tabular withActions
PXE-BOOT-REQUESTS-X50PXE Boot Requestsdatacenter
SummarySUMMARY-V0Summaryglobal
TabularCLOUDS-T0Cloudsglobal
TabularVDCS-T0vDCsglobal
TabularCLUSTERS-T0Clustersglobal
TabularVMS-T0VMsglobal
TabularHOST-NODE-STATUS-T0Host Node Statusglobal
TabularHOST-NODE-INVENTORY-T0Host Node Inventoryglobal
TabularRESOURCE-POOLS-T0Resource Poolsglobal
TabularEVENTS-T0Eventsglobal
TabularIMAGES-T0Imagesglobal
Cisco UCS Director REST Developer Guide, Release 5.318
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularDELETED-VMS-T0Deleted VMsglobal
TabularSYSTEM-HEALTH-T30System Healthglobal
Pie ChartACTIVE-VM-DISTRIBUTION-BY-CLOUD-S0
Active VM Distributionglobal
Pie ChartACTIVE-VMS-PUBLIC-VS-PRIVATE-CLOUDS-S0
Active VMs Public vsPrivate By Clouds
global
Bar ChartMEMORY-S0Memoryglobal
Bar ChartCPU-S0CPUglobal
Bar ChartDISK-S0Diskglobal
Pie ChartPRIVATE-CLOUD-STORAGE-CAPACITY-S1
Private Cloud StorageCapacity
global
Pie ChartPRIVATE-CLOUD-FREE-STORAGE-S1Private Cloud Free Storageglobal
Pie ChartPRIVATE-CLOUD-USED-STORAGE-S1Private CloudUsed Storageglobal
Bar ChartSTORAGE-CAPACITY-PER-STORAGE-TYPE-S1
Storage Capacity PerStorage Type
global
Bar ChartUSED-STORAGE-PER-STORAGE-TYPE-S1Used Storage Per StorageType
global
Bar ChartFREE-STORAGE-PER-STORAGE-TYPE-S1Free Storage Per StorageType
global
Bar ChartTOP-5-DATASTORES-MOST-USED-S1Top 5 Datastores MostUsed
global
Bar ChartTOP-5-DATASTORES-LEAST-USED-S1Top 5 Datastores LeastUsed
global
Bar ChartNUMBER-OF-EVENTS-S0Number of Eventsglobal
TrendTREND-NUMBER-OF-HOST-NODES-H0Trend: Number of HostNodes
global
TrendTREND-MEMORY-H0Trend: Memoryglobal
TrendTREND-STORAGE-CAPACITY,-USED-&-FREE-H1
Trend: Storage Capacity,Used & Free
global
TrendTREND-CPU-H0Trend: CPUglobal
Cisco UCS Director REST Developer Guide, Release 5.3 19
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularALL-VMWARE-ACTIVITY-T0All VMware Activityglobal
SummarySUMMARY-V1Summaryglobal
TabularSP-STATUS-T0SP Statusglobal
Bar ChartVMS-ACTIVE-VS-INACTIVE-S0VMs Active vs Inactiveglobal, cloud
TrendTREND-NUMBER-OF-VMS-H0Trend: Number of VMsglobal, cloud
TrendTREND-VM-ADDITIONS-&-DELETIONS-H0
Trend: VM Additions &Deletions
global, cloud
TabularNETAPPVOLUMESTABLE-T9999NetAppVolumesTableglobal_admin
TabularNETAPPVFILERVOLUMESTABLE-T9999
NetAppVFilerVolumesTable
global_admin
TabularNETAPPLUNSTABLE-T9999NetAppLunsTableglobal_admin
TabularNETAPPVFILERLUNSTABLE-T9999NetAppVFilerLunsTableglobal_admin
TabularNETAPPFILERSTABLE-T9999NetAppFilersTableglobal_admin
TabularNETAPPINITIATORGROUPSTABLE-T9999
NetAppInitiatorGroupsTable
global_admin
TabularNETAPPVFILERINITIATORGROUPSTABLE-T9999
NetAppVFilerInitiatorGroups Table
global_admin
TabularNETAPPIPSPACESTABLE-T9999NetAppIPSpacesTableglobal_admin
TabularNETAPPVFILERSTABLE-T9999NetAppVFilersTableglobal_admin
TabularNETAPPAGGREGATESTABLE-T9999NetAppAggregatesTableglobal_admin
TabularNETAPPONTAPACCOUNTSTABLE-T9999
NetAppONTAPAccountsTable
global_admin
TabularNETAPPDFMACCOUNTSTABLE-T9999
NetAppDFMAccountsTable
global_admin
TabularNETAPPDFMFILERTABLE-T9999NetAppDFMFiler Tableglobal_admin
TabularNETAPPONTAPFILERTABLE-T9999NetAppONTAPFiler Tableglobal_admin
TabularNETAPPONTAPVFILERSTABLE-T9999
NetAppONTAPvFilersTable
global_admin
Cisco UCS Director REST Developer Guide, Release 5.320
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularNETAPPUNASSIGNEDIPSPACESTABLE-T9999
NetAppUnAssignedIPSpacesTable
global_admin
TabularNETAPPINTERFACESTABLE-T9999NetAppInterfacesTableglobal_admin
TabularNETAPPVLANPHYSICALINTERFACESTABLE-T9999
NetAppVLANPhysicalInterfacesTable
global_admin
TabularNETAPPINTERFACESVFILERSASSIGNEDTABLE-T9999
NetAppInterfacesvFilersAssigned Table
global_admin
TabularNETAPPDFMVFILERSTABLE-T9999NetAppDFMvFilersTableglobal_admin
TabularNETAPPDFMVOLUMEDATASETTABLE-T9999
NetAppDfmVolumeDatasetTable
global_admin
TabularNETAPPDFMLUNDATASETTABLE-T9999
NetAppDfmLUNDatasetTable
global_admin
TabularNETAPPDFMGROUPTABLE-T9999NetAppDfmGroupTableglobal_admin
TabularNETAPPDFMPROVISIONPOLICYTABLE-T9999
NetAppDfmProvisionPolicyTable
global_admin
TabularNETAPPDFMSTORAGESERVICETABLE-T9999
NetAppDfmStorageServiceTable
global_admin
TabularNETAPPUNASSIGNEDDATASETTABLE-T9999
NetAppUnAssignedDatasetTable
global_admin
TabularNETAPPASSIGNEDDATASETTABLE-T9999
NetAppAssignedDatasetTableglobal_admin
TabularNETAPPDATASETTABLE-T9999NetAppDatasetTableglobal_admin
TabularNETAPPDATASETMEMBERLUNTABLE-T9999
NetAppDatasetMemberLUN Table
global_admin
TabularNETAPPREOURCEPOOLTABLE-T9999NetAppReourcePoolTableglobal_admin
TabularNETAPPGROUPASSIGNEDVFILERSTABLE-T9999
NetAppGroupAssignedVFilersTable
global_admin
TabularPROVISIONING-POLICIES-T48Provisioning Policiesglobal_admin
TabularPROTECTION-POLICIES-T48Protection Policiesglobal_admin
TabularSTORAGE-SERVICES-T48Storage Servicesglobal_admin
Cisco UCS Director REST Developer Guide, Release 5.3 21
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularVFILER-TEMPLATES-T48vFiler Templatesglobal_admin
TabularONCOMMAND-DATASETS-T48OnCommand Datasetsglobal_admin
TabularONCOMMAND-GROUPS-T48OnCommand Groupsglobal_admin
TabularRESOURCE-POOL-T48Resource Poolglobal_admin
TabularUIMENUITEMTABLE-T9999UIMenuItemTableglobal_admin
TabularUIOPERATIONTABLE-T9999UIOperationTableglobal_admin
Tabular withActions
CUSTOMER-ORGANIZATIONS-X23Customer Organizationsglobal_admin
TabularCUSTOMER-ORGANIZATIONS-T23Customer Organizationsglobal_admin
TabularCUSTOMER-ORGANIZATIONS-T23Customer Organizationsglobal_admin
Tabular withActions
MSP-ORGANIZATIONS-X23MSP Organizationsglobal_admin
TabularMSP-ORGANIZATIONS-T23MSP Organizationsglobal_admin
Tabular withActions
LOGIN-PAGE-BRANDING-X23Login Page Brandingglobal_admin
TabularLOGIN-PAGE-BRANDING-T23Login Page Brandingglobal_admin
Tabular withActions
LOGIN-USERS-X23Login Usersglobal_admin
TabularLOGIN-USERS-T23Login Usersglobal_admin
OtherCURRENT-ONLINE-USERS-X23Current Online Usersglobal_admin
Tabular withActions
VIRTUAL-ACCOUNTS-X22Virtual Accountsglobal_admin
TabularVIRTUAL-ACCOUNTS-T22Virtual Accountsglobal_admin
Tabular withActions
PHYSICAL-ACCOUNTS-X24Physical Accountsglobal_admin
TabularPHYSICAL-ACCOUNTS-T24Physical Accountsglobal_admin
Tabular withActions
CATALOG-X40Catalogglobal_admin
Cisco UCS Director REST Developer Guide, Release 5.322
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularUCSORGANIZATION TABLE-T9999UcsOrganizationTableglobal_admin
TabularUCSSERVERTABLE-T9999UcsServerTableglobal_admin
TabularUCSSERVICEPROFILETABLE-T9999UcsServiceProfileTableglobal_admin
TabularUCSSERVERPOOLTABLE-T9999UcsServerPoolTableglobal_admin
TabularUCSBOOTPOLICYTABLE-T9999UcsBootPolicyTableglobal_admin
Tabular withActions
DATA-CENTERS-X24Data Centersglobal_admin
TabularDATA-CENTERS-T24Data Centersglobal_admin
Tabular withActions
STORAGE-POLICY-X47Storage Policyglobal_admin
Tabular withActions
NETWORK-POLICY-X47Network Policyglobal_admin
Tabular withActions
VHBA-X47vHBAglobal_admin
Tabular withActions
VNIC-X47vNICglobal_admin
Tabular withActions
PLACEMENT-POLICY-X47Placement Policyglobal_admin
TabularDEVICEZONESTABLE-T9999deviceZonesTableglobal_admin
Tabular withActions
VENDOR-VALIDATED-DESIGNS-X24
Vendor Validated Designsglobal_admin
TabularHPSERVERTABLE-T9999HpServerTableglobal_admin
Tabular withActions
REPORTS-CUSTOMIZATION-X20Reports Customizationglobal_admin
Tabular withActions
AMAZON-DEPLOYMENT-POLICY-X41Amazon DeploymentPolicy
global_admin
TabularAMAZON-DEPLOYMENT-POLICY-T41Amazon DeploymentPolicy
global_admin
Tabular withActions
VMWARE-DEPLOYMENT-POLICY-X21VMware DeploymentPolicy
global_admin
Cisco UCS Director REST Developer Guide, Release 5.3 23
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularVMWARE-DEPLOYMENT-POLICY-T21VMware DeploymentPolicy
global_admin
Tabular withActions
RESOURCE-ALLOCATION-POLICY-X21Resource Allocation Policyglobal_admin
TabularRESOURCE-ALLOCATION-POLICY-T21Resource Allocation Policyglobal_admin
Tabular withActions
RACKSPACE-DEPLOYMENT-POLICY-X41Rackspace DeploymentPolicy
global_admin
TabularRACKSPACE-DEPLOYMENT-POLICY-T41Rackspace DeploymentPolicy
global_admin
Tabular withActions
KVM-DEPLOYMENT-POLICY-X41KVM Deployment Policyglobal_admin
TabularKVM-DEPLOYMENT-POLICY-T41KVM Deployment Policyglobal_admin
Tabular withActions
VMWARE-NETWORK-POLICY-X44VMware Network Policyglobal_admin
TabularVMWARE-NETWORK- POLICY-T44VMware Network Policyglobal_admin
Tabular withActions
NETWORK-PROVISIONING-POLICY-X44
Network ProvisioningPolicy
global_admin
TabularNETWORK-PROVISIONING-POLICY-T44
Network ProvisioningPolicy
global_admin
Tabular withActions
VLAN-POOL-POLICY-X44VLAN Pool Policyglobal_admin
TabularVLAN-POOL-POLICY-T44VLAN Pool Policyglobal_admin
Tabular withActions
VIRTUAL-STORAGE-CATALOG-X43
Virtual Storage Catalogglobal_admin
TabularVIRTUAL-STORAGE-CATALOG-T43Virtual Storage Catalogglobal_admin
Tabular withActions
VMWARE-STORAGE- POLICY-X43VMware Storage Policyglobal_admin
TabularVMWARE-STORAGE- POLICY-T43VMware Storage Policyglobal_admin
Tabular withActions
VMWARE-SYSTEM-POLICY-X41VMware Storage Policyglobal_admin
TabularVMWARE-SYSTEM-POLICY-T41VMware Storage Policyglobal_admin
Cisco UCS Director REST Developer Guide, Release 5.324
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
Tabular withActions
VMWARE-COMPUTING-POLICY-X42
VMwareComputing Policyglobal_admin
TabularVMWARE-COMPUTING-POLICY-T42
VMwareComputing Policyglobal_admin
Tabular withActions
KVM-COMPUTING-POLICY-X42KVM Computing Policyglobal_admin
TabularKVM-COMPUTING-POLICY-T42KVM Computing Policyglobal_admin
Tabular withActions
COST-MODEL-X41Cost Modelglobal_admin
TabularCOST-MODEL-T41Cost Modelglobal_admin
Tabular withActions
STORAGE-TIER-COST-MODEL-X41Storage Tier Cost Modelglobal_admin
TabularSTORAGE-TIER-COST-MODEL-T41Storage Tier Cost Modelglobal_admin
Tabular withActions
OS-LICENSE-X41OS Licenseglobal_admin
TabularOS-LICENSE-T41OS Licenseglobal_admin
Tabular withActions
NETWORK-SERVICES-AGENTS-X24Network Services Agentsglobal_admin
Tabular withActions
DISCOVERED-DEVICES-X24Discovered Devicesglobal_admin
Tabular withActions
ACTIVE-MODULES-X26Active Modulesglobal_admin
TabularACTIVE-MODULES-T26Active Modulesglobal_admin
Tabular withActions
MODULES-X26Modulesglobal_admin
TabularMODULES-T26Modulesglobal_admin
Tabular withActions
MODULE-SNAPSHOTS-X26Module Snapshotsglobal_admin
TabularMODULE-SNAPSHOTS-T26Module Snapshotsglobal_admin
TabularVMWAREVSWITCH TABLE-T9999vmwareVSwitchTableglobal_admin
Cisco UCS Director REST Developer Guide, Release 5.3 25
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularPORTGROUPS-T9999portGroupsglobal_admin
Tabular withActions
WORKFLOWS-X46Workflowsglobal_admin
Tabular withActions
USER-VM-ACTION-POLICY-X46User VM Action Policyglobal_admin
Tabular withActions
CONTEXT-WORKFLOW-MAPPING-X46
Context WorkflowMapping
global_admin
Tabular withActions
TEMPLATES-X46Templatesglobal_admin
Tabular withActions
WORKFLOW-SCHEDULES-X46Workflow Schedulesglobal_admin
Tabular withActions
CUSTOM-APPROVAL-TASKS-X46Custom Approval Tasksglobal_admin
Tabular withActions
LICENSE-X20Licenseglobal_admin
TabularTABULARLOV.SYSTEM.ADVANCED.PROPERTY.REPORT-T9999
tabularlov.system.advanced.property.reportglobal_admin
TabularCHANGE-RECORDS-T25Change Recordsglobal_admin
Tabular withActions
APPLICATION-CATEGORIES-X20Application Categoriesglobal_admin
Tabular withActions
SYSTEM-TASKS-X20System Tasksglobal_admin
TabularSYSTEM-TASKS-T20System Tasksglobal_admin
Tabular withActions
LDAP-INTEGRATION-X23LDAP Integrationglobal_admin
TabularLDAP-INTEGRATION-T23LDAP Integrationglobal_admin
Tabular withActions
VIRTUAL-CONSOLE-SERVERS-X24Virtual Console Serversglobal_admin
Tabular withActions
TRIGGERS-X46Triggersglobal_admin
Tabular withActions
VDC-X45vDCglobal_admin,group
Cisco UCS Director REST Developer Guide, Release 5.326
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
Tabular withActions
VDC-SERVICE-PROFILES-X45vDC Service Profilesglobal_admin,group
TabularCATALOG-T40Catalogglobal_admin,group
TabularVDCS-T14vDCsgroup
Tabular withActions
PORT-GROUPS-X14Port Groupsgroup
Tabular withActions
VFILERS-X15vFilersgroup
Tabular withActions
SERVERS-X15Serversgroup
Tabular withActions
SERVICE-PROFILES-X15Service Profilesgroup
Tabular withActions
SERVICE-REQUESTS-X10Service Requestsgroup
Tabular withActions
ARCHIVED-SERVICE-REQUESTS-X10
Archived Service Requestsgroup
Tabular withActions
USERS-X13Usersgroup
TabularVMS-T14VMsgroup
TabularRESOURCE-LIMITS-T13Resource Limitsgroup
SummarySUMMARY-V13Summarygroup
TabularTOP-5-FAILURE-REASONS-T10Top 5 Failure Reasonsgroup
TrendTREND-NETWORK-USAGE-H14Trend: Network Usagegroup
TrendTREND-CPU-USAGE-H14Trend: CPU Usagegroup
TrendTREND-DISK-USAGE-H14Trend: Disk Usagegroup
TrendTREND-CONSOLIDATED-RESOURCE-USAGE-H14
Trend: ConsolidatedResource Usage
group
Bar ChartVMS-ACTIVE-VS-INACTIVE-S13VMs Active vs Inactivegroup
Cisco UCS Director REST Developer Guide, Release 5.3 27
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
Tabular withActions
VLANS-X15VLANsgroup
TabularRESOURCE-ACCOUNTING-T12Resource Accountinggroup
TabularRESOURCE-ACCOUNTING-DETAILS-T12Resource AccountingDetails
group
TabularCHARGEBACK-T12Chargebackgroup
TabularRESOURCE-ACCOUNTING-DETAILS-T85
Resource AccountingDetails
group
TabularCHARGEBACK-T85Chargebackgroup
SummaryCURRENT-MONTH-SUMMARY-V12Current Month Summarygroup
SummaryPREVIOUS-MONTH-SUMMARY-V12Previous Month Summarygroup
Pie ChartCURRENT-MONTH-COST-SUMMARY-S12
Current Month CostSummary
group
Pie ChartPREVIOUS-MONTH-COST-SUMMARY-S12
Previous Month CostSummary
group
Pie ChartCURRENT-MONTH-TOP-5-APPLICATIONS-S12
Current Month Top 5Applications
group
Pie ChartPREVIOUS-MONTH-TOP-5-APPLICATIONS-S12
Previous Month Top 5Applications
group
TrendTREND-BUDGET-SPENDING-H12Trend: Budget Spendinggroup
TrendTREND-TOTAL-COST-H12Trend: Total Costgroup
TrendTREND-VM-COST-H12Trend: VM Costgroup
TrendTREND-CPU-COST-H12Trend: CPU Costgroup
TrendTREND-MEMORY-COST-H12Trend: Memory Costgroup
TrendTREND-NETWORK-COST-H12Trend: Network Costgroup
Tabular withActions
PAYMENT-INFORMATION-X10Payment Informationgroup
Tabular withActions
CUSTOMER-FUNDS-X10Customer Fundsgroup
Cisco UCS Director REST Developer Guide, Release 5.328
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
TabularRESOURCE-ACCOUNTING-DETAILS-T10
Resource AccountingDetails
group
SummarySUMMARY-V0Summaryhostnode
TabularVMS-T0VMshostnode
TabularEVENTS-T0Eventshostnode
TabularDELETED-VMS-T0Deleted VMshostnode
Tabular withActions
ILO-SERVERS-X50ILO Servershp, datacenter
TabularSERVER-NICS-T50Server NICshp_server
TabularSERVER-MEMORY-T50Server Memoryhp_server
TabularSERVER-PROCESSOR-T50Server Processorhp_server
TabularSERVER-SLOTS-T50Server Slotshp_server
TrendTREND-NUMBER-OF- HOST-NODES-H0
Trend: Number of HostNodes
HyperV cloud
TrendTREND-MEMORY-H0Trend: MemoryHyperV cloud
TrendTREND-CPU-H0Trend: CPUHyperV cloud
SummarySUMMARY-V0SummaryHyperV cloud
TabularCLUSTERS-T0ClustersHyperV cloud
TabularHOST-NODE-STATUS-T0Host Node StatusHyperV cloud
TabularHOST-NODE-INVENTORY-T0Host Node InventoryHyperV cloud
TabularVMS-T0VMsHyperV cloud
TabularDELETED-VMS-T0Deleted VMsHyperV cloud
TabularDATA-STORES-T0Data StoresHyperV cloud
TabularIMAGES-T9999ImagesHyperV cloud
Bar ChartMEMORY-S0MemoryHyperV cloud
Bar ChartCPU-S0CPUHyperV cloud
Cisco UCS Director REST Developer Guide, Release 5.3 29
ReportsList of Available Cisco UCS Director Reports
Report TypeReport IDReport NameContext
Bar ChartDISK-S0DiskHyperV cloud
SummarySUMMARY-V0SummaryHyperV cluster
TabularHOST-NODE-STATUS-T0Host Node StatusHyperV cluster
TabularHOST-NODE-INVENTORY-T0Host Node InventoryHyperV cluster
TabularVMS-T0VMsHyperV cluster
TabularEVENTS-T0EventsHyperV cluster
Bar ChartCPU-USAGE-S0CPU UsageHyperV hostnode
Bar ChartCPU-USAGE(MHZ)-S0CPU Usage(Mhz)HyperV hostnode
Bar ChartMEMORY-USAGE-S0Memory UsageHyperV hostnode
Using the List of Available ReportsIf you know the context of the report you want to get, you can use the report type information in the followingList of Available Cisco UCS Director Reports, on page 13to find the reportId to use in your request, andeven to determine which operation you should use, if you are unsure. In many cases, you can use the List ofAvailable Reports to construct an API request that fetches the report data you need.
Useful examples of reports, including VM and WorkFlowStatus reports, are provided elsewhere in the RESTAPI documentation. See: Reports and JSON Object Response Samples, on page 2.
If you require additional data for your API request, refer to the Report Metadata provided by Cisco UCSDirector. See Enabling the Developer Menu Options.
Note
Cisco UCS Director REST Developer Guide, Release 5.330
ReportsUsing the List of Available Reports