ZZ00207: /ENABLEMENT/IMPLEMENTATIONSERVICES.HTML

IBM SmartCloud Orchestrator Fix Pack 1 (2.3.0.1) for 2.3

APAR status

• Closed as program error.

Error description

• There is an error in the info center documentation
  
  
  http://pic.dhe.ibm.com/infocenter/tivihelp/v48r1/topic/com.ibm.s
  co.doc_2.3/enablement/implementationservices.html
  
  The doc does not have the correct information for the
  Windows_UploadFile in Table 6, it has the information for
  Windows_ExecuteCommand and Windows_UploadFileAndExecuteCommand
  The Windows_ExecuteCommand is incorrectly presented under the
  Windows_UploadFile in Table 6, in other words the information
  in the
  doc for the Windows_UploadFile is really the information for the
  Windows_ExecuteCommand.
  
  Also if we are providing an example, please provide Windows
  like paths
  and names, so instead of "HelloWorld.sh" use "HelloWorld.bat",
  or
  "/tmp" use "C:\temp".
  
  This is what I was expecting to see for the Windows interfaces
  
  Windows_UploadFile
  remoteMachine String Remote machine IP address or host
  name "10.10.1.9"
  userName String Login user name for the above
  protocol "Administrator"
  password String Unencrypted Login
  password "SomePassword"
  fileName String Name of the file to be uploaded from
  the local file repository "HelloWorld.bat"
  destinationPath String Full destination path in the format of
  the remote machine "C:\target\dir"
  localRepositorySubDir String Subdirectory or NULL/Empty
  string "SubFolder"
  
  Windows_ExecuteCommand
  remoteMachine String Remote machine IP address or host name
  "10.10.1.9"
  userName String Login user name for the above protocol
  "root"
  password String Unencrypted Login password
  "SomePassword"
  commandLine String Command line or script file
  "Dir"
  cmdLineWorkingDirectory String Full path
  "C:\target\dir"
  
  Windows_UploadFileAndExecuteCommand
  remoteMachine String Remote machine IP address or host
  name "10.10.1.9"
  userName String Login user name for the above
  protocol "Administrator"
  password String Unencrypted Login
  password "SomePassword"
  fileName String Name of the file to be uploaded from
  the local file repository "HelloWorld.bat"
  destinationPath String Full destination path in the format of
  the remote machine "C:\target\dir"
  localRepositorySubDir String Subdirectory or NULL/Empty
  string "SubFolder"
  makeFileExecutable Boolean Ignored on Windows operating
  systems null
  commandLine String Command line or script
  file "Dir"
  cmdLineWorkingDirectory String Full
  path "C:\target\dir"
  
  
  
  
  Also, please correct the way the informaiton is presented for
  the
  ExtractOutputMap and GetRemoteMachineDataFromVirtualMachineKey
  
  The Table 8 for ExtractOutputMap has the following:
  
  retValues |OutputMapValues |ErrCode + errMsg + retCode + stdOut
            | |+ stdErr
  
  In the BPD scripts the plus sign means concatenation. It would
  be
  better and more clear to indicate that they are part of a
  Complex
  Structure Type name OutputMapValues and list each entry in a
  separate
  line as follows
  
  retValues |OutputMapValues |ErrCode
            | |errMsg
            | |retCode
            | |stdOut
            | |stdErr
  
  
  The same for Table 9 Instead of
  virtualServerKey |VirtualServerKey |virtualSystemID +
  virtualServerID
  
  Present the entry of the table as
  virtualServerKey |VirtualServerKey |virtualSystemID
                   | |virtualServerID
  
  and for Table 10, instead of
  RemoteMachineData |RemoteMachineCredentials |remoteMachine +
  remoteUser
  + remotePassword + privateKey + publicKey
  
  please use
  RemoteMachineData |RemoteMachineCredentials |remoteMachine
                    | |remoteUser
                    | |remotePassword
                    | |privateKey
                    | |publicKey
  
  
  Furthermore in this doc, the "Windows Excute Command" is also
  missing.
  

Local fix

Problem summary

• ****************************************************************
  
  * USERS AFFECTED: All users of SmartCloud Orchestrator 2.3 which
  are using Scripting Utilities Toolkit.
  ****************************************************************
  
  * PROBLEM DESCRIPTION:
  Scripting Utilities Toolkit documentation.
  Function description Windows_UploadFile and
  Windows_ExecuteCommand are in parts missing and wrong.
  ****************************************************************
  

Problem conclusion

• Here below you can see the documentation text that is going to
  be added to the infocenter:
  
  Windows_UploadFile
  This integration or implementation service uploads a file to a
  remote machine via RXA toolkit/protocol
  
  Input parameters  Data type  Expected value  Sample data
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  remoteMachine  String  Remote machine IP address or host name
  "9.120.xxx.xxx“
  userName  String  Login user name for the above protocol
  "Administrator“
  password  String  Login password  "**********“
  fileName  String  Name of the file to be uploaded from the local
  repository.  "HelloWorld.bat"
  destinationPath  String  Full destination path in the format of
  the remote machine  "c:\tmp\destination\"
  localRepositorySubDir  String  Subdirectory or null/empty
  string. See File upload restrictions.  "\SubFolder\"
  
  
  Windows_ExecuteCommand
  This integration or implementation service executes a command
  line on a remote machine via RXA toolkit/protocol.
  
  Input parameters  Data type  Expected value  Sample data
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  remoteMachine  String  Remote machine IP address or host name
  "9.120.xxx.xxx“
  userName  String  Login user name for the above protocol
  "Administrator“
  password  String  Login password  "**********“
  commandLine  String  Command line or script file that must be
  executed on the remote machine.  "dir“
  cmdLineWorkingDirectory  String  Full path in the format of the
  remote machine  "c:\tmp\destination\“
  

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

  SMRTCLOUD ORCHS

• Fixed component ID

  5725H2800

Applicable component levels

• R230 PSY

     UP