LDAP attributes

LDAP attributes defined are specific to IBM MQ and maps directly to the client connection properties.

    IBM MQ Client Channel Directory String Attributes
    The character string attributes with their mapping to IBM MQ properties are listed in the following table. The attributes can hold values of directoryString (UTF-8 encoded Unicode, that is, a variable byte encoding system that includes IA5/ASCII as a subset) syntax. The syntax is specified by its object identification number (OID).

LDAP Attribute Description IBM MQ Property
CN The common name consisting of the channel name and the defining queue manager name.  
ibm-amqChannelName The name of the channel definition. CHANNEL
ibm-amqConnectionName The communication connection identifier. CONNAME
ibm-amqDescription The channel description. DESCR
ibm-amqLocalAddress The local communication address of the channel. LOCLADDR
ibm-amqModeName The LU 6.2 mode name. MODENAME
ibm-amqPassword The password that can be used. PASSWORD
ibm-amqQueueManagerName The name of the queue manager or queue manager group to which an IBM MQ client application can request connection. QMNAME
ibm-amqSecurityExitUserData The user data that is passed to the security exit. SCYDATA
ibm-amqSecurityExitName The name of the exit program to be run by the channel security exit. SCYEXIT
ibm-amqSslCipherSpec A single CipherSpec for a TLS connection. SSLCIPH
ibm-amqSslPeerName Checks the Distinguished Name (DN) of the certificate from the peer queue manager or client at the other end of an IBM MQ channel. SSLPEER
ibm-amqTransactionProgramName The transaction program name. TPNAME
ibm-amqUserID The user ID to be used by the MCA when attempting to initiate a secure SNA session with a remote MCA. USERID

    IBM MQ client connection integer attributes
    The attributes with predefined values (for example, an enumerated type) are stored as standard integers. These values are stored in the LDAP directory as integer values, and not by using the associated constant name.

LDAP attribute Description IBM MQ Property
ibm-amqConnectionAffinity Determines whether client applications, which connect multiple times through the same queue manager name, use the same client channel. AFFINITY
ibm-amqClientChannelWeight A weighting to influence which client connection channel definition is used. CLNTWGHT
ibm-amqHeartBeatInterval The approximate time between heartbeat flows that are to be passed from a sending MCA when there are no messages on the transmission queue. HBINT
ibm-amqKeepAliveInterval A time-out value for a channel. KAINT
ibm-amqMaximumMessageLength The maximum length of a message that can be transmitted on the channel. MAXMSGL
ibm-amqSharingConversations The maximum number of conversations that share each TCP/IP channel instance. SHARECNV
ibm-amqTransportType The transport type to be used. TRPTYPE

    IBM MQ client channel boolean attribute
    This Boolean attribute is not mapped to any IBM MQ property. The syntax of this attribute indicates a boolean value.

LDAP attribute Description
ibm-amqIsClientDefault This boolean attribute is defined to resolve the problem of searching entries whose ibm-amqQueueManagerName attribute has not been defined.

    IBM MQ client channel list attributes
    IBM MQ properties are stored as single-value, comma-separated list attribute within the LDAP directory. The attributes are defined in the same manner as the other directory string attributes. The list attributes along with their mapping to the IBM MQ properties are described in the following table.

LDAP attribute Description IBM MQ Property
ibm-amqHeaderCompression A list of header data compression techniques supported by the channel. COMPHDR
ibm-amqMessageCompression A list of message data compression techniques supported by the channel. COMPMSG
ibm-amqSendExitUserData The user data that is passed to the send exit. SENDDATA
ibm-amqSendExitUserName The name of the exit program to be run by the channel send exit. SENDEXIT
ibm-amqReceiveExitUserData The user data that is passed to the receive exit. RCVDATA
ibm-amqReceiveExitName The name of the user exit program to be run by the channel receive user exit. RCVEXIT

  • Common Name
    The common name (CN) consists of the channel name and the defining queue manager name.
  • ibm-amqChannelName
    This attribute specifies the name of the channel definition.
  • ibm-amqDescription
    This LDAP attribute provides the channel description.
  • ibm-amqConnectionName
    This LDAP attribute is the communications connection identifier. It specifies the particular communications links to be used by this channel.
  • ibm-amqLocalAddress
    This attribute specifies the local communications address for the channel.
  • ibm-amqModeName
    This attribute is for use with LU 6.2 connections. It gives extra definition for the session characteristics of the connection when a communication session allocation is performed.
  • ibm-amqPassword
    This LDAP attribute specifies a password that can be used by the MCA when attempting to initiate a secure LU 6.2 session with a remote MCA.
  • ibm-amqQueueManagerName
    This attribute specifies the name of the queue manager or queue manager group to which an IBM MQ client application can request connection.
  • ibm-amqSecurityExitUserData
    This LDAP attribute specifies user data that is passed to the security exit.
  • ibm-amqSecurityExitName
    This LDAP attribute specifies the name of the exit program to be run by the channel security exit.
  • ibm-amqSslCipherSpec
    This LDAP attribute specifies a single CipherSpec for a TLS connection.
  • ibm-amqSslPeerName
    This LDAP attribute is used to check the Distinguished Name (DN) of the certificate from the peer queue manager or client at the other end of an IBM MQ channel.
  • ibm-amqTransactionProgramName
    This LDAP attribute specifies the transaction program name. It is for use with LU 6.2 connections.
  • ibm-amqUserID
    This LDAP attribute specifies the user ID to be used by the MCA when attempting to initiate a secure SNA session with a remote MCA.
  • ibm-amqConnectionAffinity
    This LDAP attribute specifies whether client applications, which connect multiple times using the same queue manager name, use the same client channel.
  • ibm-amqClientChannelWeight
    This LDAP attribute specifies a weighting that influences which client connection channel definition is used.
  • ibm-amqHeartBeatInterval
    This LDAP attribute specifies the approximate time between heartbeat flows that are to be passed from a sending MCA when there are no messages on the transmission queue.
  • ibm-amqKeepAliveInterval
    This LDAP attribute is used to specify a time-out value for a channel.
  • ibm-amqMaximumMessageLength
    This LDAP attribute specifies the maximum length of a message that can be transmitted on the channel.
  • ibm-amqSharingConversations
    This LDAP attribute specifies the maximum number of conversations that share each TCP/IP channel instance.
  • ibm-amqTransportType
    This LDAP attribute specifies the transport type to be used.
  • ibm-amqIsClientDefault
    This Boolean attribute solves the problem of searching entries where the ibm-amqQueueManagerName attribute has not been defined.
  • ibm-amqHeaderCompression
    This LDAP attribute is a list of header data compression techniques supported by the channel.
  • ibm-amqMessageCompression
    This LDAP attribute is a list of message data compression techniques supported by the channel.
  • ibm-amqSendExitUserData
    This LDAP attribute specifies user data that is passed to the send exit.
  • ibm-amqSendExitName
    This LDAP attribute specifies the name of the exit program to be run by the channel send exit.
  • ibm-amqReceiveExitUserData
    This LDAP attribute specifies user data that is passed to the receive exit.
  • ibm-amqReceiveExitName
    This LDAP attribute specifies the name of the user exit program to be run by the channel receive user exit.

Parent topic: Sample program for Connection Endpoint Lookup (CEPL)