Universal Command Agent for SOA - Script File Command Options

Command Options Categories

Universal Command Agent for SOA uses a script file interface to accept the values needed to create the workload execution request.

The following table categorizes the command options into logical areas of application. Each Category name is a link to a table of options in that category. Each Option Name in those tables is a link to detailed information about that option.

Category	Description
Required Options	Required for Universal Command Agent for SOA to process the workload execution request.
Dependent Options	Required, depending on the PROTOCOL option value; otherwise, these options are invalid.
Optional Options	Optional usage only; use only as appropriate.

Required Options

Option Name	Description
MEP	Message exchange pattern to be used for the current operation.
PROTOCOL	Message protocol to be used for the current operation.
SERVICE_URL	URL (internet, network, or file-based) of the target workload.

Dependent Options

Option Name	Description
JMS_CONNECTION_FACTORY_NAME	Connection factory to be used to establish a connection to a JMS provider.
JMS_CONTEXT_FACTORY_NAME	Java class name of the JMS providers initial context factory.
JMS_DESTINATION	Name of the target JMS destination queue or topic for the JMS message.
JMS_REPLY_TO	Name of the JMS reply queue for the return JMS message.
MQ_CHANNEL	Name of the MQ channel.
MQ_HOST	Name of the server running MQSeries.
MQ_QUEUE_MANAGER_NAME	Name of the MQ QUEUE Manager.
MQ_QUEUE_NAME	Name of the MQ Queue to use.
MQ_REPLY_TO	Name of the MQ Queue from which to read the reply when MEP is set to request.
XD_CMD	Operation to submit to the WebSphere XD environment.
XD_CMD_ID	Correlates jobs.

Optional Options

Option Name	Description
HELP	Lists the command options and values.
HTTP_AUTH	http authorization scheme to use.
HTTP_FORM_DATA	Specification for whether or not there is HTTP form data, in a name-value format, in the payload file.
HTTP_METHOD	Type of HTTP operation to execute.
HTTP_VERSION	Version of the HTTP protocol to use.
JMS_PROPERTIES_FILE	Name and location of an XML document containing the JMS properties to be included in the JMS message.
MQ_PORT	Name of the port on which the MQ Broker is listening.
MQ_PROPERTIES_FILE	Name of the file containing the MQ name / value pairs.
SERVICE_PASSWORD	Password to be passed to the target workload for authentication.
SERVICE_USER_NAME	User name to be passed to the target workload for authentication.
SOAP_ACTION	soapAction HTTP header value.
SOAP_VERSION	Version of the SOAP protocol to use when making the SOAP request.
TIMEOUT_SEC	Length of time to wait for the request to complete.

Command Options Syntax

The following figure illustrates the syntax of Universal Command Agent for SOA command options.

-protocol {HTTP|SOAP|JMS|XDSOAP|MQ}
-mep {Publish|Request}
-serviceurl url
-jmsconnectionfactoryname name
-jmscontextfactoryname name
-jmsdestination name
-jmsreplyto name
-mqchannel channel | CCDT
-mqhost server
-mqqueuemanagername manager
-mqqueuename queue
-mqreplyto queue
-xdcmd {SUBMIT|RESTART}
-xdcmdid ID *
[-httpauth {BASIC|DIGEST|NTLM}]
[-httpformdata {true|false}]
[-httpmethod {GET|POST}]
[-httpversion {OneDotZero|OneDotOne}]
[-jmspropertiesfile file]
[-mqport port]
[-mqpropertiesfile file]
[-serviceusername name]
[-servicepassword password]
[-soapaction header]
[-soapversion {OneDotOne|OneDotTwo}]
[-timeoutsec time]

-help

* The -xdcmdid option is required if -protocol is set to XDSOAP.