IV07671: UA API CLIENT DP_SETSOURCENAME() DOES NOT WORK

IBM Tivoli Monitoring 6.2.2 Fix Pack 8 (6.2.2-TIV-ITM-FP0008)
IBM Tivoli Monitoring 6.2.2 Fix Pack 9 (6.2.2-TIV-ITM-FP0009)

APAR status

• Closed as program error.

Error description

• Customer uses next order of API Call to send monitoring data to
  Tivoli Monitoring by using Tivoli Universal Agent 6.2.1:
  dp_AllocateHandle(), dp_AllocateBuffer(), dp_SetSourceName(),
  dp_BeginInput(), pd_FormatBuffer(), pd_InputData.
  He receives Error no 13 (invalid sequence) after
  dp_SetSourceName()
  call.
  
  Investigation steps:
  - As mentioned in user's guide dp_SetSourceName must be invoked
  before dp_BeginInput. Customer has done that as it is seen in
  the Sdctivoli.cpp program
  
  - Attached UM log contains error:
  
  (4E44CA9A.0001-A8C:kumpscku.c,527,"KUMP_CheckExistUDPpartner")
  ***
  <SETSRC15 >
  API request rejected, sequence error 13, did not receive
  expected dp_BeginInput API
  (4E44CA9A.0002-A8C:kumpscku.c,553,"KUMP_CheckExistUDPpartner")
  ***
  dp_BeginInput processing failed. Status 13
  
  - tracing on the machine where the API client program is
  executing
  (dpapi.log)
  
  4E4A6BD0 >>>>> dp_SetSourceName exit. Status 13
  Debugging SDCheck.
  08/16/11 17:08:32 Error code: 13, Text: Error initialize Tivoli
  Monitoring Universal Agent, SetSourceName(), Status = 13
  08/16/11 17:08:32 System variable ETB_ID = ETB202
  08/16/11 17:08:32 System variable ETB_SDLOG = \\FS05209\NETAPPS\
  ADMIN\DATA\SDCHECK\DS07115
  08/16/11 17:08:32 System variable ETB_SDSYSLOG =
  \\FS05209\NETAPPS
  \ADMIN\DATA\SDCHECK\DS07115
  08/16/11 17:08:32 System variable ETB_TIMEOUT = 60
  08/16/11 17:08:32 System variable SYSLOG_SERVER =
  syslog.rv.rvnet
  08/16/11 17:08:32 System variable SYSLOG_PORT = 514
  08/16/11 17:08:32 EntireX Broker ACI server started
  Stopping SDCheck.
  08/16/11 17:08:41 EntireX Broker ACI server stopped
  I have reproduced the situation again, have collected data
  including DPAPI.LOG with pdcollect tool, it is available
  on ecurep.
  The universal agent log displays:
  
  API request rejected, sequence error 13, did not receive
  expected dp_BeginInput API
  dp_BeginInput processing failed. Status 13
  
  Freeing InData buffer @38C0630
  Exit: 0x0
  API sequence error from 191.2.7.115[1841]
  Socket select wait
  The dp_SetSourceName API depends on TCP communication and allows
  a client connection to be associated with a user-specified
  managed system name.  The dpapi.log displays the error:
  dp_SetSourceName exit. Status 13
  

Local fix

• N/A
  

Problem summary

• The Universal Agent's API Data Provider was not checking for the
  receipt of a SetSourceName request. Instead, the API Data
  Provider is checking for a BeginInput request. The data provider
  returns an 'out of sequence' error condition to API client
  program since it receives SetSourceName instead of BeginInput.
  

Problem conclusion

• The Universal Agent API data provider now checks for the receipt
  of SetSourceName and processes it accordingly, thereby
  preventing the 'out of sequence' error condition.
  
  
  The fix for this APAR is contained in the following maintenance
  packages:
  
     | fix pack | 6.2.2-TIV-ITM-FP0007
  
  
  *** VERY IMPORTANT ***
  
  (1) After the API client program issues dp_SetSourceName() API
      call, MUST use dp_BeginInputSource() API call
      instead of dp_BeginInput() API call, including SourceName
      argument value that was used in dp_SetSourceName().
  
      Here is the dp_BeginInputSource() signature (prototype) :
  
      int  dp_BeginInputSource(dp_handle_t InH, char *ApplName,
              char *AttrGroup, char *SourceName, int *Call_Status)
  
  
  (2) The SourceName value used in the dp_SetSourceName() and
      dp_BeginInputSource() calls MUST match a corresponding
      value declared in the Universal Agent metafile (MDL) per the
      'ManagedSystemName' clause - see above example metafile.
  
  *** END VERY IMPORTANT ***
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  UNIVERSAL AGENT

• Fixed component ID

  5724K1000

Applicable component levels

• R622 PSY

     UP