NDS2CLI

PCSS
NDS2CLI
Instrukcja obsługi
Adam Zawada
2013-10-23
Instrukcja obsługi klienta konsolowego Krajowego Magazynu Danych
Spis treści
Wstęp ...................................................................................................................................................... 2
Kompatybilność ....................................................................................................................................... 2
Wymagania .............................................................................................................................................. 2
Uruchamianie .......................................................................................................................................... 2
Konfiguracja............................................................................................................................................. 3
Parametry pliku konfiguracyjnego ...................................................................................................... 3
Opis poleceń ............................................................................................................................................ 4
1
Wstęp
Nds2cli jest aplikacją konsolową kierowaną głownie do administratorów, na potrzeby
uruchamiania z powłoki systemowej bądź automatyzacji wywołań programu z użyciem skryptów
powłoki. Wersja binarna oprogramowania dostarczona jest w dwóch wersjach:
- jako pakiet RPM – dla systemów Unixowych z rodziny RedHat Linux,
- jako pakiet JAR – dla pozostałych systemów operacyjnych.
Kompatybilność
Aplikacja została przetestowana z systemami z rodziny Windows oraz Linux. Powinna działać na
każdej wersji Windows, jak i na każdej dystrybucji systemu Linux z poprawnie zainstalowaną oraz
skonfigurowaną maszyną wirtualną Javy.
Wymagania
Do prawidłowego działania wymagana jest zainstalowana oraz poprawnie skonfigurowana wirtualna
maszyna Javy w wersji co najmniej 1.5.
Uruchamianie
Uruchamianie aplikacji zainstalowanej z pakietu RPM:
1) Uruchamiamy terminal systemowy
2) Wywołujemy polecenie
nds2cli [nazwa_polecenia] [nazwa_opcji]=[parametr]
np. nds2cli list --path=/ --conf=/etc/nds/nds2cli_my.conf
Uruchamianie aplikacji z użyciem pakietu JAR:
1) Uruchamiamy terminal systemowy (np. cmd.exe)
2) Wywołujemy polecenie
java -jar <ścieżka do pliku jar> [nazwa polecenia] [nazwa opcji]=[parametr]
np. java -jar nd2cli-0.2-4.jar list --path=/encrypted/ --conf=”C:\Users\Jan
Kowalski\nds\nds2cli.conf”
2
Rys. 1 Przykład uruchomienia programu nds2cli w konsoli cygwin.
Konfiguracja
Domyślnym położeniem pliku konfiguracyjnego jest:
Dla systemu Linux: /etc/nds/nds2cli.conf
Dla systemu Windows: <katalog domowy użytkownika>\nds\nds2cli.conf, np.:
C:\Users\Jan Kowalski\nds\nds2cli.conf
Położenie pliku konfiguracyjnego może być także wskazane poprzez parameter wywołania programu:
--conf=<ścieżka do pliku konfiguracyjnego>
Parametry pliku konfiguracyjnego
hostname - adres serwera SFTP/KMD2 (np. storagetest01.man.poznan.pl)
username – login użytkownika konta SFTP/KMD2 (np. franek)
privateKeyPath – pełna ścieżka do klucza prywatnego użytkownika, do logowania, w formacie PEM
(powiązanego z certyfikatem w przypadku łączenia się z serwerem KMD2)
keyPassword - hasło klucza prywatnego, do logowania
rsa4096PrivateKeyPath – pełna ścieżka do klucza prywatnego użytkownika, do szyfrowania danych,
w formacie PEM,
rsa4096KeyPassword - hasło klucza prywatnego, do szyfrowania danych
rsa4096PublicKeyPath – ścieżka do klucza publicznego, do szyfrowania danych
3
port – nr portu na którym nasłuchuje serwer SFTP/KMD2
knownHosts – pełna ścieżka do pliku ze skrótami kluczy zaufanych hostów (known_hosts)
encryptNames – flaga świadcząca o tym, czy nazwy plików w szyfrowanej przestrzeni mają być
szyfrowane, czy też nie (możliwe wartości: true/false).
Opis poleceń
Użycie:
nds2cli [polecenie] [opcje]
[edytuj] Polecenia
( * - opcja wymagana)
list
listowanie pliku lub katalogu
Użycie: list [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
--opt opcje wyświetlanej listy: (a - /all/ wyświetlaj wszystkie pliki,
również te zaczynające się od '.'; h - /human/ wyświetlaj rozmiar pliku
czytelny dla człowieka, tj. K-kilo, M-Mega, G-giga; l - /long/ długa
informacja o pliku. Wszystkie atrybuty są wyświetlane jako lista.)
*
rm
--path ścieżka do pliku lub katalogu
usuwanie pliku
Użycie: rm [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
genkeys
generowanie pary kluczy asymetrycznych RSA4096
Użycie: genkeys [opcje]
Opcje:
--conf Ścieżka do pliku konfiguracyjnego
4
--dir ścieżka do katalogu
Wartość domyślna: C:\Users\Adam Zawada
copy
skopiuj plik na zdalnym serwerze
Użycie: copy [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--dest ścieżka docelowa
*
--src ścieżka źródłowa
rename
zmień nazwę pliku/katalogu
Użycie: rename [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--dest ścieżka docelowa
*
--src ścieżka źródłowa
mkdir
utwórz katalog
Użycie: mkdir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
move
przenieś plik/katalog
Użycie: move [opcje]
Opcje:
--conf Ścieżka do pliku konfiguracyjnego
*
--dest ścieżka docelowa
*
--src ścieżka źródłowa
get
pobierz plik ze zdalnego serwera
Użycie: get [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
5
*
--dest ścieżka docelowa
*
--src ścieżka źródłowa
put
umieść plik na zdalnym serwerze
Użycie: put [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--dest ścieżka docelowa
*
--src ścieżka źródłowa
rmdir
usuń katalog
Użycie: rmdir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
whoami
sprawdza na jakiego użytkownika obecnie jesteśmy zalogowani
Użycie: whoami [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
query
Użycie: query [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
share
nadaj uprawnienia do pliku/katalogu wewnętrznemu użytkownikowi
Użycie: share [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--name Username or Group name (depends which user type has been chosen)
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
6
*
--permissions uprawnienia dostępu do pliku/katalogu (r - odczyt, w - zapis, x wykonanie)
*
--type rodzaj encji której zostaną nadane uprawnienia. Dozolone wartości, to: USER/GROUP.
unshare
odbierz uprawnienia do pliku/katalogu wewnętrznemu użytkownikowi
Użycie: unshare [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--name Username or Group name (depends which user type has been chosen)
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
*
--type rodzaj encji której zostaną nadane uprawnienia. Dozolone wartości, to: USER/GROUP.
setacl
ustawianie rozszerzonych atrybutów plików: ACL
Użycie: setacl [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--name Username or Group name (depends which user type has been chosen)
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
*
--permissions uprawnienia dostępu do pliku/katalogu (r - odczyt, w - zapis, x wykonanie)
*
--type rodzaj encji której zostaną nadane uprawnienia. Dozolone wartości, to: USER/GROUP.
showusers
wylistuj użytkowników i grupy do współdzielenia
Użycie: showusers [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
stat
wyświetl rozszerzone informacje o pliku
Użycie: stat [opcje]
Opcje:
7
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
accounting
wyświetl dane accountingowe
Użycie: accounting [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
sbx_export
udostępnij plik zewnętrznemu użytkownikowi
Użycie: sbx_export [opcje]
Opcje:
*
--close data zamknięcia zadania importowania/eksportowania plików (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--conf ścieżka do pliku konfiguracyjnego
*
--expire data ekspiracji zadania importowania/eksportowania plików (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--message wiadomość do odbiorcy plików
--recipients lista odbiorców plików
*
--sender email zlecającego udostępnianie plików
--subject temat wiadomości przesyłanej do odbiorców plików
sbx_vouchers
wyświetlane aktualnych zleceń wymiany plików
Użycie: sbx_vouchers [opcje]
Opcje:
--close_after data zamknięcia zadania późniejsza niż podana (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--close_before data zamknięcia wcześniejsza niż podana (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--conf ścieżka do pliku konfiguracyjnego
--create_after data utworzenia zadania późniejsza niż podana (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--create_before data utworzenia wcześniejsza niż podana (format:
8
YYYY-MM-DDThh:mm:ss±hh:mm)
--email email właściciela zadania
--expire_after data ekspiracji zadania późniejsza niż podana (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--expire_before data ekspiracji wcześniejsza niż podana (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--oid identyfikator właściciela zadania
--state status zadania współdzielenia. Możliwe statusy: OPEN
- otwarty,
dostępny przez web, można przesyłać i modyfikować pliki, CLOSED zamknięty, niedostępny przez web, pliki mogą być akceptowane i replikowane,
EXPIRING - w trakcie ekspiracji, niedostępny przez web, oczekiwanie na
replikację zaakceptowanych plików, zreplikowane pliki są usuwane, EXPIRED wyekspirowany, niedostępny przez web, pliki usunięte.
--type typ zlecenia udostępniania plików [export / import]
sbx_close
zamykanie zlecenia importowanych/eksportowanych plików
Użycie: sbx_close [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_addFiles
dodanie plików do zlecenia udostępnienia
Użycie: sbx_addFiles [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator katalogu w systemie Sandbox
*
--name nazwa pliku w systemie Sandbox
*
--path ścieżka do pliku
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_mkdir
utworzenie katalogu w ramach zlecenia udostępnienia
Użycie: sbx_mkdir [opcje]
Opcje:
9
--conf ścieżka do pliku konfiguracyjnego
sbx_rmdir
usunięcie katalogu z przestrzeni Sandbox
Użycie: sbx_rmdir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
sbx_rmFiles
usuniecie plików ze zlecenia udostępnienia
Użycie: sbx_rmFiles [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--fids identyfikatory plików w zleceniu udostępniania (oddzielone
przecinkiem)
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_lsDir
listownie katalogu w ramach zlecenia udostępnienia
Użycie: sbx_lsDir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator katalogu w systemie Sandbox
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_lsVoucher
listowanie struktury plików i ktalogów w ramach zlecenia udostępniania
Użycie: sbx_lsVoucher [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_addRecipient
dodawanie odbiorcy zlecenia udostępniania plików
Użycie: sbx_addRecipient [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
--message wiadomość do odbiorcy plików
*
--recipient adres email odbiorcy zlecenia importu/eksportu plików
--subject temat wiadomości przesyłanej do odbiorców plików
10
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_setHeaders szyfrowanie nagłówka wskazanego pliku, podanym kluczem publicznym
użytkownika i umieszcza w systemie Sandbox
Użycie: sbx_setHeaders [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--fid identyfikator pliku w systemie Sandbox
*
--path ścieżka do pliku lub katalogu
*
--pubKey ścieżka do pliku z kluczem publicznym
*
--recipient
adres email odbiorcy zlecenia importu/eksportu plików
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_getRequests
pobieranie listy plików wymagających przeszyfrowania nagłówka.
Użycie: sbx_getRequests [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--recipient adres email odbiorcy zlecenia importu/eksportu plików
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_getKey
pobieranie klucza publicznego, użytkownika systemu Sandbox
Użycie: sbx_getKey [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--dir ścieżka do katalogu
*
--recipient adres email odbiorcy zlecenia importu/eksportu plików
sbx_import
wysyłanie zlecenia pobrania plików od zewnętrznego użytkownika
Użycie: sbx_import [opcje]
Opcje:
*
--close data zamknięcia zadania importowania/eksportowania plików (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
--conf ścieżka do pliku konfiguracyjnego
11
--encrypt podanie argumentu oznacza, że importowane pliki mają być
zaszyfrowane.
Wartość domyślna: false
*
--expire data ekspiracji zadania importowania/eksportowania plików (format:
YYYY-MM-DDThh:mm:ss±hh:mm)
*
--max-count maksymalna liczba importowanych plików (w Bajtach, można podawać z
przedrostkiem K - Kilo, M - Mega, G - Giga, np. 4K = 4096 Bajtów)
*
--max-size maksymalny rozmiar importowanych plików (w Bajtach, można podawać z
przedrostkiem K - Kilo, M - Mega, G - Giga, np. 4K = 4096 Bajtów)
*
--max-total-size maksymalny, sumaryczny rozmiar importowanych plików
--message wiadomość do odbiorcy plików
*
--recipient adres email odbiorcy zlecenia importu/eksportu plików
--recipients lista odbiorców plików
*
--sender email zlecającego udostępnianie plików
--subject temat wiadomości przesyłanej do odbiorców plików
sbx_acceptFiles
zaimportuj wybrane pliki z systemu Sandbox
Użycie: sbx_acceptFiles [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--fid identyfikator pliku w systemie Sandbox
*
--name nazwa pliku po przeniesieniu z Sandboxa.
*
--path ścieżka do katalogu, gdzie mają być przekopiowane.
*
--vid identyfikator zadania importowanych/eksportowanych plików
sbx_setKey
ustawianie klucza publicznego, użytkownika systemu Sandbox
Użycie: sbx_setKey [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--sender email zlecającego udostępnianie plików
sbx_quota
pobieranie quoty dla Sandboxa do Importu oraz Exportu plików
Użycie: sbx_quota [opcje]
12
Opcje:
--conf ścieżka do pliku konfiguracyjnego
pub_quota
pobieranie quoty dla Sandboxa do Publikacji plików
Użycie: pub_quota [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
publications
pobieranie listy ścieżek do pliku w przestrzeni publikacji
Użycie: publications [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku
publish
publikacja pliku w Sandboxie
Użycie: publish [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator przestrzeni, bądź katalogu, w którym plik ma zostać
opublikowany
*
--name nazwa pliku w systemie Sandbox
--note notatka do pliku
*
--path ścieżka do pliku
pub_createSite
tworzenie przestrzeni publikacji
Użycie: pub_createSite [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--name nazwa przestrzeni publikacji
pub_mkdirSite
tworzenie przestrzeni publikacji
Użycie: pub_mkdirSite [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
13
--did identyfikator katalogu nadrzędnego w przestrzeni publikacji, jeśli
to pierwszy katalog, to należy podać identyfikator przestrzeni.
*
--name nazwa katalogu
pub_showSites
pobieranie listy przestrzeni publikacji
Użycie: pub_showSites [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
pub_showFiles
pobieranie listy plików w danej przestrzeni publikacji
Użycie: pub_showFiles [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
--pattern wzorzec do filtrowania plików/katalogów
*
--sid identyfikator przestrzeni publikacji
unpublish
odwołanie publikacji pliku
Użycie: unpublish [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--fid identyfikator pliku w systemie Sandbox
pub_rmdirSite
usuwanie katalogu z przestrzeni publikacji
Użycie: pub_rmdirSite [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator katalogu w systemie Sandbox
--r usuwaj rekurencyjnie
pub_rmSite
usuwanie przestrzeni publikacji
Użycie: pub_rmSite [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
--r usuwaj rekurencyjnie
*
--sid identyfikator przestrzeni publikacji
pub_renameSiteDir
14
zmień nazwę katalogu w przestrzeni publikacji
Użycie: pub_renameSiteDir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator katalogu w systemie Sandbox
*
--name nazwa katalogu
pub_renameSite
przenieś plik lub katalog wewnątrz przestrzeni publikacji
Użycie: pub_renameSite [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--name nazwa przestrzeni publikacji
*
--sid identyfikator przestrzeni publikacji
pub_orphan
usunięte)
ustawianie pliku w przestrzeni publikacji, jako osierocony (źródło z KMD2 zostało
Użycie: pub_orphan [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--fid identyfikator pliku w systemie Sandbox
pub_mvSiteDir
przenieś plik lub katalog wewnątrz przestrzeni publikacji
Użycie: pub_mvSiteDir [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--did identyfikator katalogu, do którego ma zostać przeniesiony wybrany
plik lub katalog
*
--srcId identyfikator pliku lub katalogu, który ma zostać przeniesiony
setCurrentVersion
Ustawianie wybranej wersji pliku jako bieżąca.
Użycie: setCurrentVersion [opcje]
Opcje:
--conf ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
15
*
--version Numer wybranej wersji pliku, którą chcemy ustawić jako bieżącą.
Wartość domyślna: <empty string>
listDirFilesVersions
Listowanie wersji plików znajdujących się w wybranym katalogu.
Użycie: listDirFilesVersions [opcje]
Opcje:
--conf Ścieżka do pliku konfiguracyjnego
*
--path ścieżka do pliku lub katalogu
Wartość domyślna: <empty string>
version
help
16
wyświetl wersję programu
wyświetl pomoc