Administering with the HTTP command interface

With the HTTP command interface, you can run operations on your appliance, configure appliance settings, and administer data grids, collectives, and zones.

About this task

You can use the HTTP command interface to run operations with HTTP POST JSON statements. You can combine these statements into scripts to automate configuration and administration tasks.

Procedure

  1. View the available commands for the HTTP command interface in the user interface.

    To view a table of all the available commands in the user interface, click Help(Help) > HTTP Command Interface Help. After you click a command name, you can view the Detailed Usage and Example JSON Submission.

    To view a list of all of the commands in the information center, see HTTP command interface reference.
  2. Create a JSON statement for the operation that you want to run. This statement must contain:
    • The command that you want to run.
    • The appropriate parameters for the command.
    Use the following command in the cURL tool:
    curl -v -k -u XC_ADMIN_USER:XC_ADMIN_PWD -H "Content-Type: application/json" --data-binary 'HTTP_INTERFACE_JSON_STATEMENT' https://XC10_HOST_NAME/resources/appTaskInterface
    Define the following variables:
    XC_ADMIN_USER:XC_ADMIN_PWD
    Specifies the user name and password for the WebSphere® DataPower® XC10 Appliance administrator.
    HTTP_INTERFACE_JSON_STATEMENT
    Specifies one of the possible JSON statements that are submitted to the HTTP command interface. You can copy the Example JSON Submission statement from the HTTP Command Interface Help for the specific command that you want to run. The command must be wrapped in single quotation marks (').
    XC10_HOST_NAME
    Specifies the full host name or IP address of the WebSphere DataPower XC10 Appliance.
    For example, you might copy the example JSON submission for the ViewAllUsers command from the HTTP Command Interface Help. Then, you can run the following command:
    curl -v -k -u xcadmin:xcadmin -H "Content-Type: application/json" --data-binary '{"task":{"stopOnTaskFailure":"true","command":"ViewAllUsers"}}' 
    https://myXC10.mycompany.com/resources/appTaskInterface
  3. Run the command and view output.