Inquire Service (Response) on Multiplatforms
The response to the Inquire Service (MQCMD_INQUIRE_SERVICE) command consists of the response header followed by the ServiceName structure and the requested combination of attribute parameter structures.
If a generic service name was specified, one such message is generated for each service found.
- Always returned:
- ServiceName
- Returned if requested:
- AlterationDate, AlterationTime, Arguments, ServiceDesc, ServiceType, StartArguments, StartCommand, StartMode, StderrDestination, StdoutDestination, StopArguments, StopCommand
Response data
- AlterationDate (MQCFST)
- Alteration date (parameter identifier: MQCA_ALTERATION_DATE).
The date on which the information was last altered in the form yyyy-mm-dd.
- AlterationTime (MQCFST)
- Alteration time (parameter identifier: MQCA_ALTERATION_TIME).
The time at which the information was last altered in the form hh.mm.ss.
- ServiceDesc (MQCFST)
- Description of service definition (parameter identifier: MQCA_SERVICE_DESC).
The maximum length of the string is MQ_SERVICE_DESC_LENGTH.
- ServiceName (MQCFST)
- Name of service definition (parameter identifier: MQCA_SERVICE_ NAME).
The maximum length of the string is MQ_SERVICE_NAME_LENGTH.
- ServiceType (MQCFIN)
- The mode in which the service is to run (parameter identifier: MQIA_SERVICE_TYPE).
The value can be:
- MQSVC_TYPE_SERVER
- Only one instance of the service can be executed at a time, with the status of the service made available by the Inquire Service Status command.
- MQSVC_TYPE_COMMAND
- Multiple instances of the service can be started.
- StartArguments (MQCFST)
- The arguments to be passed to the user program at queue manager startup (parameter identifier:
MQCA_SERVICE_START_ARGS).
The maximum length of the string is MQ_SERVICE_ARGS_LENGTH.
- StartCommand (MQCFST)
- Service program name (parameter identifier: MQCA_SERVICE_START_COMMAND).
The name of the program which is to run.
The maximum length of the string is MQ_SERVICE_COMMAND_LENGTH.
- StartMode (MQCFIN)
- Service mode (parameter identifier: MQIA_SERVICE_CONTROL).
Specifies how the service is to be started and stopped. The value can be any of the following values:
- MQSVC_CONTROL_MANUAL
- The service is not to be started automatically or stopped automatically. It is to be controlled by user command.
- MQSVC_CONTROL_Q_MGR
- The service is to be started and stopped at the same time as the queue manager is started and stopped.
- MQSVC_CONTROL_Q_MGR_START
- The service is to be started at the same time as the queue manager is started, but is not requested to stop when the queue manager is stopped.
- StderrDestination (MQCFST)
- The path to a file to which the standard error (stderr) of the service program is to be
redirected (parameter identifier: MQCA_STDERR_DESTINATION).
The maximum length of the string is MQ_SERVICE_PATH_LENGTH.
- StdoutDestination (MQCFST)
- The path to a file to which the standard output (stdout) of the service program is to be
redirected (parameter identifier: MQCA_STDOUT_DESTINATION).
The maximum length of the string is MQ_SERVICE_PATH_LENGTH.
- StopArguments (MQCFST)
- The arguments to be passed to the stop program when instructed to stop the service (parameter
identifier: MQCA_SERVICE_STOP_ARGS).
The maximum length of the string is MQ_SERVICE_ARGS_LENGTH.
- StopCommand (MQCFST)
- Service program stop command (parameter identifier: MQCA_SERVICE_STOP_COMMAND).
This parameter is the name of the program that is to run when the service is requested to stop.
The maximum length of the string is MQ_SERVICE_COMMAND_LENGTH.
Parent topic: Definitions of the Programmable Command Formats