Change, Copy, and Create Service on Multiplatforms

The Change Service command changes existing service definitions. The Copy and Create service commands create new service definitions - the Copy command uses attribute values of an existing service definition.

The Change Service (MQCMD_CHANGE_SERVICE) command changes the specified attributes of an existing IBM MQ service definition. For any optional parameters that are omitted, the value does not change.

The Copy Service (MQCMD_COPY_SERVICE) command creates an IBM MQ service definition, using, for attributes not specified in the command, the attribute values of an existing service definition.

The Create Service (MQCMD_CREATE_SERVICE) command creates an IBM MQ service definition. Any attributes that are not defined explicitly are set to the default values on the destination queue manager.


Required parameter (Change and Create Service)

    ServiceName (MQCFST)
    The name of the service definition to be changed or created (parameter identifier: MQCA_SERVICE_NAME).

    The maximum length of the string is MQ_OBJECT_NAME_LENGTH.


Required parameters (Copy Service)

    FromServiceName (MQCFST)
    The name of the service definition to be copied from (parameter identifier: MQCACF_FROM_SERVICE_NAME).

    This parameter specifies the name of the existing service definition that contains values for the attributes not specified in this command.

    The maximum length of the string is MQ_OBJECT_NAME_LENGTH.

    ToServiceName (MQCFST)
    To service name (parameter identifier: MQCACF_TO_SERVICE_NAME).

    This parameter specifies the name of the new service definition. If a service definition with this name exists, Replace must be specified as MQRP_YES.

    The maximum length of the string is MQ_OBJECT_NAME_LENGTH.


Optional parameters (Change, Copy, and Create Service)

    Replace (MQCFIN)
    Replace attributes (parameter identifier: MQIACF_REPLACE). If a namelist definition with the same name as ToServiceName exists, this specifies parameter whether it is to be replaced. The value can be:

      MQRP_YES
      Replace existing definition.

      MQRP_NO
      Do not replace existing definition.

    ServiceDesc (MQCFST)
    Description of service definition (parameter identifier: MQCA_SERVICE_DESC).

    This parameter is a plain-text comment that provides descriptive information about the service definition. It must contain only displayable characters.

    If characters are used that are not in the coded character set identifier (CCSID) for the queue manager on which the command is executing, they might be translated incorrectly.

    The maximum length of the string is MQ_SERVICE_DESC_LENGTH.

    ServiceType (MQCFIN)
    The mode in which the service is to run (parameter identifier: MQIA_SERVICE_TYPE). Specify either:

      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)
    Arguments to be passed to the program on startup (parameter identifier: MQCA_SERVICE_START_ARGS).

    Specify each argument within the string as you would on a command line, with a space to separate each argument to the program.

    The maximum length of the string is MQ_SERVICE_ARGS_LENGTH.

    StartCommand (MQCFST)
    Service program name (parameter identifier: MQCA_SERVICE_START_COMMAND).

    Specifies the name of the program which is to run. We must specify a fully qualified path name to the executable program.

    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. This value is the default value.

      MQSVC_CONTROL_Q_MGR
      The service being defined 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)
    Specifies the path to a file to which the standard error (stderr) of the service program must be redirected (parameter identifier: MQCA_STDERR_DESTINATION).

    If the file does not exist when the service program is started, the file is created.

    The maximum length of the string is MQ_SERVICE_PATH_LENGTH.

    StdoutDestination (MQCFST)
    Specifies the path to a file to which the standard output (stdout) of the service program must be redirected (parameter identifier: MQCA_STDOUT_DESTINATION).

    If the file does not exist when the service program is started, the file is created.

    The maximum length of the string is MQ_SERVICE_PATH_LENGTH.

    StopArguments (MQCFST)
    Specifies the arguments to be passed to the stop program when instructed to stop the service (parameter identifier: MQCA_SERVICE_STOP_ARGS).

    Specify each argument within the string as you would on a command line, with a space to separate each argument to the program.

    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. We must specify a fully qualified path name to the executable program.

    The maximum length of the string is MQ_SERVICE_COMMAND_LENGTH.

Parent topic: Definitions of the Programmable Command Formats