Raritan CC-WSAPI-0B-v5.1.0-E - Manual

Chapter 1: Introduction 2 3. Download W SDL files from the CC-SG. You can use a web browser or a simple client like wget to access the WSDL URLs. See WSDL URLs (on page 4) 4. Choose a WS client library for your target language. 5. Use the tools provided with your chosen W S client library to generat...

Chapter 1: Introduction 4 Access Information WSDL URLs http://CC_IP_ADDRESS:8080/CommandCenterWebServices/AuthenticationAndAuthorizationServicePort?wsdl http://CC_IP_ADDRESS:8080/CommandCenterWebServices/NodeManagementServicePort?wsdl http(s)://CC_IP_ADDRESS:8080/CommandCenterWebServices/UserManagem...

6 In This Chapter Conventions ............................................................................................... 6 Common Data Types ................................................................................. 6 System Management .......................................................

Chapter 2: API Definitions 7 System Management This set of services is for general CC-SG settings and information. http(s)://CC_IP_ADDRESS:8080/CommandCenterWebServices/SystemManagementServicePort?wsdl Data Types SystemManagementException Exception returned for all errors specific to system manageme...

Chapter 2: API Definitions 8 Services getSystemInfo Retrieve information about the CC-SG.  parameters  String sessionID  return value  SystemInfo Authentication and Authorization Services This set of services is for logging into and out of CC-SG. http://CC_IP_ADDRESS:8080/CommandCenterWebService...

Chapter 2: API Definitions 9 signoff() This operations signs off (log out) a particular user from CC-SG. The application can have multiple users logged in.  String username - user name that is logging out via the W S-API client  String sessionID  return value void Unsupported Authentication and A...

Chapter 2: API Definitions 11  String deviceName i.e the name of the Raritan device. This field is filled in only for out-of-band interfaces; otherwise, it the empty string.  String name -  String id - Unique identifier referenced by AccessMethod  String description - User description of the int...

Chapter 2: API Definitions 12 URLObject Components to form a URL to access the CC-SG.  Elements  String protocol - the protocol used - either http or https  String port - the TCP port to be used for connecting to the interface: port 80 or port 443.  String path - the path to the actual webservic...

Chapter 2: API Definitions 13 Services getCCSGAppletURL This operation retrieves the full URL to the CC-SG Admin Client applet in order to launch the main CC-SG client. When this URL is opened in a browser it will display the main CC-SG client, if the sessionID is valid, or the login screen, if the ...

Chapter 2: API Definitions 14 getAccessMethodsForNode This operation retrieves all the available access methods (applications) for a given node in the form of an array. Each element in the array has an indicator to denote whether the passed in username has access to particular applications.  parame...

Chapter 2: API Definitions 15 getNodeByInterfaceName Retrieves nodes by the name of the interface.  parameters  String sessionID  String interfaceName - Interface name to find (accepts wildcards _ and %)  return value  NodeData[] getNodeByAssociation Find a node based on the category label appl...

Chapter 2: API Definitions 17 getNodePower Returns the power status of each interface of the node, including the status of the latest power operation. The user must have permission to access the node. In addition to the normal states, the availability state of each interface will be set to “Processi...

Chapter 2: API Definitions 18  power on  power off  power cycle  graceful shutdown  suspend  Integer sequenceInterval – The interval, in seconds, between successive operations of the specified power interfaces. Applicable to power on and power off only.  String reasonForAccess – Text used to ...

Chapter 2: API Definitions 19  Integer passwordExpirationPeriod – The user will have to reset their password after this many days (required if passwordExpirationEnabled is true). This value will always be clear if this feature is disabled.  boolean forcePasswordChange - When true, the user will ha...

Chapter 2: API Definitions 21  return value  boolean true deleteUserFromGroup Remove a user from a group to control their access of the CC-SG. Note: If this operation deletes all of a user's groups, then the user itself shall be deleted.  parameters  String sessionID  String userName - The name...

Chapter 2: API Definitions 23  String message – Specific error message. Services runReport Returns a log report formed using the request parameters. Reports created via the W S API will show up as scheduled reports with the name WS Report Task in the CC-SG Admin Client in the Administration > Ta...

Chapter 2: API Definitions 24  Access Audit  Access Connection  Authentication  Error  Power  Tasks  User Maintenance  String message – Restrict results to those containing this message. The only supported wildcard is the asterisk. Optional: may be null or empty.  Integer numberOfRecordsToG...

Chapter 2: API Definitions 25 deleteReport Delete a previously requested report; otherwise, reports are deleted after the user session is terminated.  parameters String sessionID  String reportID  return value  boolean true Category Management This set of services is for getting and setting cate...

Chapter 2: API Definitions 27 addElementToCategory Add one or more values to the specified category  parameters  String sessionID  String category - The unique name identifying the category  String[]elements - Each entry in this array is a value for the category.  return value  boolean true on...

28 This appendix contains some tips on managing certificates. See the respective company's documentation for more details. In This Chapter Java keytool ............................................................................................. 28 OpenSSL ..............................................

Appendix A: Certificate Management 29 For example: https://10.0.0.101:9443/CommandCenterWebServices/AuthenticationAndAuthorizationServicePort?wsdl 2. A Security Alert appears. Click View Certificate. 3. Click Details then Copy to File. 4. Use the Certificate Export Wizard to save the certificate to ...

30 This section focuses on CC-SG specific topics regarding W S client development in Java. In This Chapter Choose a WS Library .............................................................................. 30 Certificates information for Java users ......................................................

Appendix B: Web Services Development in Java 31 Setting the CCSG Address Downloading the WSDL files from port 8080 of the CC-SG is the default source of the WSDL files, however, their contents will reflect port 8080 of your CC-SG. Further, you might wish to use your WS client with a different CC-SG ...

Appendix B: Web Services Development in Java 32 Call the method from your application for each service object. This example uses AuthenticationAndAuthorizationService: CCSGAuthenticationAndAuthorizationService service = new CCSGAuthenticationAndAuthorizationService(); AuthenticationAndAuthorizationS...

Appendix B: Web Services Development in Java 34 import node.service.webservice.bl.cc.raritan.com.CCSGNodeManagementService; import node.service.webservice.bl.cc.raritan.com.types.*; // change server address import javax.xml.ws.Service; import javax.xml.ws.BindingProvider; import java.util.regex.Patt...

39 The following sections describe how to create a Web Services client for the CCSG written in C#. This description is based on Microsoft Visual Studio 2008 and IE6 running on W indows XP. Other methods of Web Service creation are available in Visual Studio 2008, but this document solely covers serv...

Appendix C: Web Services Development in C# 40 4. Set a call back for ServerCertificateValidationCallback so that the client will accept the CCSG's server certificate. A simple method is to trust the certificate if it matches the CCSG server certificate that you have explicitly saved from the CCSG. S...

Appendix C: Web Services Development in C# 41 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Security.Cryptography.X509Certificates; using System.Net; using System.Net.Security; using System.ServiceModel; namespace CCWSClient_WCF { class Program { ...

Appendix C: Web Services Development in C# 42 Console.WriteLine("signOff Response: " + response.result); } catch (Exception exception) { Console.WriteLine(exception.ToString()); } } Console.WriteLine("Press a key to exit."); Console.ReadKey(true); Environment.Exit(0); } static void M...

Appendix C: Web Services Development in C# 43 new CCAuthentication.AuthenticationAndAuthorizationServiceClient(); auth_service.ClientCredentials.ClientCertificate.SetCertificate( StoreLocation.CurrentUser, StoreName.My, X509FindType.FindBySubjectName, "10.0.0.150"); // service parameters CCA...

47 A Access Information • 4 AccessM ethod • 9 Add Web Services API Client Configuration on CC- SG • 1, 2, 29 addAssociationToNode • 16 addCategory • 26 addElementToCategory • 27 addUser • 20 addUserToGroup • 20 API Definitions • 6 AssociationData • 10 Authentication and Authorization Services • 8 Au...