Tools for Troubleshooting

Transcription

1 This chapter contains the following sections: Tools Reference, page 1 Support Information, page 2 Viewing Log Details for a Service Request, page 5 Using the Database Audit Log, page 6 Viewing the Workflow Input and Output Status of a Service Request, page 6 Cisco UCS Director Shell, page 6 Testing Cisco UCS Director REST APIs, page 7 JavaScript Lint, page 8 Understanding the Cloupia Script Interpreter, page 8 Administrative Account On Target Devices, page 9 Testing Connectivity, page 9 Tools Reference Cisco UCS Director provides a number of tools that can help you diagnose and resolve common problems. The following table describes these tools and the type of problems that they are designed to resolve. Tool Use See Support information Viewing product support information. Support Information, on page 2 System information Viewing basic and advanced system Viewing System Information, information, including the license status, on page 3 database tables version, resource usage, logs, and debugging processes for troubleshooting. 1

2 Support Information Tool Service Request logs Service Request Inputs/Outputs tab Cisco UCS Director Shell Browser-based REST Client for testing Cisco UCS Director APIs Javascript Lint Launch Interpreter Test Connection action Unique administrative account on target devices. Use Viewing log details for a service request. Troubleshooting problems related to service request workflow execution. Troubleshooting problems related to various administrative tasks such as connectivity, configuration and status. Developing and testing Cisco UCS Director REST APIs. Checking the JavaScript source code from your scripts that are used in Cisco UCS Director. Executing JavaScript functions and defining variables and functions, when using scripts written in CloupiaScript. You can test connectivity for managed network elements, virtual accounts, and physical accounts. By creating a unique administrative account on target devices, you can access logging information to troubleshoot problems. See Viewing Log Details for a Service Request, on page 5 Viewing the Workflow Input and Output Status of a Service Request, on page 6 Cisco UCS Director Shell, on page 6 Testing Cisco UCS Director REST APIs, on page 7 JavaScript Lint, on page 8 Understanding the Cloupia Script Interpreter, on page 8 Testing Connectivity, on page 9 Administrative Account On Target Devices, on page 9 Support Information Cisco UCS Director support provides basic and advanced system information, including the license status, database tables, version, resource usage, logs, and debugging processes for troubleshooting. The Support Information page lets you perform the following actions: View system information (Basic) View system information (Advanced) Show logs Download all logs Start and stop debug logging Start and stop API logging 2

3 Viewing System Information Viewing System Information Cisco UCS Director allows you to access system information from the user interface. You can access the following types of system information: Basic system information Advanced system information Basic system information includes the following: Software version Uptime Service status System license status System usage Compute accounts status Compute server status Storage account status System catalogs Network device status and Cloud status The advanced system information includes the following: Basic system information Database tables summary Product configuration Top process information Information on processors, memory, disks, log files, network, and login System task status Cloud inventory Monitoring status Choose Administration > Support Information. From the System Information drop-down list, choose the type of system information you want to view. Click Submit. The System Information page opens in a new tab and displays information about the Cisco UCS Director appliance. 3

4 Showing Logs Showing Logs Cisco UCS Director collates the following logs in the system: Infra Manager Web Context Cloud Manger Tomcat Log Authenticator Log Mail Delivery Log Patch Log Choose Administration > Support Information. From the System Information drop-down list, choose Show Log. From the Show Log drop-down list, choose the log file that you want to view. Click Show Logs. The log file opens in a new tab or browser window and displays any available information, warning, and error logs. Downloading Logs You can download all the log files as a zipped file. Choose Administration > Support Information. From the System Information drop-down list, choose Download All Logs. Click Download. 4

5 Starting the Debug Log Starting the Debug Log Debug logging enables you to record a maximum of 30 minutes debug logging to a log file. Step 5 Choose Administration > Support Information. From the System Information drop-down list, choose Debug Logging. Click Start Debug Logging. Click Stop Debug Logging to stop the recording. The recording will automatically stop once it reaches the 30 minute limit. Click Download Debug Logs from HH.MM.SS (time) to download the zipped log file. Generating API Logs Step 5 Step 6 Choose Administration > Support Information. From the System Information drop-down list, choose API Logging. Click Start API Logging. Perform any tests that you want to run. Click Stop API Logging to stop the recording. Click Download API Debug Logs from HH.MM.SS (time) to download the zipped file. A compressed (zip) file is generated and downloaded on to your desktop. This zipped file contains a text file that lists all the REST APIs that invoked on the appliance, along with the timestamp. Viewing Log Details for a Service Request Step 5 Choose Organizations > Service Requests. Choose a user group. The default is All User Groups, which lists all service requests. On the Service Requests page, click Service Requests. Click the row with the service request for which you want to view the log details. Click View Details, and expand Log. 5

6 Using the Database Audit Log Using the Database Audit Log Database audit logging lets you log information on remote users connecting to the Cisco UCS Director database server. The log file contains information on when remote users connect to and disconnect from the server, and logs the actions performed. By default, database audit logging is disabled. You can disable database audit logging if there are performance issues due to excessive audit log traffic. For more information on configuring the database audit log, see the Cisco UCS Director Administration Guide. Edit the /etc/my.cnf file using vi. Update the value of the audit_log parameter to ON or OFF to enable or disable the database audit log. Do one of the following for the changes to take effect: Restart the Cisco UCS Director database using the databaseinfra.sh stop and databaseinfra.sh start commands. The databaseinfra.sh file is located in the /opt/infra folder. Restart the Cisco UCS Director appliance. After enabling audit logging, if the following error message appears, remove or rename the log file and restart the Cisco UCS Director database server: ERROR : Plugin 'audit_log' init function returned error Viewing the Workflow Input and Output Status of a Service Request Choose Organizations > Service Requests. On the Service Requests page, click Service Requests. Click the row with the service request for which you want to view the input and output status. Click View Details, and expand Input/Output. Cisco UCS Director Shell Use the information in the following table to solve problems using Cisco UCS Director Shell. 6

7 Testing Cisco UCS Director REST APIs Problem Area Connectivity with Cisco UCS Director Services Solution Troubleshooting Cisco UCS Director Connectivity Troubleshooting Connectivity with Cisco UCS Director and PowerShell Agent Log into the Cisco UCS Director Shell and choose one of the following options from the Shell menu: Display Service Status Stop Services Start Services Databases Log into the Cisco UCS Director Shell and choose one of the following options from the Shell menu: Stop Database Start Database Backup Database Restore Database Time Synchronization Nodes Log into the Cisco UCS Director Shell and choose Time Sync from the Shell menu. Log into the Cisco UCS Director and choose Collect logs from a Node from the Shell menu. Testing Cisco UCS Director REST APIs You can use a browser based REST client for developing and testing Cisco UCS Director. Refer to the table below for available REST clients. Browser Mozilla Firefox See restclient/ Google Chrome 7

8 JavaScript Lint JavaScript Lint There can be several scenarios in Cisco UCS Director where you use JavaScript for scripts. Use the JavaScript Lint tool available at to help you check your source code for any common mistakes. Understanding the Cloupia Script Interpreter The Cloupia Script interpreter is a JavaScript interpreter populated with built-in libraries and APIs. You can use the Cloupia Script interpreter to execute functions and to define variables and functions. The Cloupia Script interpreter offers the following functions: PrintObj Takes in an object and prints out all the properties and methods in the object. The print result provides the values for variables in the object and functions that are available to be executed with the object. When you call tostring() on a JavaScript function, for example, myfunction.tostring(), the method signature of that function is returned. This example shows how to display the properties and methods of the ReportContext object and how to return the source code of the setcloudname function. session started > importpackage(com.cloupia.model.cim); > var ctx = new ReportContext(); > printobj(ctx); properties = cloudname:null class:class com.cloupia.model.cim.reportcontext filterid:null id:null targetcuicid:null type:0 ids:[ljava.lang.string;@4de27bc5 methods = setids jdoreplacefield jdoreplacefields tostring getcloudname wait getclass jdoreplaceflags hashcode jdonewinstance jdoreplacestatemanager jdoisdetached notify jdogetversion jdoprovidefield jdocopyfields jdogetobjectid jdogetpersistencemanager jdocopykeyfieldstoobjectid jdogettransactionalobjectid gettype getfilterid settype jdoispersistent equals setcloudname jdonewobjectidinstance jdoisdeleted 8

9 Administrative Account On Target Devices gettargetcuicid setid setfilterid jdoprovidefields jdomakedirty jdoisnew requirescloudname getids notifyall jdoistransactional getid jdoreplacedetachedstate jdoisdirty settargetcuicid jdocopykeyfieldsfromobjectid > var func = ctx.setcloudname; > func void setcloudname(java.lang.string) > func.tostring(); function setcloudname() {/* void setcloudname(java.lang.string) */} Upload Uploads a JavaScript file to load into the interpreter. You can save the code as a separate file and upload the file using the upload command. Administrative Account On Target Devices Testing Connectivity To aid in troubleshooting problems, we recommend that you create an administrative account on all target devices in your environment. This administrative account should be unique and must have the highest administrative privileges on the devices. Creating this administative account has the following benefits: Isolating the problem while troubleshooting problems in an environment where Cisco UCS Director is integrated with other products. With this account created, the support personnel, should it come to that, can access log files created by this administrator account to determine the root cause of the problem. Continuity in situations of personnel change or change in login credentials. Typically, administrators who configure the system initially use their own login credentials to configure or log in to target devices. In the event that these login credentials are modified later on, or the administrators are no longer available in your company, accessing information on the target devices for troubleshooting could pose a problem. This situation can be avoided by creating this unique administrator account. You can test connectivity for managed network elements, virtual accounts, and physical accounts. 9

10 Testing Connectivity of Managed Network Elements Testing Connectivity of Managed Network Elements Choose Administration > Physical Accounts. On the Physical Accounts page, click Managed Network Elements. Click the row with the pod for which you want to test connectivity. Click Test Connection. Testing the Connection to a Virtual Account You can test the connection at any time after you add a virtual account. Step 5 Choose Administration > Virtual Accounts. On the Virtual Accounts page, click Virtual Accounts. Click the row with the account for which you want to test the connection. Click Test Connection. When the connection test has completed, click Close. What to Do Next If the connection fails, verify the configuration of the virtual account, including the cloud location. If those are correct, determine whether there is a network connectivity problem. Testing the Connection to a Physical Account You can test the connection at any time after you add an account to a pod. Step 5 Choose Administration > Physical Accounts. On the Physical Accounts page, click Multi-Domain Managers. On the Multi-Domain Managers screen, click the row of the account for which you want to test the connection. Click Test Connection. When the connection test has completed, click Close. 10

11 Testing the Connection to a Physical Account What to Do Next If the connection fails, verify the configuration of the account, including the username and password. If the username and password are correct, determine whether there is a network connectivity problem. 11

12 Testing the Connection to a Physical Account 12