Administrative API Reference

db2LdapUpdate

Updates the communication protocol information for the DB2 server 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: db2LdapUpdate */
/* ... */
SQL_API_RC SQL_API_FN
  db2LdapUpdate (
    sqlint32 versionNumber,
    void * pParamStruct,
    struct sqlca * pSqlca);
 
typedef struct
{
  char * piNodeName;
  char * piComment;
  unsigned short iNodeType;
  db2LdapProtocolInfo iProtocol;
  char * piBindDN;
  char * piPassword;
} db2LdapUpdateStruct;
 
typedef struct
{
  char iType;
  char * piHostName;
  char * piServiceName;
  char * piNetbiosName;
  char * piNetworkId;
  char * piPartnerLU;
  char * piTPName;
  char * piMode;
  unsigned short iSecurityType;
  char * piLanAdapterAddress;
  char * piChangePasswordLU;
  char * piIpxAddress;
} db2LdapProtocolInfo;
/* ... */
 

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 db2LdapUpdateStruct structure.

pSqlca

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

piNodeName

Input. Specify the node name that represents the DB2 server in LDAP.

piComment

Input. Specify a new description for the DB2 server. Maximum length is 30 characters. A carriage return or a line feed character is not permitted.

iNodeType

Input. Specify a new node type. Valid values are:

   SQLF_NT_SERVER
   SQLF_NT_MPP
   SQLF_NT_DCS
   SQL_PARM_UNCHANGE

iProtocol

Input. Specify the updated protocol information in the db2LdapProtocolInfo structure.

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.

iType

Input. Specify the protocol type that this server supports. Valid values are:

   SQL_PROTOCOL_APPN   - For APPC/APPN support
   SQL_PROTOCOL_NETB   - For NetBIOS support
   SQL_PROTOCOL_TCPIP  - For TCP/IP support
   SQL_PROTOCOL_SOCKS  - For TCP/IP with socket security
   SQL_PROTOCOL_IPXSPX - For IPX/SPX support
   SQL_PROTOCOL_NPIPE  - For Windows NT Named Pipe support

piHostName

Input. Specify a new TCP/IP host name or IP address.

piServiceName

Input. Specify a new TCP/IP service name or port number.

piNetbiosName

Input. Specify a new NetBIOS workstation name.

piNetworkID

Input. Specify a new network ID.

piPartnerLU

Input. Specify a new partner LU name for the DB2 server machine.

piTPName

Input. Specify a new transaction program name.

piMode

Input. Specify a new mode name.

iSecurityType

Input. Specify a new security level. Valid values are:

   SQL_CPIC_SECURITY_NONE
   SQL_CPIC_SECURITY_SAME
   SQL_CPIC_SECURITY_PROGRAM
   SQL_PARM_UNCHANGE

piLanAdapterAddress

Input. Specify a new network adapter address.

piChangePasswordLU

Input. Specify a new name of the partner LU to use when changing the password for the host database server.

piIpxAddress

Input. Specify a new IPX address.