Management Interface web service client examples

Last Updated : Sep 19, 2014 |
Prolog information
Metadata
Keywords:
This section provides some examples of how to invoke the VPManagementClient.sh script in the Support/WebServices/VPManagementClient folder. The following section provides a list of the examples, with the purposes, commands, and a description of the variables used in the commands.

Purpose and Command

Enter the following command to:
  • Retrieve the application names for the default zone:
    ./VPManagementClient.sh <epm address> <username> <password> true getApplicationNames
  • Retrieve the application names for a specific zone:
    ./VPManagementClient.sh <epm address> <username> <password> true getApplicationNames <zone name>
  • Retrieve the application information for a specific application in the default zone:
    ./VPManagementClient.sh <epm address> <username> <password> true getApplicationInfo <appname>
  • Update the Launch Parameters of a VoiceXML application in the default zone:
    ./VPManagementClient.sh <epm address> <username> <password> true setApplicationInfo <appname> Name=DnisRanges[0].Range,,Type=String,,Value=’1022-1033’
  • Update the multiple parameters of an application in a specific zone:
    ./VPManagementClient.sh <epm address> <username> <password> true setApplicationInfo <appname> Name=Url,,Type=String,,Value=http://myappserver/myapp/Start\;\;Name=DnisRanges[0].Range,,Type=String,,Value=’1022-1033’\;\;Name=DnisRanges[1].Range,,Type=String,,Value=’1044-1055’ <zonename>
  • Retrieve the configurable application variables for a specific application in the default zone:
    ./VPManagementClient.sh <epm address> <username> <password> true getAppConfigurableVars <appname>
  • Update the configurable application variable of type String for a specific application in the default zone:
    ./VPManagementClient.sh <epm address> <username> <password> true setAppConfigurableVars <appname> Name=<cavname>,,Type=String,,Value=newValue
  • Upload a file that can be used for updating configurable application variable of type file:
    ./VPManagementClient.sh <epm address> <username> <password> true fileUpload AppVariable <filename with full path>
  • Update the configurable application variable of type file for a specific application in a specific zone:
    ./VPManagementClient.sh <epm address> <username> <password> true setAppConfigurableVars <appname> Name=<cavname>,,Type=File,,Value=<filename> <zonename>

Variables

  • <epm address>: The EPM host name or EPM IP address
  • <username>: The EPM user name
  • <password>: The password for the specified user name
  • <zone name>: The name of the zone of the application, or the name of the zone for which the application names are to be retrieved.
  • <appname>: The name of the application.
  • <cavname>: The name of the configurable application variable.
  • <filename with full path>: The filename with the fully qualified path.
  • <filename>: The name of the file uploaded to the system.