Universal Command Agent for SOA Command Options

Owned by Stonebranch (Deactivated)
Feb 06, 2023
2 min read

Overview

This page provides links to detailed information on the command options available for use with Universal Command Agent for SOA.

The options are listed alphabetically, without regard to any specific operating system.

Command Options Information

For each command option, these pages provide the following information.

Description

Describes the command option and how it is used.

Usage

Provides a table of the following information:

Method

Syntax

IBM i

HP NonStop

UNIX

Windows

z/OS

Command Line, Long Form

<Format / Value>






Method

Identifies the method used to specify Universal Command Agent for SOA command options:

  • Command Option, Long Form

Syntax

Identifies the syntax of the method used to specify the option:

  • Format: Specific characters that identify the option.
  • Value: Type of value(s) to be supplied for this method.

(Operating System)

Identifies the operating systems for which each method of specifying the option is valid:

  • IBM i
  • HP NonStop
  • UNIX
  • Windows
  • z/OS

Values

Identifies all possible values for the specified value type.

Defaults are identified in bold type.

<Additional Information>

Identifies any additional information specific to the option.

Command Options List

The following table identifies all Universal Command Agent for SOA command options.

Option

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_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_PROPERTIES_FILE

Name and location of an XML document containing the JMS properties to be included in the JMS message.

JMS_REPLY_TO

Name of the JMS reply queue for the return JMS message.

MEP

Message exchange pattern to be used for the current operation.

MQ_CHANNEL

Name of the MQ channel.

MQ_HOST

Name of the server running MQSeries.

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.

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.

PROTOCOL

Message protocol to be used for the current operation.

SERVICE_PASSWORD

Password to be passed to the target workload for authentication.

SERVICE_URL

URL (internet, network, or file-based) of the target workload.

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.

XD_CMD

Operation to submit to the WebSphere XD environment.

XD_CMD_ID

Used to correlate jobs.