mqccred.ini type

Use the mqccred.ini type to create configurations that contain user ID and password credentials that are needed to authenticate to one or more IBM® MQ queue managers.

Tip: The mqccred.ini type works with the mqccdt type, which is used to store channel definitions for the queue managers.

To connect to IBM MQ, you might also need other configuration types such as Policy project, Keystore, server.conf.yaml, and setdbparms.txt.

Summary of key details for the configuration type

File name or type Contains secrets Path extracted/imported to Maximum allowed per integration server or integration runtime
mqccred.ini Yes /home/aceuser/ace-server/mqccred.ini 1

About the mqccred.ini file

The mqccred.ini type requires an mqccred.ini file that the integration server or integration runtime can use when it starts. This file supplies user ID and password information, which a queue manager authenticates if connection authentication is configured.

The mqccred.ini file is made up of stanzas (or sections) that contain settings in the format key=value:

  • QueueManager: stanzas

    Requires a stanza for each queue manager, with details of the queue manager name, and a user ID and password to authenticate with.

  • AllQueueManagers: stanza

    Defines a global stanza that provides user ID and password details for authenticating to any unspecified queue managers.

Only one mqccred.ini file can be specified per integration server or integration runtime. The file is placed in the integration server or integration runtime work directory and an MQCCRED environment variable is automatically set to the /home/aceuser/ace-server/mqccred.ini path.

To provide queue manager credentials in an mqccred.ini file, complete the following steps:

  1. Create a text file named mqccred.ini. Or use the template .ini file that is provided in the same directory as the mqccred security exit, which is shipped with IBM MQ.
  2. To complete the file, add a stanza for each queue manager, and under each stanza, add a Name, User, and OPW key with corresponding values to define the queue manager name, a user ID, and a password. Optionally add a global stanza that defines a user ID and password for all queue managers. The individual queue manager definitions take precedence over the global setting.

    For more information about the mqccred.ini file, see Client side security exit to insert user ID and password ( mqccred ) in the IBM MQ documentation.

    The following example shows a global stanza and individual stanzas for two named queue managers. The Force=TRUE setting replaces any application-supplied user ID and password with those values from the mqccred.ini file.

    # Comment lines start with a number sign
    AllQueueManagers:
    User=userID
    OPW=password
    Force=TRUE
    
    QueueManager:
    Name=queueManagerName_1
    User=userID_1
    OPW=password_1
    Force=TRUE
    
    QueueManager:
    Name=queueManagerName_2
    User=userID_2
    password=password_2
    Force=TRUE

  3. Save and close the file.

For examples of how to use this configuration type, see Tutorials and examples.

Creating a configuration for the mqccred.ini type by using the configuration panel

You can create an mqccred.ini-type configuration while creating an integration server or integration runtime, or independently, as follows:

  1. Open the Configuration page by clicking the Configuration icon Configuration icon in the navigation pane, or go to the Configuration view of an integration server or integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select mqccred.ini from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that will help you identify the queue manager authentication credentials, or the integration server or integration runtime that will use these details.
    Create configuration panel
  5. Complete the mqccred.ini section by completing either of the following steps:
    • Copy the contents of an existing mqccred.ini file and then paste it into the mqccred.ini text editor.
      mqccred.ini text editor with pasted contents
    • Import a valid mqccred.ini file from your file system:
      1. Click the Import mqccred file icon Import icon.
      2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
        Import mqccred.ini view

        Click View file contents. The content of the mqccred.ini file is displayed.

        mqccred.ini text editor with imported contents
  6. Click Create. The configuration is added to the configurations table and can be selected for use with an integration server or integration runtime.

Updating or deleting a configuration

If you need to update the content or settings in a configuration, or delete a configuration that's no longer needed, see Managing configuration objects from the Configuration page.