SecureClient 5.6 UsersGuide All ENU

USERS
GUIDE
SecureClient
Version 5.6
August 2010
DUG0000SC560
ii
iii
Copyright Axway Software, 2010.

All rights reserved.
This documentation describes the following Axway software: SecureClient.
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language,
in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission
of the copyright owner, Axway Software.
This documentation, provided for informational purposes only, may be subject to significant modification. The descriptions and information
in this documentation may not necessarily accurately represent or reflect the current or planned functionalities of this product. Axway Software may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this documentation. Axway Software does not warrant that this documentation is error free.
Axway Software recognizes the rights of the holders of all trademarks used in its publications.
Chapter 1 - Axway SecureClient overview
Axway SecureClient Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Authentication, Certificates, and Fingerprints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Connections and Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Supported FTP Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Supported HTTP Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Supported SFTP Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Supported SSL/TLS Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2 - Scheduler
Using the Rescuer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 3 - Jobs
9
Job States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Periodic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 4 - Transferring Files
11
Scheduling a Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Transferring Files from the Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 5 - Main Window
15
Local and Remote View Window Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Local View pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Remote View pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Monitoring pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Log Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Schedule Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 6 - Site Manager
19
Site Details Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Site Manager General Parameters Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Protocol-specific parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
FTP-specific Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
HTTP-specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
SFTP-specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Gateway parameters tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Security Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
SecureTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Outgoing local ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
X.509 and SSL parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
SSH Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Notification parameters tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Enable Email notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Sender/Receiver Recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Notification Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
iii
SECURE CLIENT 5.6 USERS GUIDE
Charset Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Server charset encoding for filenames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Pre/Post Actions Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Post Transfer Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 7 - Security Manager Window
33
Viewing Certificate or Key Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Importing a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Importing a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Deleting a Certificate or Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Generating a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Exporting a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Chapter 8 - Setting Axway SecureClient Preferences
39
Anonymous Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Email Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Editing Text File Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Transfer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Graphical Interface Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Date Format Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Working with Proxy Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Proxy Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Editing a Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Adding a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Duplicating a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deleting a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Log Maintenance Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Scheduler Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
SecureTransport Compatibility Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 9 - Exiting SecureClient
53
Chapter 10 - Batch Mode
55
Script File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Script File Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Script File Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Chapter 11 - Command List
57
cdup Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
chdir command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
vi
SecureClient
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
close Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
delete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
echo Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
get Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
jobsubmit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
lcdup Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
lchdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
ldelete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
list Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
llist Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
lmkdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
iii
vii
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
lpwd Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
lrename Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
lrmdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
mget Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
mkdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
mput Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
newjob Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
open Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Important security note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
output Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
put Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
pwd Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
quote Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
viii
SecureClient
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
rename Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
rmdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
script Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
setdateformat Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Chapter 12 - SecureTransport Client Legacy Mode
87
Command-line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Reserved Characters for URLs or Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Examples of Command-line commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
ST Client batch file samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Sample batch file to verify file transfer status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Sample batch file to perform multiple file transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Chapter 13 - Exit Codes
97
Chapter 14 - Authentication
99
X.509 Certificate Authenthication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

SSH Key-based Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Chapter 15 - Exit Classes
101
SSLSessionListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
SSLPeerAuthListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
SSLUserAuthListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
Chapter 16 - Administration using the command line
103
Exit codes and error management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103

Additional command line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
Site Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Short Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Add new site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
List sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Display site info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
iii
ix
Delete a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107

Change password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Full Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Add new site(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Update a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108
Site File Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Certificate Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
Add new certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
List certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Display certificate info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Delete a certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Job Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
List jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Display job information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Cancel a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Purge jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Log Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
Archive logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
General Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Manage license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Manage scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Force status to stopped state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
SecureClient
Axway SecureClient
overview
Axway SecureClient is a secured FTP, HTTP, and SFTP client designed to
operate with Synchrony Gateway, SecureTransport, or any standard FTP server.
Axway SecureClient runs as a stand-alone application or as a background task.
Axway SecureClient works with SecureTransport to guarantee data delivery and
data integrity while protecting corporate bandwidth. The Auto Restart feature
automatically re-establishes broken connections and resumes transfers from
the point where the transfer stopped.
Synchrony Gateway and SecureTransport offer many additional features
compared to standard FTP servers. Using special FTP commands or HTTP
header parameters, you can:
Route file transfers
Modify the file structure dynamically
Associate a message with the file
Signal that the final application has received and processed the file.
Synchrony Gateway can configure the Axway SecureClient client to define the
information to be sent by the FTP LIST command. Furthermore, Synchrony
Gateway enables you to filter files by name, date, and state.
The Scheduler is a component that runs as a Java program and functions as a
background task. It enables you to manage transfers synchronously or asynchronously. You can program the transfer start time and date as required. You
can use the GUI or the batch mode, either to make synchronous transfers (interactive mode) or to submit a job to the Scheduler.
You can use Axway SecureClient interactively using the GUI (Graphic User
Interface) or in batch mode to automate file transfers and directory management. Similarly, you can perform product administration tasks using either the
GUI or command line.
Axway SecureClient manages its own X.509 certificate database. However, it is
possible to use certificates from an external system.
Axway SecureClient runs as a Java application using Java SE 6 that uses the
Cryptix cryptographic provider, which is part of the installation package (refer
to the Cryptix General License). However, Axway SecureClient is compliant
1
AXWAY SECURECLIENT OVERVIEW

AXWAY SECURECLIENT CONCEPTS
with JCE1.5.0, so any other cryptographic provider can be added, and it will be
chosen dynamically.
Additional Axway SecureClient features include:
Support for email notificationsAxway SecureClient sends emails when

a file transfer has completed and notifies you of the success or failure of
the transfer.
Support for Tunnel Modeprovides a firewall-friendly mode that allows

you to connect securely through a firewall or proxy server
Support for MD5 checksums that guarantee a secure delivery
Support for pausing and resuming file transfers
Support for post transfer actions using external programs for file downloads
Axway SecureClient Concepts

This section describes some of the terms and concepts necessary to understand
Axway SecureClient.
Authentication, Certificates, and Fingerprints

Both FTP and HTTP protocols define a simple authentication method , where
you give a user name and a password to the server. However, Axway SecureClient supports SSH key-based authentication for SFTP protocol, and X.509
certificate authentication for FTP and HTTP protocols. Anonymous authentication is supported by all protocols (HTTP, FTP, and SFTP) Additionally, CGI
authentication is available for HTTP protocol on a Gateway server.
An X.509 certificate identifies an entity and employs mechanisms, including
public keys and fingerprints, that guarantee that data signed by an entity really
comes from that entity. A fingerprint is a short sequence of bytes used to
authenticate a public key. Because fingerprints are generally shorter than public
keys, they are helpful when managing public keys.
SSH key-based authentication identifies an entity based on a pair of matching
keys: a public key stored on the remote server and a private key stored on the
users machine. During authentication, the remote server compares private and
public keys, and if the keys match, the user is authenticated.

AXWAY SECURECLIENT CONCEPTS
The SSH File Transfer Protocol (SFTP) provides encrypted file transfer and
some file-system operations. SFTP uses either password or SSH key-based
authentication.
Two types of authentication are possible in standard SSL: simple authentication,
where only the client/user gets authenticated, and reciprocal authentication,
where both sides are authenticated. Axway adds dual authentication, which
requires username, password, and certificate. Dual authentication is supported
only for SSL. It is not available for SSH.
If the server does not require user authentication, it is possible to accept the
connection regardless of the identity of the server. For more information, see the
Supported SSL/TLS features section.
NOTE:
Connections and Sessions

FTP and HTTP can be secured with SSL or TLS (see the Security section).
SFTP relies on SSH and is thus always secured. A session, or a connection, can
be any of the following:
FTP
HTTP
FTP over SSL (or FTPS)
HTTP over SSL (or HTTPS)
FTP-TLS
HTTP-TLS
SFTP
Axway SecureClient supports multiple sessions with one or more servers at a

time. Managing several sessions with one server allows you to transfer several
files at the same time. While the files are being transferred, you can continue to
send requests.
Security
Security, with SSL or TLS, has several mechanisms: authentication, ciphering,
and sealing. When establishing a new SSL connection, a negotiation phase,
called a handshake, is launched. The authentication is performed during this
step. This is also the moment that security parameters are set, and secret
random data is exchanged. These pieces of information guarantee that the entity

FEATURES
that has been authenticated during the handshake is the only one able to
exchange information with Axway SecureClient during the session.
At the end of the handshake, the session is secured: information is ciphered (if
it was so negotiated) and sealed. Sealing is a mechanism that ensures the integrity of received data: the data received is identical to the data that was sent, and
it arrives in the same order.
An FTP or HTTP session is said to be secured when it relies on an underlying
SSL or TLS layer, authenticating both peers, and ciphering and sealing data. For
further technical details on supported mechanisms, see the Features section.
You cannot consider the fact that the line is secured as a true/false statement. An SSL session can authenticate or not, cipher or not. If ciphering is
performed, an SSL session can use 40, 64, 128, or 254 bits of entropy to generate a
secret key. As the TLS specification states: "The TLS protocol is secured, in that
any cipher suite offers its promised level of security: if you negotiate 3DES with a
1024 bit RSA key exchange with a host whose certificate has been verified, you can
expect to be that secured. However, you should never send data over a link with
40 bit security unless you feel that data is worth no more than the effort required
to break that encryption".
NOTE:
Site
A Site is an object that groups the server connection parameters. Note that a Site
is not necessarily a machine: one machine can have several servers, and even one
server can have several configurations on several ports, according to the identity
of the client user. Thus, you can decide to set several Sites for one server, and
even for one remote port, so that several FTP, HTTP, SFTP, or SSL identities
can be managed.
Features
Axway SecureClient allows file transfers in standard FTP, HTTP, and SFTP, or
over SSL V3.0 and TLS V1.0 with SecureTransport, Synchrony Gateway, and
standard FTP servers.

FEATURES
Supported FTP Features

Axway SecureClient supports the following FTP features:
Active and passive data connection modes. Secured active mode is implemented as defined in RFC 2228.
Implicit and explicit securing mode. Explicit securing mode is performed

using the FTP command AUTH TLS-P or the commands AUTH TLS +
PROT P, as defined in RFC 2228 and RFC 4217.
Transfer resumes when the server supports this feature.
A special option is added to support non-RFC-compliant PASV and

PORT commands: the SSL negotiation of the data connection begins after
RETR, STOR, STOU, or LIST, and not after the PASV or PORT
command.
MD5 file integrity validation when the server also supports this feature
(SecureTransport)
Supported HTTP Features

Axway SecureClient supports the following HTTP features:
File download (GET method)
File upload (PUT method)
Transfer resumes when the server supports this feature
Secured with SSL/TLS
Directory browsing when using any of the following servers:
Synchrony Gateway
SecureTransport
Apache version 1.3 or later
Microsoft IIS
MD5 file integrity validation when the server also supports this feature
(SecureTransport)
Text mode
To enable Axway SecureClient to function with Synchrony Gateway using

HTTP, you must configure Synchrony Gateway to use the correct template file for
NOTE:

FEATURES
Directory Listing. You can find the template file in <SecureClient Installation
folder>/extras/HttpListTemplate.txt.
Supported SFTP Features
File download (GET method)
File upload (PUT method)
Directory browsing
Supported SSL/TLS Features

Axway SecureClient supports SSL version 3.0 and TLS version 1.0. In particular,
the following features of SSL and TLS are supported:
RSA cipher suites. XFB-specific anonymous RSA cipher suites are

included. In this mode, no authentication is performed, so no X.509 certificate is required.
Simple and reciprocal authentication
Session cache
Empty certificate_lists in certificate_request messages. If such a message

is received, it means that the server accepts any root authority.
Scheduler
The Axway SecureClient Scheduler enables you to manage transfers asynchronously. You can program the transfer start time and date as required. You can
use the GUI or the batch mode, either to make synchronous transfers (interactive mode) or to submit a job to the Scheduler. Additionally, you can use the
Scheduler to program Periodic jobs.
Both the GUI and the batch mode communicate with the Scheduler using Java
RMI (Remote Method Invocation). If the RMI Registry process does not exist,
it is created automatically. The Scheduler is only available through the loopback
address (127.0.0.1). No modification or configuration of the JRE environment
is needed.
Using the Rescuer

If the Scheduler fails to start within 30 seconds, the Rescuer will pop up,
showing a failure message and providing you with three choices:
Change the portChanges the port where the Scheduler is listening.
Reset scheduler statusResets the state of the Scheduler and nothing

more. This will not stop a running process.
AbortAborts the the start-up procedure.
If you select either of the first two choices, the corresponding action will be triggered and SecureClient will try to start the Scheduler again.
SCHEDULER
USING THE RESCUER
Jobs
A job is a sequence of commands that are executed on one, and only one,
server. Commands within a job cannot run on more than one server. You can
use the following commands in a job:
Send a file (upload)
Receive a file (download)
Multiple file send (upload)
Multiple receive (download)
The commands in a job are ordered and the number of commands is not
limited. This means that you can use a job to transfer a whole tree structure.
Job States
A job has the following possible states:
To Begin
The job is waiting, either because its start date is in the future, or because
there are already too many jobs in progress for the same site.
Transferring
The job is in process. If a network or other failure occurs, the state will
change to Interrupted until further attempts at connection and transfer
are made.
Interrupted
The job has stopped for a temporary reason. Axway SecureClient will try
to finish the job.
Finished
The job was completely executed.
JOBS
PERIODIC JOBS
Canceled
The job was canceled manually.
Aborted
The job was canceled automatically, for example if an error appears to be
permanent (maximum number of connection or transfer retries has been
reached, authentication failure, and so on). Jobs in this state can be resubmitted, at which point a new job with the same parameters is created.
Paused
A job paused can be resumed if it was running on a server that supports
resuming transfers. Otherwise, a paused job will start from the beginning
on Resume.
Explore File (xx.x%)
Intermediate state appears when computation of the MD5 checksum of
the local or the received file is in progress.
Requesting MD5
Intermediate state appears when checking md5 on the server or when
comparing md5 for the local and remote site (SecureTransport only).
Waiting Server ACK
Intermediate state indicates that check for correctness of the uploaded file
segment is in progress (SecureTransport HTTP only).
Periodic Jobs
You can use the periodic job function of the Scheduler to trigger a job at regular,
predefined times. For example, you can schedule to transfer a file each Friday at
6:00 p.m., at midnight every weekday, or on the first day of each month. The
minimum interval between jobs is 1 minute.
The required period and frequency are defined using the UNIX crontab syntax.
A job is executed when the time and date specification fields match the current
time and date.
Use either the GUI or batch mode to define timing information for periodic
jobs.
10
Transferring Files
You can transfer files by using the Transfer Windows or by scheduling a

transfer.
Scheduling a Transfer
You can schedule a transfer to occur immediately or at some time in the future.
In addition, you can specify that the transfer recur at regular intervals.
TASK
1.
From the Axway SecureClient Main Window, select Tools - Schedule

Transfer.
STEP RESULT: The New Schedule window appears.
2.
(Optional) Specify a Name and Description for your transfer.
3.
In the Type area, select the appropriate radio button to Send files or
Get files with this transfer.
4.
In the What area, specify the files you want to transfer. Use the first row
in the table to enter information about files to be transferred.
a
If you specify that this transfer is a GET operation, select a remote server
from the Get files from drop down list.
In the Files or folders column, specify the path and filename of the file
you want to transfer or click Browse to navigate to the file to be transferred.
Select a file format for the transfer. Choose from Auto, Text, or Binary.
If you choose Auto, Axway SecureClient will use text mode if it recognizes a text file, which depends on file name extensions configured in
11
TRANSFERRING FILES
SCHEDULING A TRANSFER
Axway SecureClient preferences. If Axway SecureClient does not recognize the file format, it uses binary mode.
d
(Optional) If you selected a folder to be transferred, you can select a

Folder filter. Selecting a folder filter will allow only files in the selected
folder that meet the filter criteria to be transferred.
Select Copy or Move from the Transfer type drop down menu.
When you finish specifying your files, click Add to add your file specification to the transfer.
RESULT: Your file specification appears in the next available row in the
table. You can add multiple file specifications in the
Schedule Transfer table.
5.
In the Folder field of the Where area, enter or browse for the path
where you want files transferred.
a
6.
In the When area, specify when the transfer should occur and whether
the transfer should recur. Select one of the following:
Now Starts the transfer immediately when you finish specifying

transfer information and click OK.
7.
12
If you have specified that this transfer is a SEND operation, select a site
from the Send files to drop down list.
Start Date Enables the Date and Start Time fields. Use these fields to
specify the date and time the transfer should start.
In the When area, specify whether the transfer should be recurring and
on what basis. Select the Repeat Schedule check box, and then select
a value from the drop down list. The value you select determines the set
TRANSFERRING FILES
TRANSFERRING FILES FROM THE MAIN WINDOW
of parameters you work with to specify recurrence characteristics.

Choose from the following:
8.
Minutes Specify the number of minutes between transfers. In addition, you can specify on which days of the week and how many times a
day the transfer should occur.
Hourly Specify the number of minutes between transfers. In addition,

you can specify on which days of the week the transfer should occur and
its beginning and ending times.
Daily Specify the number of days between transfers or whether

transfer should occur only on weekdays.
Weekly Specify one or more days of the week on which the transfer
should occur.
Monthly Specify a day of the month and how many months between
transfers.
Yearly Specify the number of years between transfers.
End dateSpecify never ends or ends at a certain date chosen from the
calendar. This property is only available for Repeat Schedule.
Click OK.
STEP RESULT: Your schedule is submitted and the New schedule window is
dismissed.
Transferring Files from the Main Window

In the Main Window, you use the Local and Remote View windows to select
files to transfer and to start or schedule transfers.
TASK
1.
In the Local View and Remote View windows, specify or browse to the
directories you want to be the origin and destination of the transfer
2.
In the window displaying the origin directory, right-click a file (or folder)
to transfer, and then select one of the following:
Transfer selected file(s)The selected file is transferred immediately.

If you are uploading files, it uses the currently opened Remote View.
13
TRANSFERRING FILES
TRANSFERRING FILES FROM THE MAIN WINDOW
Transfer parameters are based on the files and folders displayed in the
Local and Remote View Windows as well as from the Sites preferences.
Schedule transfer of selected file(s)The New Schedule window

appears with fields filled based on the files you selected in the File
Transfer window and the time for the transfer set to Now.
You can edit the values in the New Schedule window before you submit
the job.
Transfer pattern matching file(s) of current directoryA dialog box
appears in which you specify a filter to be used for selecting files to
transfer. Specify a pattern and then click OK.
The New Schedule window appears with fields filled based on the files
selected by the filter and the time for the transfer set to Now.
You can edit the values in the New Schedule window before you submit
the job.
This is equivalent to the mput and mget batch commands.
Select and TransferSelect the file to be transferred from the origin
directory and click on the arrow to transfer it to the destination directory. You can use either the arrows located between the local and
remote views or the Transfer button at the bottom of the Main
Window.
Drag and DropSelect the file or folder to be transferred from the
origin directory and drop it into the destination directory..
ADDITIONAL INFORMATION: When transferring files, you can set the Synchrony
Gateway specific parameters Originator,Destination, Application, and
Message. On SecureClient, you can set these options for a site from the
Gateway tab. For more information, refer to the Synchrony Gateway documentation. If these parameters are set in the site configuration, the set values
will be used, but might be overridden here.
14
Main Window
You use the Main Window to access connections, logs, and certificates, and
transfer files. This window is made up of the following components:
Connection management area where you can select the remote server that
you want to connect to, or you can specify a URL for the remote server that
you want to connect to.
Local View and Remote View panes. Each View pane contains a box with
the path and file name of the directory, directory navigation buttons, and
a listing of the contents of the directory you are browsing. Between the two
View panes are the Transfer buttons or arrows.
Monitor pane with two tabs: The Schedule tab where you can view and
manipulate scheduled transfers, and the Log tab where you can view log
files.
Local and Remote View Window Tools

The toolbars at the top of the Local View and Remote View Windows enable
you to navigate through and work in your local and remote directory structures,
respectively.
The following buttons are provided:
Parent directory
Navigates to the parent directory of the current directory.
Working directory
Navigates back to the directory from which Axway SecureClient was
started.
Create directory
Creates a new directory in the current directory.
15
MAIN WINDOW
LOCAL VIEW PANE
Refresh
Updates all information in the window.
Local View pane

You use the Local View pane to navigate through the local files to select either
the destination directory of an incoming transfer, or the source file or directory
of an outgoing transfer. You can browse to a folder on your system and then
select the files you want to transfer, or you can select files using the criteria you
specify.
Remote View pane

You use the Remote View pane to select either file(s) to download or a destination directory where you intend to upload local file(s).
If the remote server is a Synchrony Gateway, this pane provides a view of transfers (available, sent, ended successfully, and so on.). For non-Gateway servers,
this window shows the files and folders on the server.
For Synchrony Gateway FTP servers, tools for filtering the remote files are also
provided. The lower fields enable you to filter files by name, Local or Transfer
ID, or date, as they are seen by the server. Enter a name as a regular expression,
a Local or Transfer ID, or date condition between the files proposed, and press
Enter. The view will be updated. There is also a General tab in addition to the
View and Filter tabs. The General tab represents site common details and information about the Gateway profile.
With standard FTP servers, you can only enter arguments of the standard FTP
LIST command in the File name field.
Finally, you can enter FTP protocol commands through the Send a raw
command menu.. The only operation Axway SecureClient performs on this
command is to add the CR/LF characters at its end. The server response to this
command is displayed in the Log window.
NOTE:
16
You cannot transfer files between two remote views.
MAIN WINDOW
MONITORING PANE
Monitoring pane
The monitoring pane in the lower part of the main window shows log messages
or a list of transfers, depending on the selected tab.
Log Tab
Click the Log tab to view the Log window. The log messages in this window
indicate what has been done by Axway SecureClient, the result of each action
performed (success or failure), and the cause of possible errors. The three
buttons at the left allow you to:
Archive Log
Archives the log. The archiving action also cleans the log view. For more
information, see the "Log Maintenance Settings" section.
Refresh Scheduler Log
Refreshes the currently displayed log.
Autoscroll
Toggles log message scrolling on and off.
Schedule Tab
Click the Schedule tab to view the Schedule window. Use the drop down menu
to control the state of the schedule tab. Choose from the following:
All Transfers
View all transfers.
Waiting Transfers
View scheduled transfers waiting to be processed.
Running Transfers
View transfers currently being processed. You can cancel transfers
displayed in this view.
17
MAIN WINDOW
SCHEDULE TAB
Finished Transfers
View scheduled transfers that have ended. You can purge transfers from
this view.
Control Panel
Adjacent to the Schedule and Log tabs is a control panel that consists of
six buttons:
Show job detailOpens job details view for the currently selected job.
Cancel Job - Cancels one or more jobs, depending on the selection.
Pause JobPauses one or more jobs, depending on the selection.
Resume JobResumes one or more jobs, depending on the selection.
Resubmit JobResubmits one or more jobs, depending on the

selection.
Delete jobDeletes one or more jobs, depending on the selection.
Except for Resubmit Job, these same options are available when you right click
on a job.
18
Site Manager
The Site Manager window displays a summary view of the Sites contained in the
database. To edit, copy, or remove a Site object, select the corresponding row in
the Site list, then either right-click or click an action button. Choose from the
following options:
New
Create a new empty Site object with default values.
Edit
Edit/display detailed parameters for the selected Site. You cannot change
the name of the Site in Edit mode. Instead, use the Rename button.
Rename
Displays a dialog box you can use to rename the Site selected.
Copy
Create a new Site object with parameters copied from the selected Site.
You must provied a new alias for the Site.
Delete
Delete the selected Site.
Help
Displays online help for the Site Manager screen.
19
SITE MANAGER
SITE DETAILS WINDOW
Site Details Window

You use the Site Details window to manage your individual sites. Each site
object defines all the parameters needed to connect to remote servers. These
parameters are divided into six categories:
General parameters
Gateway parameters
Security parameters
Notification parameters
Charset parameters
Pre/Post Actions
Site Manager General Parameters Tab

Use the General tab to manage general parameters for the Site. This is where you
enter protocol-specific parameters for FTP, HTTP or SFTP.
Alias
Enter an alias for this Site. It must be unique, so that when used on the
command line as the first parameter, Axway SecureClient will start and
connect immediately to the corresponding server without further action.
Protocol
Specify the protocol to be used with this site. Select FTP, HTTP, or SFTP.
Host
Enter the DNS name or the IP address of the remote server to connect to.
Port
Enter the IP port number of the server to connect to.Default values:
21 (FTP)
22 (SFTP)
80 (HTTP)
User
Enter the user name to use during login phase with the server.Default
value: anonymous.
20
SITE MANAGER
SITE DETAILS WINDOW
Password
Enter the password to use during the login phase with the server.
Local directory
Specify a starting directory for the Local view window of the Main window
when connecting to this Site. You can click the folder icon to browse.
Remote directory
Specify a starting folder for the Remote view window. This folder will be
the home directory on the remote server.
Protocol-specific parameters
See the topics on FTP-, HTTP-, and SFTP-specific parameters for more information.
FTP-specific Parameters
Account
Enter the name of the account, or the group, to accept login (required by
some servers).
Connection mode
Specifies how to establish FTP data connections:
Active: in this mode, the FTP server connects to the client (Axway SecureClient).
Passive: in this mode, this is the client (Axway SecureClient) that connects
to the FTP server. This is the default mode.
21
SITE MANAGER
SITE DETAILS WINDOW
Server type
Select the type of server:
Server Type
Description
Processing Rules
AXWAY (for Synchrony

Gateway)
List columns are defined

using a specific command.
Columns are configured on
the server side.
SecureTransport
List columns must be

compliant with the
following rules:
Column 1: permissions
string followed by at least
one space character.
Column 2: link string
followed by at least one
space character.
Column 3: owner string
space character (also
configurable from ST).
Column 4: group string
space character (also
configurable from ST).
Column 5: size string
space character.
Column 6: date string
(depends on the format
chosen in Preferences ->
Date format detection)
space character.
Column 7: filename
string up to end of line.
Symbolic links are
analyzed to guess if the
linked file is a directory
or a true file.
22
SITE MANAGER
SITE DETAILS WINDOW
Server Type
UNIX standard
Description
Processing Rules
List columns must be
compliant with the
following rules:
Column 1: permissions
string followed by at least
one space character.
Column 2: link string
space character.
Column 3: owner string
space character.
Column 4: group string
space character
Column 5: size string
space character.
Column 6: date string (12
characters) followed by at
least one space character.
Column 7: filename
Symbolic links are
analyzed to guess if the
linked file is a directory
or a true file (by using
SIZE FTP command).
Microsoft FTP
Columns must be compliant

with the following rules:
Column 1: date string (23
Column 2: type string (5
Column 3: size string (8
Column 4: filename
IBM MVS
Unisys
23
SITE MANAGER
SITE DETAILS WINDOW
Server Type
Description
UNIX without group

column
This type mainly defines the

way to handle server
responses to FTP list
commands. In the case of
Synchrony Gateway, it also
changes the FTP protocol
slightly to take advantage of
the extra functionalities this
server offers.
Guess
In most cases, Axway

SecureClient is able to
recognize the type of server
it is connecting to. The type
of server can be inferred
from its welcome message,
or from the response to an
extra SYST command. This
last command can be
avoided if you enter this
parameter yourself. If no
type can be inferred from
the initial FTP dialog, the
default value (UNIX
standard) is used.
Java
Processing Rules
This is the same as "UNIX
standard" except that the
group column is missing.
This server type requires the

following data:
Unix Permissions
UnixLink
UnixOwner
UnixGroup
Size
Month
Day
Year/Hour
Filename
Secured mode
Select the mode:
24
Implicit mode (the session starts in secured mode directly)
Explicit mode: The AUTH TLS-P session is a pure FTP session until the
AUTH TLS-P command is sent to the server, which starts the underlying
SSL layer. The AUTH TLS+PROT P session is a pure FTP session, until
SITE MANAGER
SITE DETAILS WINDOW
the AUTH TLS command is sent to the server, which starts the underlying
SSL layer, After that protection P level is set.
PASV is compliant with RFC
Some servers do not expect data connections in a totally compliant way.
They expect that the SSL negotiation, on data sessions, begins after the
command RETR, STOR, STOU, or LIST (the command that requires the
data connection), instead of after the command PASV, or PORT (the one
that is responsible for opening the data connection). For these servers,
deactivate this option. In particular, if the session starts normally, but
freezes each time a list, put or get command is sent, try deactivating this
option.
Firewall Friendly
Axway SecureClient includes a setting for the FTP subcommand, Clear
Control Connection (CCC). When this setting is enabled, it makes a
secured control/command channel revert back to plaintext (un-secured).
If Firewall Friendly setting is enabled, the client connects to the server,
negotiates a secure connection, authenticates (sends username and password) then reverts back to plaintext.
Use FTP if FTPS is not supported by server
If server does not support FTPS and this option is selected, the connection
will fall back to FTP. Otherwise, the connection is broken.
HTTP-specific Parameters
Server type
Select the type of server:
AXWAY (Synchrony Gateway)

NOTE: You must also configure Synchrony Gateway for Axway SecureClient
using the HttpListTemplate.txt template located in the extras
subdir of the place where the install directory of SecureClient is located.
SecureTransport
Apache version 2.2, 2.0, or 1.3
Microsoft IIS
LightHttpd
Auto
Version
Select the HTTP protocol version:
25
SITE MANAGER
SITE DETAILS WINDOW
HTTP 1.0
HTTP 1.1
Identification method
Select the identification method used to identify the client (user and password):
Anonymousno user or password provided
Basicuser and password are provided in the HTTP header
CGISynchrony Gateway-only authentication protocoluser and password are provided as parameters in an HTTP command
SFTP-specific Parameters
Server type
Select the type of server: Windows or UNIX.
Gateway parameters tab

Use the Gateway tab to manage parameters for this Site that are specific to
Synchrony Gateway.
If these parameters are supplied, they are used by the Synchrony Gateway server
when receiving files from Axway SecureClient.
When you begin to send a file, the default values of these parameters are
proposed in the File transfer window, as set in the Site Gateway parameters tab.
Click on the field you want to change, then click OK to send these parameters
and start file transfer.
Originator and Destination
Synchrony Gateway uses these two strings to route the file.
Application
The Application is a Synchrony Gateway object used to change the file
format or the character encoding on reception.
Message
This is a list of messages that appear as one message per line. Before
sending a file, you can select one of these messages. The selected message
will be sent to Synchrony Gateway before file transfer and will be associated with the transfer. This field is for the customer's application usage.
26
SITE MANAGER
SITE DETAILS WINDOW
Refer to the Synchrony Gateway documentation for more information on these

parameters.
Security Parameter Tab

Use the Security tab to manage security parameters for the Site.
SecureTransport
Guarantee delivery using MD5 hash
Check this box to perform an MD5 checksum at the end of the transfer to
ensure file integrity.
Guaranteed delivery is ST specific functionality and is supported for all
protocols except SFTP.
NOTE:
Outgoing local ports

Local ports
This list of local ports is useful if you connect to the server through a firewall that checks calling ports. If none is supplied, Axway SecureClient lets
the operating system choose a free local port. If local ports are supplied,
Axway SecureClient tries each provided value until it finds a free port
number. If none is available, the connection will fail.
Two local ports are needed for one session. So you need to supply 2 + 2 *
(number of parallel sessions) local TCP ports.
Proxy
Server
Select the proxy server to be used by this site. You define proxy servers
using the Proxy tab in the Preferences dialog box.
Proxies General Preferences button
Select the button next to the Server field to display the Proxies General
Preferences dialog box. Use this dialog box to open the main proxy setup
menu. For more information, see "Working with Proxy Preferences"
section.
27
SITE MANAGER
SITE DETAILS WINDOW
X.509 and SSL parameters

If you specified FTP or HTTP as the protocol for this site, you can specify the
following X.509 and SSL parameters.
Activate SSL security
Check this box to activate SSL/TLS and authenticate for this site.
Client certificate
Choose a personal certificate from the certificate database to use as yours.
If the server requests one during negotiation (and only if it requests one)
send this certificate to validate your identity and thus be granted access to
the server content.
Certificate password
This parameter enables Axway SecureClient to remember the client certificate password and therefore authenticate without requesting the password for each connection to this Site. This parameter is optional.
Server certificate
This parameter checks the server certificate when using SSL or TLS. If you
choose one certificate from the certificate database, Axway SecureClient
will request the presence of this certificate in the server's certification
chain to accept its authentication. If no certificate is provided here, any
valid certification chain leading to a trusted root authority will be
accepted. In case the provided certificate is not among the trusted ones,
the behavior is defined by If server has an unknown root certificate
option (see below).
Check that server certificate common name matches host name
Check this box if you want Axway SecureClient to check that the common
name in the server certificate matches the name entered in the Host field
in the General tab.
SSL/TLS Cipher Suite
This parameter specifies the authorized cipher suites when using SSL or
TLS. A cipher suite defines the security parameters to use during a session.
During negotiation Axway SecureClient proposes the given list to the
remote site. It is then up to the server to pick one of them, or to refuse the
session if none of them fits its policy.
NOTE:
If no cipher suite is selected some default cipher suites are set automati-
cally:
28
TLS_RSA_WITH_AES_128_CBC_SHA
SSL_RSA_WITH_RC4_128_SHA
SITE MANAGER
SITE DETAILS WINDOW
SSL_RSA_WITH_RC4_128_MD5,
SSL_RSA_WITH_3DES_EDE_CBC_SHA
SSL_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA - only available if JCE Strong

encryption is installed on the machine
SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
SSL_RSA_EXPORT_WITH_RC4_40_MD5
SSL_RSA_WITH_NULL_SHA
SSL_RSA_WITH_NULL_MD5
Use SSL cache

Check this box to activate SSL cache.
SSL allows both sides to save security parameters of previous sessions.
When negotiating a new session, the client can propose some parameters
that have been negotiated during a previous session with the server. It can
accept them or not. So both sides avoid doing some heavy cryptographic
computations on every connection.
Clear this check box to disable the option.
If server has an unknown root certificate
Select an option to either accept an unknown root certificate, prompt you
when an unknown certificate is encountered, or reject an unknown root
certificate.
SSH Parameters
Server key status
Displays the status of the key for this site.
TO IMPORT there is no key associated with this site.
NOT TRUSTED a key is associated with this site, but it is not trusted
TRUSTED a key is associated with the site, and it is trusted.
Authentication method
Specify whether to use a password or a key for authenticating at transfer
time.
User key alias
When authenticating the client using a key, this alias refers to the User
Keys table from the Security Manager.
29
SITE MANAGER
SITE DETAILS WINDOW
Notification parameters tab

Use the parameters on this page to control email notification about transfer
success and failure for this site.
Enable Email notification
To use this option, you must define mail server in the preferences. You use these
check boxes to enable email notification at the site level.
Success
Enables email notification for successful file transfer to or from this site.
Error
Enables email notification for file transfers that generate errors.
Sender/Receiver Recipient
You use the following fields to specify email address for senders and recipients
of email notification for this site.
From
Specify a value to be used in the From field for notification email.
To
Cc
Bcc
Specify one or more recipients of notifications. Use commas to separate
multiple recipients.
Notification Templates
You use these fields to specify templates to be used for email notification. You
specify one each for success notifications and error notifications. Default
templates are available in the notify folder of the SecureClient installation directory.
Success
Specify the email template to use for notification of successful transfer.
Error
Specify the email template to use for notification when transfers generate
errors.
30
SITE MANAGER
SITE DETAILS WINDOW
Charset Parameter Tab

Axway SecureClient support for remote server system encoding allows
exchanging files regardless of the remote server system encoding.
You use the Charset tab to specify character set encoding per Site. That is, all
character output from the Site is decoded in the character set you specify on this
tab and corresponding requests to this Site are encoded using the same character set.
Server charset encoding for filenames
Choose one of the following
Force UTF-8
Choose this radio button to force Axway SecureClient to use UTF-8. This
is the default value.
Use custom charset
Choose this radio button to enable the Encoding drop-down menu. You
choose the encoding you want Axway SecureClient to use.
NOTE:
Using the wrong charset can result in filenames not displaying correctly.
Pre/Post Actions Parameter Tab

Transfer Mode
Auto
Axway SecureClient compares filename patterns you specify in the Preferences dialog box with the names of the files to be transferred. If there is
a match and the server does not support ASCII mode, Axway SecureClient
converts the end-of-file markers as appropriate for the users native platform and transfers the file.
Binary
Treats transferred files as binary files.
Text
Treats transferred files as text files.
31
SITE MANAGER
SITE DETAILS WINDOW
Post Transfer Actions

Post transfer actions are executed after the file in question is downloaded.
External Program
Specify an external program or action to run as a post transfer action. You
can specify %f as an argument, which is replaced with the files name
before execution.
32
Security Manager
Window
You use the Certificates Manager to manage your certificates and keys. You can
import certificate and keys, view their contents, delete them, and generate user
keys.
Certificate database
This panel displays information about the certificates and keys stored on
your system. They are divided into the following categories:
TrustedCertificates issued by a trusted certificate authority that Axway

SecureClient uses to validate the identity of the remote site.
IntermediateCertificates based on an existing trusted certificate that

Axway SecureClient uses to complete the chain to the trusted certificate.
PersonalCertificates used for authenticating local parties against remote

sites.
User keysSSH keys used for authenticating local parties to remote sites.
Import
Starts an import procedure.
Delete
Deletes the selected certificate or key.
Details
Displays details about the currently selected certificate or key.
Generate key
Generates a user SSH key pair.
Export a public key
Exports an SSH public key .
33
SECURITY MANAGER WINDOW

VIEWING CERTIFICATE OR KEY DETAILS
Viewing Certificate or Key Details

You use the Security Manager window to view details about certificates and keys
stored in the Axway SecureClient certificate database.
TASK
1.
From the Axway SecureClient Main Window, select Tools - Security

Manager.
STEP RESULT: The Security Manager window is displayed.
2.
Click the tab appropriate to the type of item about which you want to
view detail information.
3.
Select an item, and then click Details. Alternatively, you can select and
then right-click an item.
STEP RESULT: A new dialog box containing detailed information about the
selected item appears.
4.
Click OK to dismiss the dialog box.
Importing a Certificate
You use the Import Certificate Wizard to import a certificate.
TASK
1.

Manager.
STEP RESULT: The Certificates manager window is displayed.
2.
Click Import.
STEP RESULT: The Import Certificate Wizard welcome window is displayed.
3.
34
Choose a source file. The extension indicates the type of file you are
choosing. Supported formats are DER and Base64 certificates (*.cer,
*.der, *.crt), PKCS#7 certificate chains (*.p7b, *.p7s, *.p7m), and PKCS#12
containers (*.p12, *.pfx). Click the browse button to navigate through
your local files.

IMPORTING A KEY
4.
For each certificate in the file, you must set up three parameters.
ADDITIONAL INFORMATION: A DER file contains one certificate, but a PKCS#7 or
PKCS#12 file can contain several certificates.
The alias of a certificate is a friendly name that uniquely identifies it in the
database. An alias is automatically generated, and it cannot be changed.
5.
To determine whether you can trust the current certificate authority or

not, click the Detail button to check its content.
6.
Clear the import check box if you do not want to import the corresponding certificate. This can be used in case of a PKCS#7 or PKCS#12
multiple certificate import.
ADDITIONAL INFORMATION: During multiple certificate import, an import check
box is available for every certificate in the list. You must select which certificates to be imported.
7.
Enter passwords if the import is performed from PKCS#12 files.
The first password is required to unwrap the content of the PKCS#12 file.
It is mandatory: the content of the file cannot be retrieved without it.
Then the certificate and its private key can be imported. Axway SecureClient saves private keys in an encrypted form.
To access the private keys, you must enter a second password. Because
this password is required to accesss the private keys, you can change it.
To be sure of the password you entered, a confirmation is required. Be
sure to remember it you will need it if you want to get authenticated
by a server. If you do not enter a new password, the old password of the
PKCS#12 file is kept. Import the certificate(s) by clicking the Finish
button
Importing a Key
You use the Certificates Manager to import user keys.
TASK
1.

Manager.
35

DELETING A CERTIFICATE OR KEY
2.
Click the User Keys tab, and then click Import.

STEP RESULT: The Key Import dialog box is displayed.
3.
Enter a value in the Name field, specify a file and path or browse to a file
to be imported, enter the password for the key, and then click OK.
Deleting a Certificate or Key

You use the Certificates Manager window to delete certificates and keys.
TASK
1.

Manager.
2.
Click the tab appropriate to the type of item you want to delete, for
example a trusted certificate or a key.
3.
In the list of certificates or keys, select the item you want to delete and
click Delete. Alternatively, you can right-click on the certificate or key
and then select the Delete option.
STEP RESULT: A delete confirmation dialog box is displayed.
4.
Click Yes to delete the selected item.

STEP RESULT: The selected item is deleted from the database
Generating a Key
You use the Certificates manager window to generate new user keys.
TASK
1.

Manager.
2.
Click the User Keys tab, and then click Generate Key.
STEP RESULT: The Key Generator dialog box appears.
36

EXPORTING A KEY
NOTE:
You must be in the User Keys tab for the Generate key button to be
active.
3.
Enter a value in the Name field.
4.
From the Algorithm drop down menu, select the algorithm you want to
use to generate the key. Choose from RSA or DSA.
5.
From the Length drop down menu, select the length (in bytes) of the
key to be generated. Possible values are1024 and 512.
6.
Click OK.
STEP RESULT: The key is generated and added to the list of keys displayed in the
User Keys tab.
Exporting a Key
You use the Certificates Manager to export SSH public keys.
TASK
1.

Manager.
2.
Select a user key from the Certificates manager window and then click
Export Pulic key. Alternatively, you can right click on it, and then select
the Export Public key option.
STEP RESULT: The Open file dialog box appears.
You must be in the User Keys tab for the Export Public key button to
be active.
NOTE:
3.
Browse to the directory where you want to save the exported key, enter
a filename, and then click Save.
37

EXPORTING A KEY
38
Setting Axway SecureClient Preferences

Preferences for Axway SecureClient are categorized into the following areas:
Anonymous Login
Email Notification
File Format
Connection
Transfer
Graphical Interface
Date format detection
Security Settings
Proxies
Log Maintenance
Scheduler
SecureTransport Compatibility
TASK
1.
From the Axway SecureClient Main Window, select Tools - Preferences.

STEP RESULT: The Preferences window is displayed.
2.
In the list on the left side of the Preferences window, click the type of
preference you want to change.
3.
Enter or edit values for the parameters you want to change, and then
click Save.
ADDITIONAL INFORMATION: Editing Proxy preferences requires some extra steps.
Some changes in Preferences might require you to restart the Scheduler.
Axway SecureClient displays a warning message in this case.
39
SETTING AXWAY SECURECLIENT PREFERENCES

ANONYMOUS LOGIN
Anonymous Login
Password
This value is used as the password when connecting to an FTP server using
the anonymous special user.
Email Notification
Host
The hostname of the SMTP server used to send notification email for both
successful and failed transfers.
Port
The IP port number of SMTP server used to send notification email.
Default is 25.
File Format
Patterns
Specify a list of regular expressions in this field. Names of files being transferred are compared to this list and files that match are automatically
converted to the destination text file format (CRLF on Windows or LF on
UNIX).
Editing Text File Pattern

To automatically set the parameters of a file transfer from the local station,
Axway SecureClient distinguishes ASCII files from binary files according to
their name. A list of text file patterns, that are regular expressions, is maintained, and the files whose names correspond to those patterns are considered
as text files. The default values may not correspond to your requirements. You
can edit the values in the Text file pattern List window.
40

FILE FORMAT
All the existing patterns are displayed in this window. Each new line corresponds to a new pattern. Add a pattern by adding a new regular expression on
a new line. Patterns can also be separated by space or tabulation characters on
the same line.
Regular expressions define matching rules for a string, and thus enable you to
define a category of file names that resemble each other by one pattern. For
example, you might consider all the files with extensions that begin with txt as
text files. The regular expression corresponding to this matching condition
would be *.txt* or *.txt? if no more than one character can follow the string .txt.
To match, each character must correspond in the regular expression and in the
string as shown in the previous txt example. In addition, it can contain wildcards to allow multiple possibilities:
A question mark (?) replaces one arbitrary character
An asterisk (*) replaces zero or more arbitrary characters
An ellipsis (...) within brackets ([...]) replace any characters enclosed by

the brackets. The asterisk (*) and question mark (?) lose their special
meanings within a character class. If the first character following the
opening bracket is an exclamation mark (!) or a caret (^), then any character not in the character class is matched. A hyphen (-) between two characters can be used to denote a range. A hyphen (-) at the beginning or end
of the character class matches itself rather than referring to a range. A
close bracket (]) immediately following the opening bracket ([) matches
itself rather than indicating the end of the character class. Otherwise, it
must be escaped with a backslash (\) to refer to itself.
A backslash (\) matches itself in most situations. However, when a special

character such as an asterisk (*) follows it, a backslash escapes the character, indicating that the special character should be interepeted as a
normal character instead of having its special meaning.
Examples
regular expression
file name
match?
*.txt
toto.txt
yes
*.txt
toto.txt2
no
*.txt?
toto.txt2
yes
*.txt?
toto.txt23
no
*.txt??
toto.txt23
yes
41

CONNECTION
regular expression
file name
match?
*.txt*
toto.txt23
yes
to?.txt
toto.txt
no
to*.txt
toto.txt
yes
Connection
Maximum retry count
If a connection fails, Axway SecureClient will try to reconnect several
times. Set this parameter to the number of times you want Axway SecureClient to retry before considering that the connection has actually failed.
Set the value to 0 to disable this feature for all sites.
Retry delay
If a connection has failed, the time to wait before retrying (see Max. retry
count above).
Network time out
This value indicates how much time to wait when requesting data before
considering that the connection is broken. It is valid for the whole session,
not only during connection. Set the value to 0 to disable this feature for all
sites.
Maximum simultaneous sessions
The maximum number of control sessions that can be opened simultaneously for one site. This option is applied separately for each site. When the
maximum connections for a particular site is reached, you can still make
transfers to other sites.
To begin new file transfers, Axway SecureClient tries to open new sessions
until this value is reached, and then waits for a session to be available
instead of opening a new one.
Share Connection between GUI and Scheduler
When you select this check box, the connection pool is the same for the
Scheduler and the GUI. This option is applied separately for each site. The
total maximum simultaneous connection count will be exactly the
number specified in the Maximum simultaneous sessions parameter. If
42

TRANSFER PARAMETERS
you do not check this box, only the Schedulers simultaneous connection
count will be limited.
Transfer Parameters
Maximum transfer retry
Enter the maximum number of times that Axway SecureClient must
attempt to restart a failed transfer.
Delay before retry transfer
Enter the time (in seconds) that Axway SecureClient must wait before
attempting to restart a failed transfer.
Zip files before sending
Select this check box to automatically add files to a zip file before upload.
This option is available for upload only.
Unzip files after receiving
Select this check box to automatically unzip incoming zip files after
transfer. This option is available for download only.
Overwrite existing file
Select this radio button to automatically overwrite files that have the same
name as incoming files. This option is available for download only.
Rename existing file
Select this radio button to rename existing file by adding a number before
extension. For example, toto.txt is renamed toto1.txt. This
option is available for download only.
Dont download remote file
Select this radio button to prevent downloading remote files when a file
with the same name exists locally. This option is available for download
only
43

GRAPHICAL INTERFACE PARAMETERS
Graphical Interface Parameters

Schedule table size
Maximum number of lines displayed in the Schedule table with one job
per line. When the number of job records exceeds this value, a new page
is added.
Log table size
The maximum number of lines displayed in the Log table. When the
number of lines in the log exceeds this value, the oldest lines in the log are
no longer displayed.
Update frequency
The frequency with which the Schedule tab in the Main Window is
updated.
Remote folder auto-update delay
When a remote view of this site is visible, this is the period between automatic updates of the view. Increasing the frequency of automatic lists
guaranties that the view is up to date, but also increases the amount of data
exchanged between Axway SecureClient and the server. Set this value to 0
to disable this feature for all sites.
First day of week
Specify which day of the week should be considered the first day of the
week.
Format of dates
Select the format in which dates are displayed from the drop-down list.
Use AM/PM time display
Select this check box to use AM and PM as part of the time displayed.
Show site list at startup
Select this check box to display a list of sites you can connect to when you
start SecureClient.
44

DATE FORMAT DETECTION
Date Format Detection

Axway SecureClient provides functionality that automatically detects the date
format used by the remote server based on a list of formats that you can edit.
Date formats are represented by strings. You indicate date formats using the
following conventions:
Letter
Description
Example
Era
AD; BC
Year
1996; 96 (both indicate 1996)
yyyy
Year
1996; 96 (both indicate 1996)
Month in year
July; Jul; 07
Week in year
27
Week in month
Day in year
195
Day in month
15
Day of week in month
Day in week
Tuesday; Tue
AM/PM indicator
PM
Hour in Day (0-23)
Hour in Day (1-24)
24
Hour in am/pm (0-11)
Hour in am/pm (1-12)
12
Minute in hour
30
second in minute
55
Millisecond
954
General time zone
PST; GMT-08:00
RFC 822 time zone
-0880
45

SECURITY SETTINGS
Security Settings
Use Windows certificate store
Select this option to use certificates managed by Windows. This is available only for Windows Systems using Java 1.6. When activated, Security
Manager will browse Windows certificates directly.
Load JRE Root Certificate
Select this option to load Root certificates that are provided by and
managed by JRE.
Certificate Database password
Specify the password that protects the complete certificate database. This
is optional and is used in addition to private key password.
Use FIPS approved provider
Select this option to activate the use of a FIPS approved provider. This
option is available only if the product key is granted the FIPS option. If the
FIPS option is not granted, you cannot select the check box.
Working with Proxy Preferences

Use the Proxy tab to add a proxy or to edit, delete, or duplicate an existing proxy.
Proxy Dialog Box

You use the Proxy dialog box to specify the following parameters when adding
a new proxy or when editing an existing proxy.
Proxy Name
The name of the proxy. This is the name displayed in the list of proxies on
the Proxy Preferences tab and in the Security settings for all sites.
Proxy type
A drop down menu from which you select one of the following types:
46
SOCKS4
SOCKS5

WORKING WITH PROXY PREFERENCES
HTTP
FTP
Ident method
For HTTP Proxies, select the authentication method to be used when
connecting through this proxy. Choose one of the following:
Basic
NTLMUse NT Lan Manager authentication for this proxy.
Server address
Enter either the DNS name or the IP address of the proxy server to use on
connection.
Server port
Enter the IP port number of the proxy server to use on connection.
User Name
The user name to be used for authentication against the proxy.
User Password
The user password to be used for authentication against the proxy.
Domain
For HTTP proxies for which you select NTLM as the Identification
Method, specify the domain for the proxy to use when logging in to a
remote site.
FTP firewall
Select the method to connect through the proxy and to send user identification. Used when the proxy type is FTP.
Editing a Proxy
You use the Proxy Preferences window to edit a proxy.
TASK
1.
Click the Proxy tab on the Preferences window.

STEP RESULT: The Proxy tab displays a list of existing proxies.
2.
Select a proxy from the list, and then click Edit.

STEP RESULT: The Proxy dialog box appears.
3.
Edit the values in the dialog box as necessary, and then click Save.
47

WORKING WITH PROXY PREFERENCES
Adding a Proxy
You use the Proxy Preferences to add a proxy.
TASK
1.

2.
Click Add.
STEP RESULT: The Proxy dialog box appears.
3.
Enter the necessary information in the Proxy dialog box, and then click
Save.
Duplicating a Proxy
You use the Proxy Preferences to duplicate a proxy.
TASK
1.

2.
Select a proxy from the list.
3.
Click Duplicate.
STEP RESULT: The Proxy dialog box appears, but all the fields contain the date
from the proxy that you selected.
4.
Make any needed changes to the information in the Proxy dialog box,
create a new alias, and Save with the new name.
Deleting a Proxy
You use the Proxy Preferences tab to delete a proxy.
TASK
1.
Click the Proxy Preferences tab on the Preferences window.

2.
Select a proxy from the list, and then click Delete.

STEP RESULT: Axway SecureClient prompts you to confirm the deletion.
48

LOG MAINTENANCE SETTINGS
3.
Click OK.
STEP RESULT: The proxy is deleted from the list of existing proxies.
Log Maintenance Settings

Number of log archive
How many times the log files will be archived before the sequence restarts.
For example, if you select 3, the archive operation will rename the log file,
adding a number to the beginning of the file name three times. For
example, scheduler.log is the file in current use,
0scheduler.log is the oldest, 1schedular.log is newer than
0scheduler.log, 2scheduler.log is newer than
1scheduler.log. Then the sequence restarts.
Log archive frequency
How often log files will be archived. Choose from never, each day, each
week, or each month.
Purge schedule frequency
How often finished schedules should be purged. Choose from never, each
day, each week, or each month.
Purge schedule older than
How long old schedules are allowed to remain in the database before they
are purged. This property depends on the Purge schedule frequency. The
maximum age is taken when a purge is executed (defined by the purge
frequency). Purge is not triggered by a job that is older than the value in
this field. This value can be one day, one week, one month. In addition,
you can specify that all schedules be purged regardless of age.
49

SCHEDULER SETTINGS
Scheduler Settings
Maximum simultaneous running jobs
The number of transfers that can be running at the same time, using separate jobs. One job can contain several transfers or tasks. If the number of
schedules submitted exceeds this value, the schedules submitted most
recently will be delayed.
RMI Registry bind port
The port number on loopback interface (127.0.0.1) used to listen for
schedule requests. The default value is 1717.
Delay parameters
If binding the registry port fails, try to bind it again after this delay.
Check running jobs delay
The delay to periodically check running job state.
Resubmission delay for not started jobs
When the number of maximum simultaneous jobs is reached, this value is
the delay before trying to start a job in the queue again.
Reload configuration file delay
The time between updates of the configuration file.
Garbage collector parameters
Delay between calls by the schedule engine to the Java garbage collector.
This helps avoid memory leaks.
Collect tasks delay
Delay between attempts by the schedule engine to reuse memory from
finished tasks.
Collect unused connections delay
Delay between attempts by the schedule engine to close unused network
connection.
Debug parameters
Select this check box to enable schedule engine trace in log.
Network and configuration traces
Select this check box to enable network and configuration trace in log.
50

SECURETRANSPORT COMPATIBILITY SETTINGS
SecureTransport Compatibility Settings

You use these settings to help ensure compatibility with the command line
version of SecureTransport Client 4.5.1.
FTP Transfer mode
Specify whether you want to use passive or active mode for SecureTransport command line transfers if it has not been explicitly set using the
command line option.
General Proxy
Specify whether you want to use a proxy when transferring files using
SecureTransport Client compatibility mode. If you choose to use a proxy,
you must select a proxy from the drop down list. The drop down list is
populated with proxies you define using the Proxies settings screen.
When a Proxy is defined, stclient.cmd uses it by default unless
/prefNoProxy is added as an argument at the command line.
NOTE:
When a FTP transfer mode is defined, stclient.cmd uses it by default unless

/prefPASV or /prefPORT is added as an argument at the command line.
51

SECURETRANSPORT COMPATIBILITY SETTINGS
52
Exiting SecureClient
You can exit Axway SecureClient using any of the following methods:
Select Connection Exit. You exit the product, but the scheduler
continues running in background.
Select Connection Stop scheduler and Exit. You stop the scheduler and
exit the product.
Click the upper right X.
Stopping the scheduler stops all current transfers and all transfers scheduled for the future unless scheduler is restarted before the date and time of the
scheduled transfers.
NOTE:
53
EXITING SECURECLIENT
54
10
Batch Mode
The batch mode in Axway SecureClient enables you to automate transfers using
command line parameters or a script file. It can be used to send, receive, list,
rename, or delete server files, as well as to manage the remote or local directory
tree. Axway SecureClient batch mode is activated by command-line parameters
using one of the following syntaxes:
sclient [site] script [script file]
sclient [site] [command] {parameters}
sclient script [script file]
where:
[site] is an existing site in the configuration base which defines connection

parameters .
[command] defines the command to execute.
{parameters} are optional parameters of the given command.
[script file] is a text file that contains a list of commands to execute.
Script File Syntax

Script files are text files that contain a list of commands to execute. Only one
command per line is allowed.
A command is made up of the command name, or one of its aliases, followed by
its parameters. Each parameter is separated from the previous by a space character. Command parameters containing space characters must be enclosed
between " (double quote) characters.Comments can be added using the # character. A comment ends at the end of the line.
55
BATCH MODE
SCRIPT FILE SYNTAX
Script File Example 1

##################
echo Sample script
open server_site
cd remote_directory
put "local file" "remote file"
ls
close
Script File Example 2

This example shows how to use the mput and mget commands in periodic jobs
for the Scheduler.
open "site name"
# connect to remote server designated by "site name"
lcd localdir
# set local current dir to localdir
cd remotedir
# set remote current dir to remotedir
newjob
# begin a job definition
mget *.html
# get all html files from remotedir and store them in localdir
mget *.xml
# get all xml files from remotedir and store them in localdir
mput *.xls
# send all xls files from localdir and store them in remotedir
# do all tasks defined between newjob line and jobsubmit line
# beginning on 19 Jan 2010 at 12 noon# repeat every first day of
# month at 12 noon
# repeat 36 times (for 3 years)
jobsubmit "2010.01.19 12:00:00" "0 12 1 * *" 36
close
# close server connection
#All transfers between newjob and jobsubmit commands are executed
#as one and the same job. If you want to execute mget and mput
#operations (particularly in this case) as separate jobs, then
#each of them must be enclosed in newjob - jobsubmit statement.
56
11
Command List
Command Name
Alias
Usage
Session Management
open
Opens a session
close
Closes the current session
Remote Directory Management

list
dir, ls
Displays the contents of the remote

current directory
chdir
cd
Changes the current remote directory
cdup
Changes the current remote directory

to its parent
mkdir
md
Creates a remote directory
rmdir
rd
Removes a remote directory
delete
rm
Removes a remote file
rename
ren
Renames a remote file
pwd
Displays the current remote directory
Local Directory Management

llist
ldir, lls,
!list, !dir, !ls
Displays the contents of the current

local directory
lchdir
lcd, !chdir, !cd
Changes the current local directory
lcdup
!cdup
Changes the current local directory to

its parent
lmkdir
lmd, !mkdir, !md
Creates a local directory
57
COMMAND LIST
Command Name
Alias
Usage
lrmdir
lrd, !rmdir, !rd
Removes a local directory
ldelete
lrm, !delete,
!rm
Removes a local file
lrename
lren, !rename,
!ren
Renames a local file
lpwd
!pwd
Displays the local current directory
Transfer Management
get
Retrieves a file from server
put
Stores a file on server
mget
Retrieves multiple files from server
mput
Stores multiple files on server
Scheduler Commands
newjob
Starts a new job
jobsubmit
Submits the job started with the

newjob command
setdateformat
Specifies the format of the date read

by the jobsubmit command
Miscellaneous
58
echo
Displays a text line
script
Calls a script from the command line

or within a script file. It allows the
execution of more than one
command with only one connection.
Scripts are called recursively.
output
Produces files with Axway

SecureClient batch mode execution
trace.
quote
Allows you to use any FTP command

that does not use DATA connection.
COMMAND LIST
CDUP COMMAND
cdup Command
Description
The cdup command enables you to change the current remote working directory to its parent. The command is similar to the chdir command.
Syntax
cdup
Parameters
None
chdir command
Description
The chdir command enables you to change the current working directory on the
remote server. When used with no parameter, this command prints the current
directory, which is the same behavior as the pwd command.
Alias
cd
Syntax
chdir 'remote dir' or
cd remote dir
59
COMMAND LIST
CLOSE COMMAND
Parameters
remote dir
This parameter is the remote directory to change to. Depending on
servers, its path can be relative or absolute.
close Command
Description
The close command is used to close a connected session.
This command is not mandatory. An open command always closes the
connected session before opening a new one and close is automatically called at
the end of each script.
Syntax
close
delete Command
Description
The delete command deletes a file on the remote server.
Alias
rm
60
COMMAND LIST
DELETE COMMAND
Syntax
delete remote file
delete FILE PATTERN
Parameters
remote file
This parameter is the remote file to be deleted. Depending on servers, its
path can be relative or absolute.
FILE PATTERN
You can use the following wildcard characters: * (any string of characters),
? (any single character), [0-9], [A-Z], or [a-z] (range of characters).
You can also use the following additional patterns:
An ellipsis (...) within brackets ([...]) replaces any characters enclosed by


61
COMMAND LIST
ECHO COMMAND
echo Command
Description
The echo command can be used to display a text line on the standard output and
in an output file specified by a previous output command. The echo command
adds a newline character at the end of the line.
Syntax
echo 'text'
Parameter
text
The text to display.When the echo command is used with no parameter,
the command produces an empty line.
Example
The following script is stored in the file named echo_sample.txt:
echo display Synchrony Gateway FTP server help for site command
echo using quote command
quote help site
Executing this script using the following command:

sclient site script echo_sample.txt
produces an output similar to the following:

display Synchrony Gateway FTP server help for site command
using quote command
214-Specific XFB FTP commands.
214214-SITE <sp> <Keyword_1> <sp> <Value_1>[;...;<Keyword_n> <sp>
<Value_n>]
214214-The valid keywords are:
214- P_CLIENT - client type.
214- P_APPLI - application name.
214- P_DEST - transfer destination site name.
62
COMMAND LIST
GET COMMAND
214- P_ORG - transfer origin site name.

214- P_LRECL - LRECL of file to be send.
214- P_RECFMT - Fix <F> or Variable <V> file format.
214- P_MSG - User message, up to 40 bytes long.
214- FTPCS - client_version_number, XFB ftp server respond all
of allowed command/parameters
214214 End of 'help site' command
get Command
Description
The get command is used to retrieve a file from a server. It can retrieve files in
text or binary mode.
Syntax
get REMOTE FILE [LOCAL FILE] [BIN|TEXT] [UNIQUE|OVERWRITE]
Parameters
REMOTE FILE (mandatory parameter)
This parameter is the name of the file to retrieve. When used with a
Synchrony Gateway server, it has three possible notations:
s<nnn>.xxxxx: the complete Synchrony Gateway name (nnn: digit, xxx:

alphanumeric)
xxxxx: the short Synchrony Gateway name (xxx: alphanumeric)
nnn: the Synchrony Gateway local_identifier
LOCAL FILE
This parameter is the local file name of the file to retrieve. It is an optional
parameter. If it is not supplied, it takes the same value as the REMOTE
FILE parameter.
BIN or TEXT
63
COMMAND LIST
GET COMMAND
This parameter is used to force file encoding. If no value is supplied, the

text file pattern rule is used to determine file transfer mode.
BIN: the file data will not be encoded and will be saved as a byte stream.
TEXT: the file data will be saved as a text file (line stream, lines ending
with CR or CRLF ASCII characters depending on your operating system).
UNIQUE
This parameter can be used to avoid overwriting an existing file with a new
one. When this parameter is supplied Axway SecureClient will rename the
incoming file by appending a number at the end of the file name.
OVERWRITE
This parameter causes the local file to be overwritten with the remote file.
The default behavior in case of an existing local file with the same name is
to skip the transfer and not download the remote file. Check the preferences
section for more options.
NOTE:
Example
get 'remote file' 'locfile' unique
If locfile already exists, then remote file will be retrieved as locfile_1,

then as locfile_2, and so on.
Example 2
open "sitename"
lcd C:\tmp
cd /
newjob
get /remotedir/file.txt newname.txt TEXT UNIQUE
jobsubmit
close
64
COMMAND LIST
JOBSUBMIT COMMAND
jobsubmit Command
Description
For use with the Scheduler.
The jobsubmit command submits the job started with the newjob command.
The job is submitted either immediately or at the date specified in the date
parameter.
Syntax
jobsubmit [date] [timing information] [number of iterations | job end date]
Parameters
date (optional parameter)
This parameter represents the job start date in the format:
"yyyy.MM.dd HH:mm:ss"
The date format can be changed using the setdateformat command.

timing information (optional parameter)
For periodic jobs, this parameter provides timing information to the
Scheduler in Crontab syntax.
number of iterations (optional parameter)
This parameter specifies the number of times to repeat a periodic job. If
the parameter is omitted, the job is repeated an infinite number of times.
job end date (optional parameter)
This parameter represents the date the job will end in the format:
"yyyy.MM.dd HH:mm:ss"
The date format can be changed using the setdateformat command.
Examples
jobsubmit "2008.01.19 12:00:00" "0 12 1 * *" 36
65
COMMAND LIST
LCDUP COMMAND
This example submits the job at 12 noon on January 19, 2008. The job is
repeated at 12 noon on the first day of every month. The job is repeated 36 times
(in other words, for 3 years).
lcdup Command
Description
The lcdup command changes the current local working directory to its parent.
The command is similar to the lchdir .. command.This command has no
parameters.
Alias
!cdup
Syntax
lcdup
lchdir Command
Description
The lchdir command changes the current local working directory.
When used with no parameter, it sets the current working directory to the directory from which Axway SecureClient was started.
66
COMMAND LIST
LDELETE COMMAND
Alias
lcd, !chdir, !cd
Syntax
lchdir 'local dir'
Parameters
local dir
This parameter is the local directory to change to. Its path can be relative
or absolute.
ldelete Command
Description
The ldelete command deletes a local file.
Alias
lrm, !delete, !rm
Syntax
ldelete 'local file', FILE PATTERN
Parameters
local file
This parameter is the local file to be deleted. Its path can be relative or
absolute.
67
COMMAND LIST
LIST COMMAND
FILE PATTERN
You can use the following wildcard characters: * (any string of characters),
? (any single character), [0-9], [A-Z], or [a-z] (range of characters).
You can also use the following additional patterns:
An ellipsis (...) within brackets ([...]) replace any characters enclosed by


list Command
Description
Use the list command to browse files on a server and browse Transfer Requests
with a Synchrony Gateway server.
Alias
dir, ls
Syntax
list [path]
list Q_[FILTER] for FTP only
68
COMMAND LIST
LIST COMMAND
Parameters
path
The path to the file or directory to be listed.
FILTER
For FTP, you can use a filter with the list command. Use of the filter
depends on the remote server capabilities. When used with a Synchrony
Gateway server, it can filter remote file names, transfer dates, and transfer
states.
File names can be filtered using a string with the * wildcard at the end of
the string. So the string file* will filter file names beginning with the
string file. The file name filter must be at the start of the filter string. Dates
can be filtered with one of the following possible values:
_CH: filter file transfers of the Current Hour
_CD: filter file transfers of the Current Day
_CM: filter file transfers of the Current Month

States can be filtered with one of the following possible values:
_FH: filter file transfers available for download (get)
_FI: filter file transfers retrieved successfully
_FJ: filter file transfers sent successfully
_FK: filter file transfers not retrieved successfully (error)
_FL: filter file transfers not sent successfully (error)
Example
list Q_file*_CD_FJ
For a Synchrony Gateway FTP server, this command filters files beginning with
the string file, that have been transferred successfully during the current day.
69
COMMAND LIST
LLIST COMMAND
llist Command
Description
The llist command displays the current local directory contents.
Alias
ldir, lls, !list, !dir, !ls
Syntax
llist
Parameters
None
lmkdir Command
Description
The lmkdir command creates a directory locally.
Alias
lmd, !mdir, !md
Syntax
lmkdir 'local directory or lmdir local_dir_name
70
COMMAND LIST
LPWD COMMAND
Parameters
local directory
The name of the local directory to create. Its path can be relative or absolute.
lpwd Command
Description
The lpwd command displays the full path of the current local working directory.
Alias
!pwd
Syntax
lpwd
Parameters
None
71
COMMAND LIST
LRENAME COMMAND
lrename Command
Description
The lrename command renames a local file.
Renaming can only be performed in the current directory.
Alias
lren, !rename, !ren
Syntax
lrename 'original filename' 'new filename'
Parameters
original filename
This parameter is the name of the file to be renamed.
new filename
This parameter is the new file name.
lrmdir Command
Description
The lrmdir command deletes a local directory.
Alias
lrd, !rmdir, !rd
72
COMMAND LIST
MGET COMMAND
Syntax
lrmdir 'local dir'
Parameters
local dir
This parameter is the local directory to be deleted. Its path can be relative
or absolute.
mget Command
Description
The mget command is used to retrieve multiple files from a remote server directory and store them in the current local directory.
Syntax
mget FILE PATTERN
Parameters
FILE PATTERN (mandatory parameter)
This parameter defines the remote files to be retrieved. You can use the
following wildcard characters:
* (any string of characters)
? (any single character)
[0-9], [A-Z] or [a-z] (range of characters)
[...] replaces any characters enclosed by the brackets. The asterisk (*) and
question mark (?) lose their special meanings within a character class. If
the first character following the opening bracket is an exclamation mark
(!) or a caret (^), then any character not in the character class is matched.
73
COMMAND LIST
MKDIR COMMAND
A hyphen (-) between two characters can be used to denote a range. A

hyphen (-) at the beginning or end of the character class matches itself
rather than referring to a range. A close bracket (]) immediately following
the opening bracket ([) matches itself rather than indicating the end of the
character class. Otherwise, it must be escaped with a backslash (\) to refer
to itself.
\ matches itself in most situations. However, when a special character such

as an asterisk (*) follows it, a backslash escapes the character, indicating
that the special character should be interepeted as a normal character
instead of having its special meaning.
Examples
mget *.html # get all html files from remotedir (the current
remote directory) and store them in localdir (the current local
directory)
mget *.xml # get all xml files from remotedir (the current remote
directory) and store them in localdir (the current local
directory)
mget [0-9]*.xml # get all xml files, with a name starting with a
digit, from remotedir (the current remote directory) and store
them in localdir (the current local directory)
mkdir Command
Description
The mkdir command creates a directory on the server.
Alias
md
Syntax
mkdir 'remote directory or mkdir remote_dir_name
74
COMMAND LIST
MPUT COMMAND
Parameters
remote directory
This is the name of the remote directory to create. Depending on servers,
its path can be relative or absolute.
mput Command
Description
The mput command is used to upload multiple files from the current local
directory and store them on a remote server directory.
Syntax
mput FILE PATTERN
Parameters
FILE PATTERN (mandatory parameter)
This parameter defines the files to be stored. You can use the following
wildcard characters:
* (any string of characters)
? (any single character)
[0-9], [A-Z] or [a-z] (range of characters)
[...] replaces any characters enclosed by the brackets. The asterisk (*) and
question mark (?) lose their special meanings within a character class. If
the first character following the opening bracket is an exclamation mark
(!) or a caret (^), then any character not in the character class is matched.
A hyphen (-) between two characters can be used to denote a range. A
hyphen (-) at the beginning or end of the character class matches itself
rather than referring to a range. A close bracket (]) immediately following
the opening bracket ([) matches itself rather than indicating the end of the
character class. Otherwise, it must be escaped with a backslash (\) to refer
to itself.
75
COMMAND LIST
NEWJOB COMMAND
\ matches itself in most situations. However, when a special character such

as an asterisk (*) follows it, a backslash escapes the character, indicating
that the special character should be interepeted as a normal character
instead of having its special meaning.
Examples
mput *.xls # send all xls files from localdir (the current local
directory) and store them in remotedir (the current remote
directory)
mput [A-Z]*.xls # send all xls files, with a name starting with
an upper-case letter, from localdir (the current local
directory)and store them in remotedir (the current remote
directory)
newjob Command
Description
The newjob command starts a new job.
All the get, put, mget, mput, mkdir and lmkdir commands that follow the
newjob command, up to the next jobsubmit command, are added to the job.
As a job is related to a site, an open command must be used before the newjob
command. The open and close commands cannot be used between the newjob
command and the next jobsubmit command.
Syntax
newjob [name] [description]
Parameters
Name
The job name.
76
COMMAND LIST
OPEN COMMAND
Description
A description of the job.
Optional parameter
Batch Job used by default when no name is set.
open Command
Description
The open command opens a new session with a remote server that is defined by
its alias in the site database.
If reciprocal authentication is requested, some extra security parameters are
necessary.
Syntax
open [site alias]
or
open [site alias] {-kpwd private key password}
or
open [site alias] {-params private key password file}
Parameters
site alias
The alias of the site to connect to.
-kpwd
If reciprocal authentication is requested, Axway SecureClient requires a
password to access the private key that corresponds to the personal certificate to send. You can enter it directly in the open command with this
parameter. Remember that in the command line the password is visible on
the screen.
77
COMMAND LIST
OUTPUT COMMAND
-params
The function of this parameter is the same as the previous one. But with
this parameter, you do not enter the password directly. You indicate a file
where the password is stored. This file must be a Java properties file, and
must contain the following line:
UserKeyPwd='password'
Important security note

The best way to guarantee the confidentiality of a private key is to keep its password secret. So, it should not be displayed on screen, or saved in a file.
Therefore, never to use -kpwd or -params on the command line. They are
designed to be used in scripts.
output Command
Description
The output command is used to produce files with Axway SecureClient batch
mode execution trace.
The output command can be used several times in one script. This allows you
to produce an output file for each command individually. Output files are
created and truncated as needed. A second call to the output command always
ends the previous one and closes the output file associated with the first
command.
When the output command is used, all command traces are written to both the
terminal (if any) and the output file supplied by the last output command.
The main difference between the output command and using a shell redirection
(using the > character) is that it is possible to give separate files for each
command.
Syntax
output 'OUTPUT FILE'
78
COMMAND LIST
PUT COMMAND
Parameters
OUTPUT FILE (mandatory parameter)
This parameter is used either to supply a file to store traces, or to close the
file of the previous output command by giving the special value 'null'.
put Command
Description
The put command is used to store a file on a server. It can store files in text or
binary mode.
Syntax
put LOCAL FILE [REMOTE FILE] [GWPARAM(s)=value] [BIN|TEXT]
Parameters
LOCAL FILE (mandatory parameter)
This parameter is the local file name of the file to store.
REMOTE FILE
This parameter is the remote name of the file to store. If it is not supplied,
it takes the same value as the LOCAL FILE parameter.
GWPARAM(s)
GWPARAM(s) are Synchrony Gateway specific parameters. These
parameters are optional and can be supplied in the Site definition. If a
parameter is supplied by both the Site object and put command, the put
command takes precedence over the Site object.
There are four possible parameters:
appli: This parameter supplies a Synchrony Gateway Application object

name. The server uses the Application to format the file (character
encoding, record encoding, compression, padding, and so on).
org: Synchrony Gateway uses this parameter to determine the file origin.
79
COMMAND LIST
PWD COMMAND
dest: Synchrony Gateway uses this parameter to determine the file destination.
msg: This parameter is a text message that Synchrony Gateway stores and
associates with the file. This parameter can be used for user application
purpose.
Refer to the Synchrony Gateway documentation for more information on
these parameters.
BIN or TEXT
This parameter is used to enforce file encoding. If no value is supplied,
then the text file pattern rule is used to determine file encoding.
BIN: the file data will not be encoded and will be saved as a byte stream.
TEXT: the file data will be saved as a text file (line stream, line ending CR,
LF, or CRLF ASCII character depending on your operating system).
pwd Command
Description
The pwd command displays the full path name of the current remote working
directory.
Syntax
pwd
Parameters
None
80
COMMAND LIST
QUOTE COMMAND
quote Command
Description
The quote command is a generic command that allows you to use any FTP
command that does not use DATA connection.
The STOR, RETR and LIST commands cannot be transmitted by a quote
command. Use a get, put, or list command instead.
NOTE:
Syntax
quote 'FTP command' <command parameters>
Parameters
FTP command
This parameter is the FTP command as it will be sent on the network
connection.
Command parameters
These parameters are the FTP command parameters as they will be sent
on the network connection. Each parameter is separated from the
previous one by a space character.
Examples
The following command displays the result of the help command on a
Synchrony Gateway server.
> sclient site quote help
quote help
214-Get help (* => not implemented). Syntax: 'HELP [<sp>
command]'
214214- USER PASS ACCT CWD XCWD *CDUP *XCUP *SMNT
214- REIN QUIT PORT PASV MODE TYPE STRU ALLO
214- REST STOR STOU RETR LIST NLST APPE *RNFR
214- *RNTO *DELE *RMD *XRMD *MKD *XMKD PWD XPWD
214- ABOR SYST STAT HELP SITE NOOP SIZE MDTM
214- FEAT
214-
81
COMMAND LIST
RENAME COMMAND
214-The transfer mode may be

214- S(tream), B(lock) or C(ompressed).
214214-The representation type may be214- A(scii), E(bcdic) or
I(mage).
214214-The file structure may be
214- F(ile) or R(ecord structure).
214214 End of help messageThe following command displays the result
of the help site command on a Synchrony Gateway server.
> sclient site quote help sitequote help site
214-Specific XFB FTP commands.
214214-SITE <sp> <Keyword_1> <sp> <Value_1>[;...;<Keyword_n> <sp>
<Value_n>]
214214-The valid keywords are:
214- P_CLIENT - client type.
214- P_APPLI - application name.
214- P_DEST - transfer destination site name.
214- P_ORG - transfer origine site name.
214- P_LRECL - LRECL of file to be send.
214- P_RECFMT - Fix <F> or Variable <V> file format.
214- P_MSG - User message, up to 40 bytes long.
214- SCLIENT - client_version_number, XFB ftp server respond all
of allowed command/parameters
214214 End of 'help site' command
rename Command
Description
The rename command renames a file on the remote server.
Renaming can only be performed in the current directory.
Alias
ren
82
COMMAND LIST
RMDIR COMMAND
Syntax
rename 'original filename' 'new filename'
Parameters
original filename
This parameter is the name of the file to be renamed.
new filename
This parameter is the new file name.
rmdir Command
Description
The rmdir command deletes a directory on the remote server.
Alias
rd
Syntax
rmdir 'remote dir'
Parameters
remote dir
This parameter is the remote directory to be deleted. Depending on
servers, its path can be relative or absolute.
83
COMMAND LIST
SCRIPT COMMAND
script Command
Description
The script command is used to call a script from the command line or within a
script file. It executes multiple commands with only one connection. Scripts are
called recursively. At the end of a called script, the calling script continues
execution after the script command.
A script can call itself recursively. In that case, recursion will only stop
when the system runs out of memory.
NOTE:
Syntax
script 'SCRIPT FILE'
Parameters
SCRIPT FILE
A text file that contains a list of Axway SecureClient commands. It must
contain only one command on each line. Comments can be added in the
script file using the # character.
Example
The following script is stored in the file named sclient_script1.txt:
#send file1 with some Gateway-specific parameters
put file1 appli=FTP_B org=sclient dest=company msg=filemessage
echo Inside sclient_script1.txt, before entering
sclient_script2.txt
#call the other script
script sclient_script2.txt
echo After exiting sclient_script2.txt, inside
sclient_script1.txt list file*_CD
# The following line calls another scriptscript
sclient_script2.txt
sclient site script sclient _script1.txt
84
COMMAND LIST
SETDATEFORMAT COMMAND
sclient_script2.txt:
echo Inside sclient_script2.txt
# retrieve the file, that was sent by sclient_script1.txt
get file1 file2
and then the output will be (with sclient_script2 execution displayed):

put file1 appli=FTP_B org=sclient dest=company msg=filemessage
Complete
Inside sclient_script1.txt, before entering sclient_script2.txt
Inside sclient_script2.txt
get file1 file2
Complete
After exiting sclient_script2.txt, inside sclient_script1.txt
setdateformat Command
Description
The setdateformat command specifies the format of the date read by the
jobsubmit command.
Syntax
setdateformat <date format>
Parameters
date format
This parameter specifies the format of the date read by the jobsubmit
command. This is the format used by the java.text.SimpleDateFormat Java
class.
For information about the SimpleDateFormat Java class, go to:
http://java.sun.com/javase/6/docs/api/java/text/SimpleDateFormat.html
85
COMMAND LIST
SETDATEFORMAT COMMAND
86
12
SecureTransport Client
Legacy Mode
This chapter lists and describes commands from SecureTransport Client that
are compatible with Axway SecureClient 5.6. Also included in this chapter are
sample commands.
Command-line options
The following command line options from SecureTransport Windows client
4.5.2 are supported by Axway SecureClient 5.6.
Command Line Option
Description
/prefASC
If this option is used, it does the following:If you are

downloading a file from a UNIX host, this option
converts any linefeeds (ASCII 10, hex 0A) into carriage
return or linefeed pairs (ASCII 13/10, hex 0D/0A).If you
are uploading a file to a UNIX host, this option converts
carriage return or linefeed pairs into linefeeds. This
option overwrites any options selected on site level (if
used with /remote-site) for the current session.
/prefASCExt "list of
ASCII extensions"
Use this option to specify a list of file extensions for

which text-mode transfer must be used (see under
/prefASC).Each extension must be prefixed with a
period, the extensions must be separated with commas
(no spaces), and the entire list should be surrounded by
double quotes. For example: ".txt,.log,.html,.htm"
/prefAskSched
Use this option to prompt for schedules by displaying

the Schedule dialog box when a file transfer is initiated.
/prefBinary
Use this option to perform an exact byte-by-byte copy of

the file. This option overwrites any options selected on
site level (if used with /remote-site) for the current
session.
87
SECURETRANSPORT CLIENT LEGACY MODE

COMMAND-LINE OPTIONS
Command Line Option
Description
/prefExpand
If a compressed file is downloaded and the

corresponding decompression utility is installed in the
client machine, use this option to launch the
decompression utility. Refer to the documentation of the
decompression program to know how extraction is
handled and where the extracted files are placed after
decompression.
/prefFireType n
Use this option to specify the firewall type to be used.

The valid values for n, and the firewall types to which
they correspond, are:
0 USER userID@Host
1 USER fireID | PASS firePW | USER userID@host
2 SITE host
3 OPEN host
4 USER userID@fireID@host | PASS
userPW@firePW
5 USER fireID@host | PASS firePW
6 USER userID@host fireID | PASS userPW | CCT
firePW
For example, if you are using a firewall that prompts for
the user's firewall login, followed by the user's firewall
password and the hostname login information, use the
following option: /prefFireType 1
88
/prefForceSec
This option is applicable only to FTP connections. Use

this option to specify the use of secure connections.
/prefFriendFire
This option is applicable only to FTP connections. Use

this option to specify the use of firewall-friendly FTP
connections.
/prefNoAskSched
Use this option to suppress the prompts for schedules

before initiating a file transfer.
/prefNoExpand
If this option is used, compressed files that you

download are placed in the target directory and the
decompression program is not launched.
/prefNoForceSec
Using this option allows both secure and non-secure

FTP connections.
/prefNoFriendFire
This option is relevant only for secure FTP connections.

Non-secure FTP and HTTP connections are not
affected. This option disables the use of firewall-friendly
FTP connections.

Command Line Option
Description
/prefNoProxy
This option disables the option to connect to a remote

server through a proxy server or firewall.
/prefNoUploadCompress
Use this option if you want to upload a file without

compressing it first.
/prefOverwrite
For a download, if a file with the same name (but with

different contents) exists in the target directory,
SecureTransport overwrites it with the contents of the
transferred file.Note: If the file already exists in the
target directory and has the same contents as the file you
are downloading, Axway SecureClient detects this and
does not transfer the file.
/prefPASV
This option forces the server to suggest the port to be

used for transmission of FTP data.
/prefPORT
If this option is used, the client provides the port to be

used for transmission using FTP.
/prefProxy
This option allows to set the proxy server parameters.

Proxy server parameters cannot be set or changed from
the command line (except for FTP firewall type, which
controls the order and syntax in which it accepts user
login information. For details, see /prefFireType in this
table). You can also configure the proxy for the
SecureClient Preferences.
/prefRetries n
This option specifies the number of times a file transfer

must be attempted in the event of a file transfer failure. A
value of 0 disables this option. The minimum value must
be set to 1 to enable this option.
/prefUnique
Use this option if you do not wish to overwrite the local

file when downloading the same file from a remote site.
SecureTransport downloads the remote file to the local
folder as filename.<N>.extension, where <N> is a
numeric value in the range 0-9999.For example, if
HelloWorld.txt exists on both the local and remote
folders, SecureTransport downloads the remote file as
HelloWorld.0.txt. The local file remains unchanged. if
you download it again, the new copy is named
HelloWorld.1.txt; and so forth.
/prefUploadCompress
Use this option if you want to compress a file before

uploading it.
89

Command Line Option
90
Description
/cmdlineDebugFile
file
This option appends the command line to the given file,

as it is executed (that is, with variables resolved to their
values). This can be used to debug what is being passed
into the command line. For example, stclient.cmd
/cmdlineDebugFile c:\temp\cmdline.txt
/deleteAllReceived
This option deletes all log entries for transfers received

on the client machine. This is equivalent to
/deleteReceived 0.
/deleteAllSent
This option deletes all log entries for transfers sent from
the client machine. This is equivalent to /deleteSent 0.
/deleteReceived n
This option deletes all log entries for transfers received

on the client machine n days ago and earlier. For
example, /deleteReceived 1 deletes all log entries for
transfers received before the current date.
/deleteSent n
This option deletes all log entries for transfers sent from
the client machine n days ago and earlier. For example,
/deleteSent 1 deletes all log entries for transfers sent
before the current date.
/move
This option performs a move operation on the specified

files or folders. After the transfer is completed, the files
or folders are removed from the source directory and
placed in the destination directory. However, If you
move a recursive folder or specify a wildcard
combination to specify the folders to be moved, the
folders are not removed from the source directory
(empty folders are retained at the source directory after
completion of transfer).
/progress
This option opens the main window of SecureClient.
/quit
This option terminates the Axway SecureClient if it is

currently running. Use this option with caution, because
it will stop the client immediately and halt all transfers,
including any that are currently running.
/quitWhenDone
This option terminates the Axway SecureClient when all

transfers are completed.
/RemoveOnError
This option removes the task from the Transfer Queue if

an error occurs for a transfer after exceeding the number
of retries specified using one of the following:Scheduling
tab of the Preferences dialog box/prefRetries
command-line option.

Command Line Option
Description
/schedule "date time"
This option schedules a transfer for a later time. The

format for date is m/d/[yy]yy, and the format for time is
h:mm[AM/PM]. For example, the following
command-line fragments are all equivalent:
/schedule "5/15/10 1:00PM"
/schedule "05/15/10 13:00"
/schedule "5/15/2010 01:00PM"
Note: There is no command-line equivalent for repeat or
limit schedules.
/statusBAT
filename.bat
This option creates a batch file to capture the return

status of the session. The file pointed at, filename.bat is
deleted each time the transfer state of the Axway
SecureClient changes, and filename.bat is automatically
recreated with the following lines:
set SecureTransportStatus=SecureTransportStatus
set FileDriveStatus=FileDriveStatus
del filename.bat
where FileDriveStatus is one of the following values:
DONE-Transfer is done
ACTIVE-Transfer is active
STOP- Transfer has been stopped
INVALID-The URL or local path is invalid
ERROR-An error has occurred
WAITING-Waiting to re-transfer
NOTEXIST-Cannot find the source file(s) to be
transferred
You can execute the Axway SecureClient from a batch
file and use the value of FileDriveStatus or
SecureTransportStatus to control a loop that retries a file
transfer till the transfer is performed completely.
/Remote-Site
This option is used to extract the following parameters

from the site (called as profile in earlier versions):
User name
Password
Certificate settings specified for the site
Email notification settings
Remote server type
Compliance of FTPs PASV mode with RFC
Data transfer mode
HTTP identification method
91

RESERVED CHARACTERS FOR URLS OR PATHS
Reserved Characters for URLs or Paths

You must not use the characters listed in the following table in a URL or a path
you specify using command-line options. These characters are reserved and you
must substitute the characters with the appropriate character combination to
use them in URLs or paths.
Reserved Character
Substitute Characters
%3B
%2C
%2F
%3F
%3A
%40
&
%26
%3D
blank space character
%20
For example, if the user name is user1@example, password is password@example, address is my.example.com, and path is /my folder/my?file, you
must supply the URL as follows:
ftp://user1%40example:password%40example%40my.exampl
e.com/my%20folder/my%3Ffile
To use the substitute characters (without making them a substitute for the
reserved characters) as such in URLs or paths, you must prefix a % (percentage)
symbol before the substitute characters.
For example, if you want to specify %40 in the URL, without making it a substitute for @, you must specify %40 as %%40
92

EXAMPLES OF COMMAND-LINE COMMANDS
Examples of Command-line commands

Following are examples of the /Remote-Site command and its description:
For each example, ensure that the command given is typed in one line.
stclient.cmd ftpu:<URL> <File Path> /prefASC /prefRetries 50
The command shown in the previous example performs a file upload using the
FTP protocol and requires you to supply a valid user name and password. The
options given in angled brackets (< >) have to be substituted with the respective
option provided in the following table.
The following are the options passed to the command-line command.
Option
Description
stclient.cmd
Name of the executable file to start Axway

SecureClient.
ftpu
This option specifies the FTP upload

instruction.
Substitute <URL> with the following:

//username:password@hostname:p
ort/homedir/user/
This option specifies the source FTP server

identification, port, and user name.
Substitute <File Path> with the following:

c:\temp\filename.txt
Name of the file to upload.
prefASC
This option converts carriage return or

linefeed pairs into linefeeds if the file is
uploaded to a UNIX host.
prefRetries 50
This option sets the number of retry

attempts for the file transfer to 50.
stclient.cmd ftpu://192.168.112.95:21/ <File Path>

/prefNoAskSched /quitWhenDone /progress /Remote-Site
Axway
The command shown in the previous example uploads a file using the FTP
protocol and does not require you to supply the user name and password. The
Remote-Site command extracts the user name and password automatically
from the site used, which is specified as Axway in the command.
The following are the options passed to the command-line command:
93

ST CLIENT BATCH FILE SAMPLES
Option
Description
stclient.cmd
Name of the executable file to start Axway

SecureClient 4.5.1.
prefNoAskSched
This option disables the dialog box that

prompts for a schedule before initiating a file
transfer.
quitWhenDone
This option terminates the Axway

SecureClient when all transfers are completed.
progress
This option enables the file-transfer progress

window.
Remote-Site
This command extracts the site-specific

parameters from the remote FTP site.
ftpu
This option specifies the FTP upload

instruction.
Substitute <File Path> with the following:

c:\upload\logs.txt
Name of the file to upload.
ST Client batch file samples

The following sections contain sample batch files that can be used to:
Verify the file transfer status-transfer.bat
Perform multiple upload of files-runjobs.bat
Sample batch file to verify file transfer status

The file, transfer.bat, which verifies the file transfer status can be scripted
in the following way:
NOTE:
In the following sample batch file, sections in boldface must be typed in one
line.
@echo off
set statusbat=%3
94

del %statusbat%
call C:\Progra~1\Axway\STClient\stclient.cmd %1 %2 /prefPORT /prefNoAskSched /prefRetries 2 /statusBAT %statusbat%
echo off
:mainloop
if NOT EXIST %statusbat% goto mainloop
call %statusbat%
echo "status.bat returned status of" %FileDriveStatus%
if '%FileDriveStatus%'=='ACTIVE' goto mainloop
goto checkbatf
:dodelete
echo "Status not deleted ...."
del %statusbat%
:checkbatf
if EXIST %statusbat% goto dodelete
echo "status deleted ..."
rem Terminate loop if done or if an error condition is reported.
if '%FileDriveStatus%'=='DONE' goto done
if '%FileDriveStatus%'=='ERROR' goto error
if '%FileDriveStatus%'=='STOP' goto stop
if '%FileDriveStatus%'=='INVALID' goto invalid
if '%FileDriveStatus%'=='NOTEXIST' goto notexist
echo "BAD STATUS"
exit -4
:done
echo "Status=DONE"
goto finished
:notexist
echo "Status=NOTEXIST"
goto finished
95

:error
echo "Status=ERROR"
goto finished
:stop
echo "Status=STOP"
goto finished
:invalid
echo "Status=INVALID"
goto finished
:finished
echo "transfer.bat completed"
Sample batch file to perform multiple file transfers

@echo off
REM Upload using https
start C:\transfer.bat
httpsu://<user>:<passwd>@<host>:<port>/home/<user>/ C:\file.txt
/statusBAT C:\result1.bat
REM download using https
https://<user>:<passwd>@<host>:<port>/home/<user>/file.txt C:\
/statusBAT C:\result2.bat
REM Upload using ftp
start C:\transfer.bat ftpu://<user>:<passwd>@<host>:<port>/home/<user>/
C:\file.txt /statusBAT C:\result3.bat
REM download using ftp
ftp://<user>:<passwd>@<host>:<port>/home/<user>/file.txt C:\ /statusBAT
C:\result4.bat
96
13
Exit Codes
In batch mode, Axway SecureClient exits with a numeric code. Batch mode
stops script execution when the first error condition is reached.
The exit codes are:
Code
Meaning
All commands ended without error
Connecting site is unknown
Invalid command
Syntax error or script execution error
Protocol error
97
EXIT CODES
98
14
Authentication
SSL-based secured file transfers use the concept of authentication: we want to

be sure who we are communicating with. Axway SecureClient supports X.509
certificates and SSH authentication mechanisms.
X.509 Certificate Authenthication

Axway SecureClient supports authentication using X.509 certificates. X.509
specifies, among other things, standard formats for public key certificates,
certificate revocation lists, attribute certificates, and a certification path validation algorithm. The certification path validation algorithm is the algorithm
which verifies that a given certificate path is valid under a given public key infrastructure (PKI). A path starts with the Subject certificate and proceeds through
a number of intermediate certificates up to a trusted root certificate, typically
issued by a trusted Certification Authority (CA). A certificate can only be verified using the certificate of its issuer.
When an entity delivers its certificate to be authenticated, it must send it with
the whole certification chain that leads to the root authority certificate. Its
correspondent checks it by using the certificate of the authority that signed it,
back to the root certificate. The only way to verify the root certificate is to actually know the authority and to trust it. You can only verify the certificate using
itself. In fact, you verify it by using a reference certificate you already have. This
is what trusting an authority means: having its certificate and knowing it can be
trusted. In Axway SecureClient, three categories of entities are considered in the
database:
Trusted authorities: These are the authorities that have been chosen as
trusted. The choice is based on the certificate type. Self-signed certificates
go into the trusted store.
Intermediate authorities: These certificates are used by the client to verify

the server's identity by building certification chain between the server and
the trusted authority.
99
AUTHENTICATION
SSH KEY-BASED AUTHENTICATION
Personal: These entities can be authenticated by a server. Getting authenticated means two things. First, presenting a valid certification chain
leading to a trusted root authority. Second, proving that you possess the
corresponding private key by using it to sign a defined piece of data. To do
this, Axway SecureClient must have the corresponding private key. Thus,
a user entry of the certificate database is a certificate with its private key.
Such a certificate is also called a "personal" certificate.
SSH Key-based Authentication

Axway SecureClient supports SSH key-based authentication. SSH key-based
authentication authenticates the remote server and allows the remote server to
authenticate the user.
In SSH key-based authentication, keys are generated in matching pairs
consisting of a public key and a private key. When the user attempts to access
the remote server using its private key for authentication, it encrypts a small
buffer with its private key and sends the result accompanied by its public key to
the server that can decrypt it and thus trust it.
100
15
Exit Classes
Axway SecureClient provides a mechanism that allows you to personalize SSL

security behavior. To perform this, you can give Java implementations of the
three predefined interfaces:
sopra.atljava.security.exit.ssl.SSLSessionListener,
sopra.atljava.security.exit.ssl.SSLPeerAuthListener, or
sopra.atljava.security.exit.ssl.SSLUserAuthListener
Note that several of these interfaces can be implemented in the same class. Each
of these implementations will be called at predefined points in the SSL authentication automaton to allow you to override the internal mechanisms. Thus, it
is possible to implement mechanisms to support a smart card, or to get the
certificates from a network or an LDAP directory, for instance. If the implementation decides to override a mechanism, it must be entirely overridden, from the
beginning to the end.
SSLSessionListener
This interface is responsible for handling the global SSL session. It is called at
the end of the handshake to validate the negotiated parameters, and is notified
of session errors.
SSLPeerAuthListener
This interface is responsible for handling the authentication of the remote
server. It is called to verify its certification chain, and to handle its public key.
101
EXIT CLASSES
SSLUSERAUTHLISTENER
SSLUserAuthListener
This interface is responsible for the authentication of the local user. It provides
SSL with its certification chain, and is called to manage the corresponding
private key. The implementing classes must be given to Axway SecureClient
with their complete Java name (for example com.client.ftpcs.exit.SSLSessionListenerImpl), and must be in an archive file called customexit.jar in order to be
implicitly included in the CLASSPATH.
102
16
Administration using
the command line
As an alternative to using the GUI, you can use the command line to configure
sites and certificates and to manage transfers, jobs, and logs for Axway SecureClient. Additional commands enable you to manage the license key or manipulate the scheduler, for example. This functionality is provided by the sclientadm
command line program.
To avoid conflicts between the GUI and command-line (in the same way as for
batch mode), ensure that the GUI is not running before executing commands
from the command line.
Exit codes and error management

Exit codes
When a command is successfully executed, the exit code is 0.When a
command fails, the exit code depends on the type of error:
1: syntax error
2: run-time error
Error management
Default sclientadm behavior:
A successfully executed command does not output anything (apart from

browsing commands, for example, listsites)
If a command fails, the error message is written on the error output and is
made of one line only, unless the silent mode is activated
The following options, common to all commands, modify the default
behavior:
-silent the option does not write anything on standard or error output
103
ADMINISTRATION USING THE COMMAND LINE

ADDITIONAL COMMAND LINE OPTIONS
-verbose the option provides progress information about internal actions

on standard output
These two modes are exclusive; they cannot be used together.
Help
To obtain help about sclientadm commands, enter:
sclientadm help
to display the list of available commands
sclientadm help {command} to display command syntax
Additional command line options

The following table lists additional command-line options.
Command Name
Alias
Usage
Certificate Migration
migratecert
Enables you to migrate the

certificate.
SSH keys Management

generatekey
Generates an SSH key.
importkey
Enables you to import an

SSH key.
exportkey
Enables you to export an

SSH key.
delkey
Enables you to delete an

SSH key.
displaykey
Enables you to display an

SSH key.
listkeys
Returns a list of all SSH

keys.
Usage Information
help
104
Provides information about

usage.

SITE ADMINISTRATION COMMANDS
Command Name
Alias
Usage
Proxy Management
listproxies
Returns a list of avaliable

proxies.
addproxy
Enables you to add a proxy.
delproxy
Enables you to delete a

proxy.
editproxy
Enables you to edit a proxy.
dispproxy
Enables you to display a

proxy.
Site Administration Commands

Use these commands to manage sites.
A site object describes a remote site, accessible through FTP(S), SFTP, or
HTTP(S). It is made up of a set of numerous properties (alias, protocol, host,
port, credentials, directories, Gateway-related parameters, security settings, and
so on). Since command lines are not the ideal way to handle so many parameters, Axway SecureClient supplies two categories of syntax:
Short commands: minimal set of parameters provided on the

command-line.
Full commands: full set of parameters provided in a property file called a

site file. These commands offer the same possibilities as the administration
GUI.
In a Java properties file, the backward slash character is an escape
character and thus must be doubled to signify a single slash. This is particularly important for file paths. For example:
c:\\directory\\subdir\\filename.txt.
NOTE:
This section uses the following typographical conventions:
Parameters between brackets [ ... ] are optional.
Parameters between braces {...} are expected values.
105

Short Commands
Add new site
>>
sclientadm help addsite
help for addsite:
-alias {new alias}
-host {host or IP}
[-port {port}]
[-protocol {FTP|HTTP10|HTTP11|HTTP|SFTP}]
[-username {username}]
[-password {password}]
[-remotedir {remote directory}]
[-encoding {encoding charset}]
[-transfermode {transfer mode: AUTO|BINARY|ASCII}]
[-posttransfercmd {post transefer command to execute}]
[-servertype %%servertype%%]
[-httpident {http authentication methods:
Anonymous|Basic|CGI|NTLM}]
or:
-sitefile {filename or filename search pattern}
%%servertype%% values are:
when protocol is FTP :
GUESS|AXWAY|UNIX_STD|MS_FTP|IBM_ZVM|UNISYS|UNIX_NOGROUPCOL|JA
VA|SECURETRANSPORT
when protocol is HTTP*:
AXWAY|APACHE22|APACHE20|APACHE13|IIS|SECURETRANSPORT|LIGHT_HT
TPD|AUTO
when protocol is SFTP : UNIX|WINDOWS
Use this command to add a new FTP, HTTP, or SFTP site to the Axway SecureClient configuration.
Default port: 21 for FTP, 80 for HTTP, and 22 for SFTP.
106

List sites
sclientadm listsites
[-format {alias|brief}]
Use this command to list all available sites.

Without the - format parameters, the default behavior is that each site is
displayed on a separate line.
-format parameter values:
alias only lists aliases
brief lists main site information. Fields are separated by a semi-colon.
Display site info

sclientadm displaysite
-alias {alias to display}
Use this command to display all information for a specific site. This command
returns output in the properties file format. You can use the output of this
command as a base for input properties file for the addsite full command.
Delete a site
sclientadm delsite
-alias {alias to delete}
Use this command to delete a site from the Axway SecureClient configuration.
Change password
>sclientadm changepass
-alias {site name}
-newpass {new password}
Use this command to change the connection password of a given site.
Full Commands
Full commands make use of a site file.
Add new site(s)
sclientadm addsite
pattern}
-sitefile {filename or filename search
107

Use this command to add one or more new sites to the Axway SecureClient
configuration. A simple filename targets a unique property file. A filename
search pattern (for example site*.properties) allows the creation of many new
sites. The only required property is Alias, which creates an empty site.
Update a site
sclientadm updatesite
-sitefile {filename}
Use this command to update a specific site.

The targeted site file must at least contain the site alias, plus the properties to be
modified. For example, to associate a key with a value of keyalias to a site
with an alias of sftpsite, your property file must contain at least the
following lines:
Alias=sftpsite
SftpKeyAlias=keyalias
Site File Contents

Full commands make use of the properties contained in the site file. Use the
following parameters when creating a new site file:
Property
Equivalent GUI name
Possible values
Alias
Alias
Alphanumeric string
Protocol
Protocol
FTP
FTPS
HTTP
HTTPS
SFTP
108
Host
Host
Host name.
For example: localhost
RemotePort
Port
Valid TCP/IP port number
UserName
User Name
Alphanumeric string
Password
Password
Alphanumeric string
Account (FTP only)
Account
Alphanumeric string
LocalDir
Local Directory
Directory path name

Property
Equivalent GUI name
Possible values
RemoteDir
Remote Directory
Directory path name
Passive
Connection mode
false (Active in the GUI)

true (Passive in the GUI)
RemoteSrvType
Server Type
HTTP
AXWAY
SecureTransport
APACHE 2.2
APACHE 2.0
APACHE 1.3
Microsoft IIS
LightHttpd
Auto
FTP
AXWAY
SECURETRANSPORT
UNIX_STD
MS_FTP
IBM_MVS
UNISYS
UNIX_NOGROUPCOL
JAVA
GUESS
SFPT
UNIX
Windows
SecuredMode (FTPS
only)
Secured mode
TLS, TLS-P, Implicit
HttpProtoVersion (HTTP
only)
Version
HTTP 1.0 and HTTP 1.1
HttpIdentMethod (HTTP
only)
Identification method
Anonymous, CGI, Web
Application
Application
Alphanumeric string
Originator
Originator
Alphanumeric string
Destination
Destination
Alphanumeric string
Message
Message
Alphanumeric string
109

Property
Equivalent GUI name
Possible values
ProxyName
Proxy name
Alphanumeric stringthe name

of an existing Proxy
configuration. Verify that the
proxy exists before adding it to the
site.
LocalPort
Local TCP ports
List or range of valid TCP/IP port

numbers separated by a semicolon
(;)
ClientCertif
Client certificate
Certificate alias
ClientCertPassword
Client password
Alphanumeric string
ServerCertif
Server certificate
Certificate alias
ServerCertCNMatchHost
name
Check that server

certificate common
name matches host name
true
SSLParam
SSL/TLS Cipher Suite
List of valid Cipher Suite names.

Separate each name using the |
(pipe) character:
RSA_AES_256_CBC_SHA
RSA_AES_128_CBC_SHA
RSA_RC4_128_SHA
RSA_RC4_128_MD5
RSA_3DES_EDE_CBC_SHA
RSA_DES_CBC_SHA
RSAEXPORT_DES40_CBC_SHA
RSAEXPORT_RC4_40_MD5
RSA_NULL_SHA
RSA_NULL_MD5
UseSSLCache
Use SSL cache
true
false
false
110
SFTPServerKeyStatus
Server Key Status
Alphanumeric string:
TO IMPORT
TO CHECK
TRUSTED
NOT TRUSTED
SFTPServerFingerprint
Fingerprint
String in the form of SSH

Fingerprint, for example:
0d:15:39:f1:55:7b:fe:72:71:cc:4f:08:
02:3b:e9:89
SFTPAuthMethod
AuthMethod
Alphanumeric string: Password

Key

CERTIFICATE ADMINISTRATION COMMANDS
Property
Equivalent GUI name
Possible values
SFTPKeyAlias
User Key alias
User key alias
UnknownRootBehavior
Reject connection
Reject
Prompt Certificate
Prompt
Accept connection
Accept
Certificate Administration Commands

Use these commands to manage certificates.
Add new certificate

sclientadm addcert
-certfile {certificate filename}

[-alias {alias}]
[-password {PKCS12 password}]
Use this command to add a new certificate to the Axway SecureClient database.
Optionally, you can force an alias and add an associated private key.
List certificates
sclientadm listcert
[-format {alias|brief}]
Use this command to list all available certificates.

Each certificate is displayed on a separate line. Fields are separated by a
semi-colon.
Format parameter values:
alias only lists aliases (default)
brief lists main certificate characteristics
111

JOB ADMINISTRATION COMMANDS
Display certificate info

sclientadm displaycert
-alias {alias to display}
Use this command to display detailed information for a specific certificate.
Delete a certificate
sclientadm delcert
-alias {alias to delete}
Use this command to delete a certificate from the Axway SecureClient

database.
Job Administration Commands

Use these commands to manage jobs.
List jobs
sclientadm help listjob
state {ALL|WAITING|RUNNING|ENDED}
[startid {id1}]
[-endid {id2}]
[-after { afterdate yy/MM/dd HH:mm:ss}]
[-before { beforedate yy/MM/dd HH:mm:ss}]
[-detail]
Use this command to list jobs that match state with startid < id < endid and
created after afterdate and before beforedate.
Date format: yyyy/MM/dd HH:mm:ss.
112

LOG ADMINISTRATION COMMANDS
Display job information

sclientadm displayjob
-id {id,id2, }
[detail]
Use this command to display full job information for a specific job.
Use the detail parameter to display all tasks for a job.
Cancel a job
sclientadm canceljob
id {id1, id2, }
Use this command to cancel a submitted or running job.
Purge jobs
sclientadm purgejob
[startid {id1}]
[-endid {id2}]
[-after { afterdate }]
[-before { beforedate }]
Use this command to purge all ended jobs with startid < id < endid and
created after afterdate and before beforedate.
Date format: YYYY/MM/DD hh:mm:ss.
Log Administration Commands

Use these commands to manage logs.
Archive logs
sclientadm archivelog
113

GENERAL ADMINISTRATION COMMANDS
Use this command to archive the product log.
General Administration Commands

Use these commands for general administration.
Manage license
sclientadm setlicense
-owner { license owner }

-key { license key }
Use this command to set or to update the license key.
Manage scheduler
sclientadm schedulerstart
sclientadm schedulerstatus
sclientadm schedulerstop
Use these commands to start, stop, or check the status of the scheduler.
Force status to stopped state

sclientadm setstopped [-component {interactive|scheduler|both}]
where interactive refers to the GUI

The default action without arguments sets the status of the GUI to stopped. (=
-component interactive).
Use this command to force the status of the product to stop. This can be useful
if the product does not stop correctly for any reason.
NOTE:
114
This command currently has no effect.

SecureClient 5.6 UsersGuide All ENU

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SecureClient 5.6 UsersGuide All ENU

Uploaded by

Copyright:

Available Formats

USERS

Copyright Axway Software, 2010.

Chapter 1 - Axway SecureClient overview

Axway SecureClient Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Using the Rescuer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 4 - Transferring Files

Chapter 5 - Main Window

Local and Remote View Window Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 6 - Site Manager

Site Details Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SECURE CLIENT 5.6 USERS GUIDE

Charset Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 7 - Security Manager Window

Viewing Certificate or Key Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Chapter 8 - Setting Axway SecureClient Preferences

Chapter 9 - Exiting SecureClient

Chapter 10 - Batch Mode

Script File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Chapter 11 - Command List

SECURE CLIENT 5.6 USERS GUIDE

Chapter 12 - SecureTransport Client Legacy Mode

Chapter 13 - Exit Codes

X.509 Certificate Authenthication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Chapter 15 - Exit Classes

Chapter 16 - Administration using the command line

Exit codes and error management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103

SECURE CLIENT 5.6 USERS GUIDE

Delete a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107

Route file transfers

Modify the file structure dynamically

Associate a message with the file

AXWAY SECURECLIENT OVERVIEW

Support for email notificationsAxway SecureClient sends emails when

Support for Tunnel Modeprovides a firewall-friendly mode that allows

Support for MD5 checksums that guarantee a secure delivery

Support for pausing and resuming file transfers

Axway SecureClient Concepts

Authentication, Certificates, and Fingerprints

AXWAY SECURECLIENT OVERVIEW

Connections and Sessions

FTP over SSL (or FTPS)

HTTP over SSL (or HTTPS)

Axway SecureClient supports multiple sessions with one or more servers at a

AXWAY SECURECLIENT OVERVIEW

AXWAY SECURECLIENT OVERVIEW

Supported FTP Features

Implicit and explicit securing mode. Explicit securing mode is performed

Transfer resumes when the server supports this feature.

A special option is added to support non-RFC-compliant PASV and

Supported HTTP Features

File download (GET method)

File upload (PUT method)

Transfer resumes when the server supports this feature

Secured with SSL/TLS

Directory browsing when using any of the following servers:

Apache version 1.3 or later

To enable Axway SecureClient to function with Synchrony Gateway using

AXWAY SECURECLIENT OVERVIEW

Supported SFTP Features

File download (GET method)

File upload (PUT method)

Supported SSL/TLS Features

RSA cipher suites. XFB-specific anonymous RSA cipher suites are

Simple and reciprocal authentication