Important

   

This space contains documentation for TrueSight Server Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Server Automation 8.9.

Performing operations with SOAP Web Services

The .wsdl files provided by TrueSight Server Automation - SOAP Web Services are located on the Application Server. You can get them by using the following URL syntax:

https://hostname_of_Application_Server:9843/services/BSAservice_name.wsdl?=

For example, to get the .wsdl files provided by TrueSight Server Automation - SOAP Web Services from an Application Server with a hostname of myAppServer, you would use the following URLs:

https://myAppServer:9843/services/BSAAssumeRoleService.wsdl?=
https://myAppServer:9843/services/BSACLITunnelService.wsdl?=
https://myAppServer:9843/services/BSALoginService.wsdl?=
https://myAppServer:9843/services/BSARESTRequestService.wsdl?=

Note

When you include the ?= string within the URL, the name of the web service includes the BSA prefix (and matches the name of the corresponding .wsdl file). In a URL that does not contain the ?= string, do not include the BSA prefix.

The general procedure for using BLCLI commands via web services is to log on to the TrueSight Server Automation Application Server, assume a role, and then run commands. Keep in mind that all the elements in a BLCLI command are case sensitive.

The following table describes the classes and operations that are available for use with the TrueSight Server Automation - SOAP Web Services:

Note

Do not use double quotes to enclose the input of any of these operations. Input strings for web services are treated literally, and do not require double quotes.

Webservice NameOperationDescription

LoginService

(https://localhost:9843/services/LoginService?wsdl)

loginUsingUserCredential()

Enables you to log on using user credentials. The session ID is returned. Use this session ID in all subsequent calls to identify the session.

Input headers:

  • transactionId (optional)

Input body:

  • username
  • password
    Note: To use < and & as special characters in the password, you must use &lt; and &amp; respectively for these characters in request.
  • authenticationType (values supported are: SRP, LDAP, ADK_PASSWORD, and SECURID)
loginUsingSessionCredential()Enables you to log on using a previously acquired session credential.

AssumeRoleService

(https://localhost:9843/services/AssumeRoleService?wsdl)

assumeRole()

Enables you to assume a role after logging on.

Input headers:

  • sessionId
  • transactionId (optional)

Input body:

  • roleName

CLITunnelService

(https://localhost:9843/services/CLITunnelService?wsdl)

executeCommandByParamList()

Enables you to execute a CLI command with arguments. Based on CLI syntax, you can choose one of the operations from CLITunnelService.

Input headers:

  • sessionId
  • transactionId (optional)

Input body:

  • namespace
  • commandName
  • commandArguments(list of arguments)
executeCommandByParamString()

Enables you to execute a CLI command without arguments.

Input headers:

  • sessionId
  • transactionId (optional)

Input body:

  • namespace
  • commandName
executeCommandByParamListAndAttachment()Enables you to execute a CLI command with arguments and attachments. Input parameters are the same as for the executeCommandByParamList operation, and you can also pass attachments as arguments. The attachment is expected to be a base64 encoded string passed in the SOAP envelope.
executeCommandUsingAttachments()Enables you to execute a CLI command with arguments and attachments. The attachment is expected to be a base64 encoded string passed in the SOAP envelope.

RESTRequestService

(https://localhost:9843/services/RESTRequestService?wsdl)

getXMLReturns the ouput as xml for the provided REST uri and query parameters.
getJSONReturns ouput as JSON for the provided REST uri and query parameters.
postXMLPerforms a post call for the given rest uri and xml content.
postJSONPerforms a post call for the given rest uri and JSON content.

Related topics

BLCLI reference

Was this page helpful? Yes No Submitting... Thank you

Comments