Brugervejledning for installation og brug af Sterling Commerce Command Line Client (CLC) for UNIX Operating System

Transkript

1 Brugervejledning for installation og brug af Sterling Commerce Command Line Client (CLC) for UNIX Operating System Side 1 af 27

2 Indholdsfortegnelse Ændringer i denne udgave: Ny CLC klient Indledning... 4 Indhold... 4 Forberedelser før installation... 4 Rettigheder... 4 Begrænsninger... 4 Installationsvejledning... 5 Download installationsfiler fra Internettet... 5 Installation... 6 Start installation... 7 Brug af CLC Forudsætninger for at kunne bruge CLC Din nøgle Serverens offentlige nøgle CLC filer cesshsftp Returkoder sshclc.properties sshlog.properties autoscript_file <install>/.ssh/known_hosts Udvikling og brug af SFTP-kommandoer Begrænsninger i anvendelsen Termforklaring Wildcard syntaks Navngivning af filer fra Nets SFTP-kommandoer Introduktion Fortegnelse Syntaksbeskrivelser dir eller ls lcd put mput get mget rm eller delete quit eller bye Eksempel på opsætning af automatisk filudveksling Introduktion Vigtig information Eksempel Uddybende beskrivelse Eksempel Uddybende beskrivelse Eksempel Uddybende beskrivelse Manuel logon Første gang Efterfølgende manuel logon Support Side 2 af 27

3 Kontaktoplysninger Åbningstider Side 3 af 27

4 Indledning Indhold Forberedelser før installation Rettigheder Denne vejledning henvender sig til brugere, der ønsker at anvende Sterling Commerce s Command Line Client (CLC) på UNIX, Linux og AIX servere, som skal bruges til udveksling af data med Nets A/S via protokollen SFTP. (Nets A/S er i det følgende benævnt Nets). Vejledningen beskriver hvordan CLC-softwaren kan downloades og efterfølgende bruges til styring af datakommunikationen med Nets. Læs venligst hele vejledningen før installation igangsættes. CLC kan altid afinstalleres og installeres igen uden problemer. Du skal sikre dig at du har installeret Winzip eller lignende zip klient Du skal sikre dig at der allerede er installeret Java ver. 1.3 eller nyere. Kontakt evt. din systemadministrator. Alle rettigheder til denne vejledning og kommunikationsløsningen tilhører Nets. Det er ikke tilladt at kopiere, videregive eller på anden måde gøre materialet eller dele heraf tilgængeligt for tredjepart uden tilladelse fra Nets. Begrænsninger Følgende platforme er understøttet af CLC: UNIX, Linux, AIX, HP-UX og SUN Solaris. Side 4 af 27

5 Installationsvejledning Download installationsfiler fra Internettet For at kunne installere CLC skal du downloade den zippede fil clcnix.nets. Der er her taget udgangspunkt i at download sker fra windows maskine. Log på websiden Vælg Datakommunikation, SFTPløsning og herefter Download for SFTP-løsning. Vælg CLC installationsprogram til Unix(ca. 525 MB) Følgende billede vises: Tryk Save for at gemme filen på din pc. Vælg den mappe på din PC, hvor du ønsker at filen skal placeres og tryk derefter Save. Når filen er overført, vises følgende skærmbillede. Filen hedder clcnix.nets så du skal starte med at omdøbe filen til clcnix.tar Side 5 af 27

6 Installation Filen pakkes ud. Den indeholder installationsfiler (*.BIN) til AIX, HP, Linux og Solaris. Side 6 af 27

7 Start installation Det følgende er et eksempel på en installation af CLC på et Linux system: linux-geu3:~/downloads/clc13/clc #./CECLC.V13.Linux.bin Preparing to install... Extracting the JRE from the installer archive... Unpacking the JRE... Extracting the installation resources from the installer archive... Configuring the installer for this system's environment... Launching installer... =============================================================== ================ IBM Sterling Connect:Enterprise Command Line Client V1.3.00(created with InstallAnywhere) Preparing CONSOLE Mode Installation... =============================================================== ================ Introduction InstallAnywhere will guide you through the installation of IBM Sterling Connect:Enterprise Command Line Client V Respond to each prompt to proceed to the next step in the installation. If you want to change something on a previous step, type 'back'. You may cancel this installation at any time by typing 'quit'. PRESS <ENTER> TO CONTINUE: Side 7 af 27

8 =============================================================== ================ Choose Installation Folder Where would you like to install? Default Install Folder: /root/clcftp ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT : =============================================================== ================ Pre-Installation Summary Please Review the Following Before Continuing: Product Name: IBM Sterling Connect:Enterprise Command Line Client V Install Folder: /root/clcftp Disk Space Information (for Installation Target): Required: bytes Available: bytes PRESS <ENTER> TO CONTINUE: =============================================================== ================ Installing Side 8 af 27

9 [================== ================== ================== ===== =============] [ ] =============================================================== ================ Installation Complete Congratulations. IBM Sterling Connect:Enterprise Command Line Client V has been successfully installed to: /root/clcftp PRESS <ENTER> TO EXIT THE INSTALLER: linux-geu3:~/downloads/clc13/clc # Side 9 af 27

10 Brug af CLC Forudsætninger for at kunne bruge CLC Følgende skal være på plads før du kan bruge CLC: Du skal have modtaget en User ID (navnet på din postkasse) og et tilhørende password Du skal have hentet din nøgle og placeret den korrekt Du skal kunne huske den passphrase, du benyttede ved generering af din private nøgle Du skal have serverens offentlige nøgle Du skal kende IP adressen for serveren, som er Du skal kende porten, som er Du skal have åbnet for kombinationen af ip adresse og port på din firewall Din nøgle Afhentning af nøgle sker via web-siden ved brug af dit chipkort eller NemID Medarbejdersignatur, den tilhørende User ID og password. (Se eventuelt Brugervejledning vedrørende nøglegenerering ). Placering af din nøgle kan foretages efter dit eget ønske, dog henviser vi til afsnittet Den private nøgle i ovennævnte brugervejledning, hvor sikkerhedsaspekterne omkring opbevaring af nøglen er beskrevet. Serverens offentlige nøgle CLC filer cesshsftp Du skal have serverens offentlige nøgle i filen med known hosts. Den bedste måde at få den placeret det rigtige sted, er ved manuelt at starte en session med serveren fra din maskine. Du vil blive promtet for at gemme serverens offentlige nøgle. Ved at svare always, vil nøglen blive gemt korrekt. Dette er yderligere beskrevet i afsnittet om manuel logon. Efter installation af CLC befinder der sig en del filer i det bibliotek, som er valgt som installationsbibliotek. Der vil i de næste afsnit blive refereret til dette som <install>. I eksemplet er <install> sat til /ceunix/clc/clcftp. De vigtigste filer er følgende: <install>.\cesshsftp selve SFTP clientprogrammet <install>.\sshclc.properties indeholder ssh parametre <install>\ sshlog.properties indeholder parametre til styring af logning <install>.\autoscript_file indeholder parametre og kommandoer <install>\.ssh\known_hosts indeholder den offentlige nøgle fra den eller de hosts, som man som bruger skal udveksle filer med Det skal understreges, at flere af filerne kan ligge andre steder end i <install>, idet der via parametre og konfigurationsfilerne kan refereres direkte til dem Programmet kan bruges sammen med en række parametre: cesshsftp [-a autoscript_file] [-s propertyfile] [-d [debug_file]] [-r] [-x] [-h] [-L key_file] [-P passphrase] -a autoscript Specifies the location and file name of the automation script file. Refer to Writing Automation under autoscript_file Side 10 af 27

11 -s propertyfile Indicates to override the default property file (sshclc.properties) with propertyfile. -d newloglevel Indicate newloglevel to override the default log level. Valid values are: 0 = No logging. 1 = General information. 2 = Debug information. 3 = Trace information. debugfile Indicate newlogfilename to override the default log file. -h Returns the command line syntax -L newkeyfile Indicates to override the default public authentication key file with newkeyfile. If you use this parameter, you can use the -P parameter to specify the passphrase. If you do not include the -P parameter in the command, you will be prompted for the passphrase. -P passphrase Specifies the passphrase associated with the newkeyfile specified with the -L parameter. -r Returns the product name, release, and build. -x Turns on result code exiting for the entire instance of the client. Used with automation scripts to exit if a command fails. Returkoder sshclc.properties Ved at medtage parameteren x afleverer CLC programmet returkoder når det afslutter. Følgende returkoder kan forekomme: 15 SSH key failed 14 ssh scripting failure 13 SSH command failure 12 SSH Disconnect 11 SSH TIMEOUT 10 Catatrophic failure 9 Reserved 8 Locsite parameter invalid 7 Command line parameter invalid 6 SSL file parameter invalid 5 get subcommand failed 4 put subcommand failed 3 Command failed 2 Authetication/login failure 1 Connection establishment failure 0 Good return code # Licensed Materials - Property of IBM # IBM Sterling Connect:Enterprise(R) Command Line Client Side 11 af 27

12 # (C) Copyright IBM Corp. 2003, 2011 All Rights Reserved. # US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. # # Sample ResourceBundle properties file #sockettimeout time=seconds, 1800=30 minutes sockettimeout=1800 compression=yes passwordauth=no publickeyauth=yes #cipherlist=aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfishcbc,aes192-cbc,aes256-cbc #maclist=hmac-sha1,hmac-md5-96,hmac-md5,hmac-sha1-96 keyfile=c:/data/tsi/key/id_dsa #knownhostkeyfile=myknown_host language=en #country=us sshlog.properties autoscript_file Et eksempel på log-property er vist her: ############################################## # Default Logging Configuration File ############################################## # Handler specific properties. # Describes specific configuration info for Handlers. ############################################## # default file output is in user's runtime directory. # Limit the message that are printed on the console to INFO and above. # the valid values are TRACE,DEBUG,INFO,WARN,ERROR,FATAL # the writelogfile value=true will write to log file com.sterlingcommerce.sshclc.sftplogger.defaultlog = INFO com.sterlingcommerce.sshclc.sftplogger.writelogfile = true Eksempel på en autoscript fil: ############################################## open <mailboxid>@<ip-server> c:<datasti til filen med nøglen id_dsa>\id_dsa Side 12 af 27

13 <passphrase> put filer\testfil3_8.mby dir quit ############################################## id_dsa er henvisning til brugerens nøgle hentet fra PBS webside. <install>/.ssh/kno wn_hosts Indeholder offentlig nøgler for de host man har været i kontakt med og svaret altid (always) til. Alternativt kan man indlægge nøgler manuelt f.eks. nøgler som er dowloaded. Side 13 af 27

14 Udvikling og brug af SFTP-kommandoer Begrænsninger i anvendelsen Vigtigt: Ved transmission af data til Nets, skal du altid anvende binær overførsel. De datafiler du sender til din postkasse i Nets, skal altid have samme code page idet din postkasse er forhåndsdefineret til én af de code pages, Nets understøtter. Vejledninger og software fra andre softwareleverandører kan indeholde andre SFTP-kommandoer end de, der er angivet i denne vejledning. Nets er ikke forpligtet til at understøtte sådanne kommandoer eller garantere for deres korrekte virkemåde i relation til anvendelse til denne SFTP-løsning. Side 14 af 27

15 Termforklaring I nedenstående skema kan du finde forklaringer på de termer, der er brugt i dette dokument. Term Forklaring Markering SFTP kommando De kommandoer Nets understøtter i denne løsning fed Variabel De mulige variable parametre, du kan benytte i dine kommandostrenge. Se afsnittet Wildcard syntaks <wildcard> Server_id Adressen til Nets SFTP-server, som enten kan være en webadresse f.eks. ft.pbs.dk, hvis det er muligt at lave navneopslag hos kunden Med kursiv id_dsa Din private nøgle, når du modtager den fra Nets. Fed SFTP-porten på Nets SFTP-server Uden markering cesshsftp Klientpromt i det software, der udleveres fra Nets. Denne vil variere hvis du anvender andet klientsoftware Uden markering -C SFTP-parameter, som aktiver compression af data Uden markering -b <path>whatever_script> SFTP-parameter, som medfører eksekvering af et batchjob. Batchjobbets indhold er beskrevet i whatever-script. Uden markering -oport= SFTP-syntaks til definition af portnummer på Nets SFTP-server. Uden markering MAILBXID Den userid, du har fået udleveret af Nets Uden Skilletegn mellem userid og servernavn Uden markering Userid Din lokale UNIX/Linux user Fed passphrase Det du indtastede, da du generede din nøgle Uden makering Side 15 af 27

16 Wildcard syntaks Nedenstående skema viser den understøttede syntaks for anvendelse af wildcards. Wildcard karakter Virkning * Søgning med * medfører udvælgelse af alle forekomster uanset værdien i * og efterfølgende karakterer. For eksempel vil en søgning med wildcard 2* medføre udvælgelse af 2, 23 og 23aa. Undgå dog _ <underscore> i filnavne. Navngivning af filer fra Nets Nets har anvendt nedenstående navnestandard for datafiler, der leveres til dig. Denne navnestandard gør det muligt at selektere specielle filtyper i opbygning af dine scripts for afhentning af filer. Filer, der begynder med T, er transmissionskvitteringer. Der kan du se om leverancen er blevet modtaget korrekt på Nets server. Filer, der begynder med V,er valideringskvitteringer. Her kan du se om din dataleverance er blevet accepteret af det system hos Nets, der skal behandle den. Filer, der begynder med D, er filer til dig fra et system i Nets i unzipped format. Filer, der begynder med Z, er filer til dig fra et system i Nets i zipped format. For at modtage filer i zipped format, skal din postkasse være oprettet hertil. Bemærk at det som hovedregel ikke er formålstjenligt at anvende denne facilitet når du anvender SFTP. Filer, der begynder med F, er følgesedler som visse systemer i Nets danner sammen med D -filer. Side 16 af 27

17 SFTP-kommandoer Introduktion Dette afsnit beskriver de SFTP-kommandoer, der kan benyttes på SFTPløsningen. Det er vigtigt at overholde de beskrevne syntaksregler for at sikre en korrekt dataudveksling med Nets. I eksemplerne antages, at der er anvendt en commandline client, men kommandoerne kan også kodes ind i et script til automatisk eksekvering. Fortegnelse Nedenstående skema viser de supporterede SFTP-kommandoer og deres betydning. Kommando Betydning dir eller ls Viser en liste over dine filer i din postkasse hos Nets lcd Skifter lokalt på din PC til det ønskede bibliotek put Sender en fil til din postkasse hos Nets mput Sender flere filer til din postkasse hos Nets. Sørg for inden du bruger kommandoen, at være i det bibliotek, som filerne befinder sig i, ved hjælp af kommandoen lcd get Henter en fil fra din postkasse hos Nets mget Henter flere filer fra din postkasse hos Nets rm eller del Sletter en fil fra din postkasse hos Nets quit eller bye Logger dig af fra SFTP-serveren hos Nets Side 17 af 27

18 Syntaksbeskrivelser dir eller ls Syntaks: dir eller ls Ved udstedelse af denne kommando udleveres en liste over de filer, der ligger i din postkasse hos Nets. Den liste du modtager indeholder udelukkende filer, som er tilgængelige til at blive downloaded på din maskine. De filer du selv har sendt til postkassen vil altså IKKE blive vist. lcd Syntaks: lcd<path> Ved udstedelse af denne kommando skifter du lokalt på din PC til det ønskede bibliotek. <path> er stien til det ønskede bibliotek, for eksempel for windows : c:\nets-upload\ put Syntaks: put<path><filnavn> Ved udstedelse af denne kommando kan du sende en fil ad gangen til din postkasse hos Nets. <filnavn> er navnet på filen, der skal sendes til din postkasse hos PBS. <path> er placeringen af <filnavn> på din maskine, for eksempel for windows : c:\nets-upload\ mput Syntaks: mput<path><wildcard> Ved udstedelse af denne kommando kan du sende flere filer ad gangen til din postkasse hos Nets. <wildcard> er udvælgelseskriterie for filer der ligger i <path>, for eksempel C:\nets-upload\netsdata.* get Syntaks: GET <filnavn> <path><nytfilnavn> Ved udstedelse af denne kommando kan du hente én fil fra din postkasse hos Nets. <filnavn> er navnet på filen i din postkasse hos Nets. <path> er navnet på det directory på din maskine, hvor du ønsker at lagre filen. Hvis du ikke angiver <path>, vil filen blive placeret i det directo- Side 18 af 27

19 ry, der er aktivt. <nytfilnavn> er det navn, du ønsker at give filen, når den lagres på din maskine. Hvis du ikke angiver noget i <nytfilnavn>, vil filen blive lagret med samme navn som er angivet i <filnavn>. Hvis du ikke angiver noget <nytfilnavn> kan du heller ikke anvende <path> parameteren. mget Syntaks: mget <wildcard> Ved udstedelse af denne kommando kan du hente flere filer fra din postkasse hos Nets på en gang. <wildcard> er udvælgelseskriterie blandt de filer, der er tilgængelige i din postkasse hos Nets Eksempel : mget D* eller kun mget * mget D* vil kopiere alle filer fra postkassen, der starter med D, og mget * vil kopiere alle filer fra postkassen. Der gives ikke nogen resultatliste ved udførelse af mget-kommandoen. Da der ikke er mulighed for at angive et nyt filnavn eller directory, vil filerne have samme navn som i postkassen hos Nets og de vil alle blive placeret i det aktive directory på din maskine. rm eller delete Syntaks: rm eller delete <filnavn> eller <wildcard> Kommandoerne giver dig mulighed for at slette filer i din postkasse hos Nets. <filnavn> er navnet på den fil i postkassen, som du ønsker at slette. Ved anvendelse af parameteren <wildcard> er det muligt at slette alle filer, der opfylder udvælgelseskriterierne i din wildcardparameter. Udvis altid største forsigtighed ved anvendelsen af denne kommando og vurder nøje relevansen af at slette filer fra din postkasse selv. Du kan ikke slette filer, som du selv har sendt til postkassen hos Nets. Du kan ikke slette filer, som du allerede har hentet hjem én gang. - Med andre ord kan du udelukkende slette filer, som Nets har genereret til dig, og som du endnu ikke har hentet hjem. Hvis du sletter filer fra Nets uden at have kontrolleret filens indhold, ophører Nets informationspligt overfor dig. Side 19 af 27

20 quit eller bye Syntaks: quit eller bye Disse kommandoer medfører at du logges af fra SFTP-serveren hos Nets. Side 20 af 27

21 Eksempel på opsætning af automatisk filudveksling Introduktion I dette afsnit giver vi et eksempel på opsætning af automatisk filudveksling. Forudsætningen for dette script er, at du har downloaded den Command Line Client, som du kan hente på (Vælg Datakommunikation, SFTP-løsning, og herefter Download for SFTP-løsning ). Formålet med scriptet er at hente alle tilgængelige filer i din postkasse hos Nets. Vigtig information For at kunne afvikle scripts mod Nets server skal du have dennes offentlige nøgle udleveret. Den bedste måde at få den udleveret på er at starte din første session mod Nets manuelt. Systemet vil så bede dig om at lagre den offentlige nøgle. Hvis du svarer Always til spørgsmålet om hvorvidt du accepterer den offentlige nøgle, opdateres filen known-hosts for dig. For at udføre automatisk datatransmission er det vigtigt at du svarer Always. Se afsnittet om Manuel logon. Eksempel Indsæt i crontab med den ønskede tidsinterval eller kør shell-script manuelt: get.sh Denne skal have indholdet: cesshsftp a getscript.txt -x Indholdet i getscript.txt er open <mailboksid>@<ip server> <install>/key/id_dsa passphrase lcd c:\modtag\bibliotek mget * quit Side 21 af 27

22 Uddybende beskrivelse I ovenstående script starter cesshsftp-kommandoen sshsftp commandline klienten. Denne skal allerede være installeret på dit edb-udstyr. (Se Vejledning til installation af Command Line Client til SFTP-løsning.) Parameteren a specificerer at der skal anvendes en script file, som automatiserer logon til Nets server. Parameteren x specificerer at cesshsftp skal aflevere returkoder (se afsnit om returkoder) ved afslutning af programmet I scriptet getscript.txt, skal MAILBXID erstattes af den mailbox-id, du har fået udleveret af Nets. Stien <install>/key/id_dsa skal erstattes af stien, der viser placeringen af din private nøgle. lcd kommandoen skifter det lokale bibliotek i dette eksempel til c:\modtag\bibliotek Eksempel Indsæt i crontab med den ønskede tidsinterval eller kør shell-script manuelt: put.sh Denne skal have indholdet: cesshsftp a putscript.txt. Indholdet i putcript.txt er open <mailboksid>@<ip server> <install>clc/id_dsa passphrase lcd <install>/pbs mput * quit Side 22 af 27

23 Uddybende beskrivelse I ovenstående script starter cesshsftp-kommandoen sshsftp commandline klienten. Parameteren a specificerer at der skal anvendes en script file, som automatiserer logon til Nets server. I scriptet putscript.txt, skal MAILBXID erstattes af den mailbox-id, du har fået udleveret af Nets og passphrase skal erstattes med den passphrase du indtastede da du hentede din nøgle. Stien <install>clc/id_dsa skal erstattes af stien, der viser placeringen af din private nøgle. <install>/pbs skal erstattes af det bibliotek, hvor du har placeret dine filer. Eksempel Udarbejd en shell script fil f.eks: ft.sh Med følgende indhold: #!/bin/sh # retc=0 #Set user return value to 0 #Invoke the C:E CLC with return code checking on (-x) #./cesshsftp -a askopi01.txt -x retc=$? echo "Returkoden var: "$retc #Check return code if [ $retc -gt 1 ]; then echo "Filtransporten fejlede." else echo "Filtransporten gik godt." fi exit $retc Uddybende beskrivelse I ovenstående eksempel vil man ved at køre ft.sh starte cesshsftp, bruge en script fil med parameteren a og sikre at programmet skal aflevere returkode ved afslutning. Desuden ønsker man, at returkoder behandles. Inden cesshsftp kaldes skal man sikre at returkoden er 0. Dette gøres med: retc=0 Side 23 af 27

24 Efter cesshsftp afslutter, checkes om returkoden er 1 eller større og hvis dette er tilfældet skrives en fejlmeddelelse og hvis returkoden er 0 skrives en god meddelelse. Shell scriptet kan udvides med andre ting, der skal udføres i det ene eller det andet tilfælde. Eksempler på dette kunne være at kopiere filer til andre biblioteker eller slette filer. Side 24 af 27

25 Manuel logon Første gang Nedenstående eksempel viser hvordan du logger på Nets SFTP-server første gang med det command line interface, du kan få udleveret fra Nets. linux-geu3:~/clcftp #./cesshsftp ================================================================ ====== IBM(R) Sterling Connect:Enterprise(R) Command Line Client v1.3.00, Build26 (C) Copyright IBM Corp. 2003, 2011 All Rights Reserved. IBM and the IBM logo are Trademarks of International Business Machines. ================================================================ ====== cesshsftp> Enter server> cesshsftp> Enter Path to private key file: tsikey/id_dsa cesshsftp> Enter Passphrase (empty for no passphrase): The authenticity of host ' ' can't be established. RSA key fingerprint is e7:8c:5b:33:1c:8f:c0:9d:4d:d5:d9:23:99:a5:ec:42. (sample) Are you sure you want to continue connecting? cesshsftp> Please enter Yes No Yes /root/clcftp/.ssh/known_hosts does not exist. Are you sure you want to create it? cesshsftp> Please enter Yes No Yes The parent directory /root/clcftp/.ssh does not exist. Are you sure you want to create it? cesshsftp> Please enter Yes No Yes /root/clcftp/.ssh has been succesfully created. Please check its access permission. cesshsftp> Efterfølgende manuel logon Nedenstående eksempel viser efterfølgende manuelle logon. linux-geu3:~/clcftp #./cesshsftp =============================================================== ======= IBM(R) Sterling Connect:Enterprise(R) Command Line Client v1.3.00, Build26 (C) Copyright IBM Corp. 2003, 2011 All Rights Reserved. Side 25 af 27

26 IBM and the IBM logo are Trademarks of International Business Machines. =============================================================== ======= cesshsftp> Enter server> cesshsftp> Enter Path to private key file: tsikey/id_dsa cesshsftp> Enter Passphrase (empty for no passphrase): cesshsftp> Side 26 af 27

27 Support Kontaktoplysninger Hvis du har problemer med installationen, kan du kontakte Nets tekniske serviceafdeling ServiceDesk på følgende måde: Telefonnummer: , tast 1 adresse: it-servicedesk@nets.eu Åbningstider Mandag torsdag kl Fredag kl Side 27 af 27