Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation  Back up to About Overview 
  
[+] Expand All
[-] Collapse All

Enabling the SOAP Interface for an SRC VTA Group (SRC CLI)

To use the SOAP interface, you need to enable it for the SRC VTA group. You can also specify whether basic HTTP authentication is required when using the SOAP interface. By default, authentication is required. If you disable authentication, the CLI editing level must be set to expert.

Note: If you enable authentication, you must configure each user within the shared application server and set the user account role to VTA-group name.

After you install the SRC VTA, you can access a Web Services Definition Language (WSDL) file for the application. The WSDL file defines the SOAP properties that you or your customers can use to develop a client. The URL for the SRC VTA WSDL file is:

http://<host-name>:8080:/<vta-group>/api/soap/services/vtaAPI?wsdl

  • <host-name>—Name of the C Series Controller that is running the SRC VTA
  • <vta-group>—Name of the SRC VTA group

Use the following configuration statements to enable the SOAP interface to configure user accounts at the [edit] hierarchy level:

shared vta group name api {enable-soap-api;disable-client-authentication}
  1. From configuration mode, access the configuration statement that enables the SOAP interface. For example, to enable the SOAP interface for the SRC VTA group called Quota:
    user@host# edit shared vta group Quota api
  2. Enable the SOAP interface.
    [edit shared vta group Quota api]user@host# set enable-soap-api
  3. To disable client authentication when using the SOAP interface:
    [edit shared vta group Quota api]user@host# set disable-client-authentication

Related Documentation

Modified: 2017-08-03