Inquire Service on Multiplatforms

The Inquire Service (MQCMD_INQUIRE_SERVICE) command inquires about the attributes of existing IBM MQ services.


Required parameters

    ServiceName (MQCFST)
    Service name (parameter identifier: MQCA_SERVICE_NAME).

    This parameter is the name of the service whose attributes are required. Generic service names are supported. A generic name is a character string followed by an asterisk (*), for example ABC*, and it selects all services having names that start with the selected character string. An asterisk on its own matches all possible names.

    The service name is always returned regardless of the attributes requested.

    The maximum length of the string is MQ_OBJECT_NAME_LENGTH.


Optional parameters

    IntegerFilterCommand (MQCFIF)
    Integer filter command descriptor. The parameter identifier must be any integer type parameter allowed in ServiceAttrs except MQIACF_ALL. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFIF - PCF integer filter parameter for information about using this filter condition.

    If you specify an integer filter, we cannot also specify a string filter using the StringFilterCommand parameter.

    ServiceAttrs (MQCFIL)
    Service attributes (parameter identifier: MQIACF_SERVICE_ATTRS). The attribute list might specify the following value on its own - default value if the parameter is not specified:

      MQIACF_ALL
      All attributes.

    or a combination of the following:

      MQCA_ALTERATION_DATE
      Date on which the definition was last altered.

      MQCA_ALTERATION_TIME
      Time at which the definition was last altered.

      MQCA_SERVICE_DESC
      Description of service definition.

      MQCA_SERVICE_NAME
      Name of service definition.

      MQCA_SERVICE_START_ARGS
      Arguments to be passed to the service program.

      MQCA_SERVICE_START_COMMAND
      Name of program to run to start the service.

      MQCA_SERVICE_STOP_ARGS
      Arguments to be passed to the stop program to stop the service.

      MQCA_STDERR_DESTINATION
      Destination of standard error for the process.

      MQCA_STDOUT_DESTINATION
      Destination of standard output for the process.

      MQCA_SERVICE_START_ARGS
      Arguments to be passed to the service program.

      MQIA_SERVICE_CONTROL
      When the queue manager must start the service.

      MQIA_SERVICE_TYPE
      Mode in which the service is to run.

    StringFilterCommand (MQCFSF)
    String filter command descriptor. The parameter identifier must be any string type parameter allowed in ServiceAttrs except MQCA_SERVICE_NAME. Use this parameter to restrict the output from the command by specifying a filter condition. See MQCFSF - PCF string filter parameter for information about using this filter condition.

    If you specify a string filter, we cannot also specify an integer filter using the IntegerFilterCommand parameter.

Parent topic: Definitions of the Programmable Command Formats