Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Data-Type : SOSOptionBoolean
The default value for this parameter is  {*}false{*}.
Use together with parameter:  
* [use_credential_Store|#use_credential_Store] - use credential store for authentication

Alias: CS_ProcessNotesParams


h4. Parameter <span ih1. "CredentialStore_OverwriteExportedFile">CredentialStore_OverwriteExportedFile</span>: CredentialStore_OverwriteExportedFile
----
At runtime JADE can export the file defined in the attachment filed of the CS DB to the local file system. for example If attached file is an SSH key and JADE want to use the Key file for Data Exchange operation Usually if JADE want to use an SSH key , stored in the CS as attachement JADE has to export attached file into predefined directory i.e. $HOME/.ssh. To avoide any unwanted overwriting of any existing file into $HOME/.ssh folder, "IMP"" set this parameter as "false".
Data-Type : SOSOptionBoolean
The default value for this parameter is  {*}true{*}.
Use together with parameter:  
* [use_credential_Store|#use_credential_Store] - use credential store for authentication

Alias: CS_OverwriteExportedFile


h4. Parameter <span id"CredentialStore_Permissions4ExportedFile">CredentialStore_Permissions4ExportedFile</span>: CredentialStore_Permissions4ExportedFile
----
At runtime JADE can export the file defined in the attachment filed of the CS DB to the local file system. for example If attached file is an SSH key and JADE want to use the Key file for Data Exchange operation Usally if JADE want to use an SSH key , stored in the CS as attachement JADE has to export attached file into predefined directory i.e. $HOME/.ssh and key file should have specific permissions. It could be possible that "application user" calling the JADE have different set of application, to avoide any file permission issue during run time, "IMP" set the required file permission using these parameters 
{code:language=bash}
                                -CredentialStore_Permissions4ExportedFile="600-MAHEND"

<source>
                            

</source>

example: additional parameters in notes section

No Format

  
Code Block

                            example: additional parameters in notes section
                            
                                -CredentialStore_Permissions4ExportedFile=Permissions4ExportedFilh1. "600-MAHEND"
                            
                            
                            
                        
 

</source>
Data-Type : SOSOptionString
The default value for this parameter is 600.
Use together with parameter:

...

Alias: CS_Permissions4ExportedFile

Parameter <span

...

id"CredentialStore_DeleteExportedFileOnExit">CredentialStore_DeleteExportedFileOnExit</span>: Delete Attachment On Exit of Application

...

At runtime JADE will export the attached file to local file system , once operation is completed , irrespecive of operation's status (successfully or unsucessfully ), by default JADE will delete this file. In special case i.e. for debuging or any other reason if you want that JADE should not delete the file "IMP" set this parameter as FALSE
Data-Type : SOSOptionBoolean
The default value for this parameter is true.
Use together with parameter:

...

Alias: CS_DeleteExportedFileOnExit

Parameter <span

...

ih1. "CredentialStore_ExportAttachment">CredentialStore_ExportAttachment</span>: Export attached file to disc

...

If JADE need an file, stored in the CS DB as attachemenr, at runtime JADE can export the file on local filesystem. By default JADE don't export attached file. "IMP" if JADE need "attachment" file at runtime , set this parameter as TRUE
Data-Type : SOSOptionBoolean
The default value for this parameter is false.
Alias: CS_ExportAttachment

Parameter <span

...

id"CredentialStore_ExportAttachment2FileName">CredentialStore_ExportAttachment2FileName</span>: Name of the extracted attachment file

...

To use the file stored in the CS as attachment, during an operation, JADE has to export the attached file on local filesystem. To define the name of exported file name on local filesystem , use this parameter.

Code Block
languagebash
                                -CredentialStore_ExportAttachment2FileName="archive_server_ras.ppk"

<source>
                            

</source>

example: additional parameters in notes section

Code Block

Code Block

                            example: additional parameters in notes section
                            
                                -CredentialStore_ExportAttachment2FileName="archive_server_ras.ppk"
                            
                            
                                todo: This is the explanation for this example.
                            
                        
 

...

Alias: CS_ExportAttachment2FileName

Parameter <span

...

ih1. "CredentialStore_KeyFileName">CredentialStore_KeyFileName</span>: Name of the File containing the private Key

...

Credential store can be accessed by the JADE using an private key or with password or combination of both. define the path/location of the ssh key file using this parameter.

Code Block
languagebash
                                -CredentialStore_KeyFileName="jade_cs_rsa.ppk"

<source>
                            

</source>

...

Code Block
                            example: additional parameters in notes section -CredentialStore_KeyFileName="jade_cs_rsa.ppk"
                            
                            
    -CredentialStore_KeyFileName="jade_cs_rsa.ppk"
                            
todo: This is the explanation for this example.
                     
       
                        
 todo: This is the explanation for this example.
                            
                        
 

Data-Type : Data-Type : SOSOptionInFileName
Use together with parameter:

Alias: CS_KeyFileName

Parameter <span

...

id"CredentialStore_password">CredentialStore_password</span>: Password for CS

...

Credential store can be accessed by the JADE using an private key or with password or combination of both. define the CS's access password using this parameter. "IMP" always set strong password for CS.

Code Block
languagebash

                                

<source>
                            

</source>

example: additional parameters in notes section

set strong password for CS.

code
Code Block
languagebash
                            example: additional parameters in notes section

<source>
                            

</source>

Code Block
                                -CredentialStore_password="55ybr293N!2BButnY4,w"
                            
                            
                                todo: This is the explanation for this example.
                            
                        
 

...

Alias: CS_password

Parameter <span

...

ih1. "CredentialStore_AuthenticationMethod">CredentialStore_AuthenticationMethod</span>: Authentication Method for the CS

...

There are three possible combination of Authentication methods.

Code Block
languagebash
                                
                                
                                
                                
                                


<source>
                            

</source>

...

Code Block
                            example: additional parameters in notes section
                            
                                -CredentialStoreAuthenticationMethod="password"
                                 --- OR --- 
                                -CredentialStoreAuthenticationMethod="privatekey"
                                 --- OR --- 
                                -CredentialStoreAuthenticationMethod="password+privatekey"

...

This parameter is mandatory.
Alias: CS_AuthenticationMethod

Parameter <span

...

id"CredentialStore_StoreType">CredentialStore_StoreType</span>: The Type of the crendential store application

...

At present only "KeePass" as CS DB is supported and only "KeePass" as valid parameter value is permitted.
Data-Type : SOSOptionString
The default value for this parameter is KeePass.
Use together with parameter:

Alias: CS_StoreType

Parameter <span

...

ih1. "CredentialStore_KeyPath">CredentialStore_KeyPath</span>: Path and Key for the credentials

...

This Option specifies the path of the Access key for the entry which has to be used for the credentials.
Credential store can be accessed by the JADE using an private key or with password or combination of both. define the path/location of the ssh key file using this parameter.

Code Block
languagebash
                                

<source>
                            

</source>

...

Code Block
                            example: additional parameters in notes section
                            
                                -CredentialStore_KeyFileName="/ssh/server1/sap-upload"
                            
                            
                                todo: This is the explanation for this example.
                            
                        
 

...

This parameter is mandatory.
Alias: CS_KeyPath

Parameter <span

...

id"CredentialStore_FileName">CredentialStore_FileName</span>: Name of Credential Database

...

The path and name of the KeePass or KeePassX DB file with the file extension ".kdb".

...

Code Block
languagejava
                                CSOptions.CredentialStoreFileName.Value("/etc/keystore/sap_jade.kdb");

<source>
                            

</source>

...

Code Block
                            example: additional parameters in notes section
                            
                                jade.sh -CredentialStoreFileName="/etc/keystore/sap_jade.kdb" ...
                            
                            
                                CredentialStoreFileName = /etc/keystore/sap_jade.kdb
                            
                            
                                CSOptions.CredentialStoreFileName.Value("/etc/keystore/sap_jade.kdb");
                            
                            
                                todo: This is the explanation for this example.
                            
                        
 

...

This parameter is mandatory.
Alias: CS_FileName

Parameter <span id="use_credential_Store">use_credential_Store</span>: use credential store for authentication

...

If you want to store your access data i.e. user-id , password, SSH key , DB URL in encrypted CS DB, unable this parameter and configure the rest if the CS accordinglly. By default JADE will look for the parameters from settings.ini, command line or from JITL job.
Data-Type : SOSOptionBoolean
The default value for this parameter is false.

...