Administrative API Reference

db2LdapCatalogDatabase

Catalogs a database entry in LDAP (Lightweight Directory Access Protocol).

This API is available on Windows NT, Windows 98, Windows 95, and Windows 2000 only.

Authorization

None

Required Connection

None

Version

db2ApiDf.h

C API Syntax



/* File: db2ApiDf.h */
/* API: db2LdapCatalogDatabase */
/* ... */
SQL_API_RC SQL_API_FN
  db2LdapCatalogDatabase(
    sqlint32 versionNumber,
    void * pParamStruct,
    struct sqlca * pSqlca);
 
typedef struct
{
 char * piAlias;
 char * piDatabaseName;
 char * piComment
 char * piNodeName;
 char * piGWNodeName;
 char * piParameters;
 char * piARLibrary;
 unsigned short iAuthentication;
 char * piDCEPrincipalName;
 char * piBindDN;
 char * piPassword;
} db2LdapCatalogDatabaseStruct;
/* ... */
 

API Parameters

versionNumber
Input. Specifies the version and release level of the structure passed in as the second parameter, pParamStruct.

pParamStruct
Input. A pointer to the db2LdapCatalogDatabaseStruct structure.

pSqlca
Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

piAlias
Input. Specify an alias to be used as an alternate name for the database being cataloged. If an alias is not specified, the database manager uses the database name as the alias name.

piDatabaseName
Input. Specify the name of the database to catalog. This parameter is mandatory.

piComment
Input. Describes the DB2 server. Any comment that helps to describe the server registered in the network directory can be entered. Maximum length is 30 characters. A carriage return or a line feed character is not permitted.

piNodeName
Input. Specify the node name of the database server on which the database resides. This parameter is required if the database resides on a remote database server.

piGWNodename
Input. Specify the node name of the DB2 Connect gateway server. If the database server node type is DCS (reserved for host database servers), and the client does not have DB2 Connect installed, the client will connect to the DB2 Connect gateway server.

piParameters
Input. Specify a parameter string that is to be passed to the application requestor (AR). For an explanation of what format DB2 Connect expects for this string, see the DB2 Connect User's Guide. Authentication DCE is not supported.

piARLibrary
Input. Specify the name of the application requester (AR) library. For more information, see the DB2 Connect User's Guide.

iAuthentication
Input. Specifying an authentication type can result in a performance benefit. For more information about authentication types, see the Administration Guide.

piDCEPrincipalName
Input. Specify the fully qualified DCE principal name for the target server.

piBindDN
Input. Specify the user's LDAP distinguished name (DN). The LDAP user DN must have sufficient authority to create and update the object in the LDAP directory. If the user's LDAP DN is not specified, the credentials of the current logon user will be used.

piPassword
Input. Account password.

Usage Notes

A database may need to be manually registered or cataloged in LDAP if:


[ Top of Page | Previous Page | Next Page ]