asperalm 0.9.26 → 0.9.27

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b72fd05a8120312aa381b94521eb3b67df168bff087634b9a158bfbaeb0eabe2
4
- data.tar.gz: 49573bed78dcdda8a0a555e82bb3dd07710d20f19fd09d7edbfc6e3d2308df32
3
+ metadata.gz: c37c8b9c31d6f0f44ef73fe0198e94d51fbd71bec883a2f7ad2f70d0d0eedb2e
4
+ data.tar.gz: acbf84b14954b8d288f92514931465c75dc960254ea7923328e4aa92c35a5297
5
5
  SHA512:
6
- metadata.gz: 2e3b84f53203fab586f97d50719a616f905010ea2c4dcc10ca5242cab6634aef0fff13f5825f5c90f9f58f097665c07a5637647670ec31d9e82123453e89ddfd
7
- data.tar.gz: f50419e3e7a8ce66622d6b262e45b5f5a912b1ef2e5c5d3645b06b62f9a41d52168e40a901d6737eea6e83b708464241fb265b8fdc60621a4466947e0e7424d7
6
+ metadata.gz: 883472b60f41bf990527a0ab2c99be8aa130f74d68412424654c4ed87e5405cbcc6338687507bb38847175aaf97aa2c4f46d7b94f94369748d1186e6e21c9133
7
+ data.tar.gz: 868bdd3b70af006981dfb051c1af21184eebbafd4ca4bd60c363b54c835c49c5a80109a6d3613c03c169c2679b453bb827cf99ed8ab3d3a230bf70c3f7a0c603
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Asperalm - A Ruby library for Aspera transfers and "Amelia", the _Multi Layer IBM Aspera_ Command Line Tool
2
2
 
3
- Version : 0.9.26
3
+ Version : 0.9.27
4
4
 
5
5
 
6
6
  _Laurent/2016-2018_
@@ -37,7 +37,7 @@ Once the gem is installed, `mlia` shall be accessible:
37
37
 
38
38
  ```bash
39
39
  $ mlia --version
40
- 0.9.26
40
+ 0.9.27
41
41
  ```
42
42
 
43
43
  ## First use
@@ -134,13 +134,19 @@ $ brew install ruby
134
134
 
135
135
  On windows download Ruby from [https://rubyinstaller.org/](https://rubyinstaller.org/).
136
136
 
137
+ Go to "Downloads".
138
+
139
+ Select the version "without devkit", x64 corresponding to the one recommended "with devkit".
140
+
141
+ During installation, skip the installation of "MSys2".
142
+
137
143
  ### Linux
138
144
 
139
145
  ```bash
140
146
  $ yum install ruby rubygems
141
147
  ```
142
148
 
143
- Note that Ruby 2+ is required, if you have an older Linux (e.g. CentOS 6), you should install "rvm" [https://rvm.io/](https://rvm.io/) and install and use a newer Ruby.
149
+ Note that Ruby 2+ is required, if you have an older Linux (e.g. CentOS 6) or want to use a separate version: you should install "rvm" [https://rvm.io/](https://rvm.io/) and install and use a newer Ruby.
144
150
 
145
151
  ## `asperalm` gem
146
152
 
@@ -634,6 +640,17 @@ a text editor for file edition.
634
640
  * `--ui=text` forces a text environment, the URL or file path to open is displayed on
635
641
  terminal.
636
642
 
643
+ ## Proxy Auto Configuration
644
+
645
+ The `pac` options allows specification of a "PAC" file, by its URL. Supported schemes are : http:, https: and file:.
646
+
647
+ The PAC file can be tested with command: `config proxy_check` , example:
648
+
649
+ ```
650
+ $ mlia config proxy_check --pac=file:///./proxy.pac http://www.example.com
651
+ PROXY proxy.example.com:8080
652
+ ```
653
+
637
654
  ## <a name="agents"></a>Transfer Agents
638
655
 
639
656
  Some of the actions on Aspera Applications lead to file transfers (upload and download) using the FASP protocol (`ascp`).
@@ -920,6 +937,163 @@ Usually the OS native scheduler shall already provide some sort of such protecti
920
937
  A non complete list of commands used in unit tests:
921
938
 
922
939
  ```bash
940
+ mlia
941
+ mlia --no-default node --url=my_url_here --username=my_username_here --password=my_password_here --insecure=yes delete /500M.dat
942
+ mlia --no-default node --url=my_url_here --username=my_username_here --password=my_password_here --insecure=yes upload --to-folder=/Upload --sources=@ts --ts=@json:'{"paths":[{"source":"500M.dat"}],"remote_password":"demoaspera","precalculate_job_size":true}' --transfer=node --transfer-info=@json:'{"url":"my_url_here","username":"my_username_here","password":"my_password_here"}'
943
+ mlia --version)
944
+ mlia --version` TOOLNAME=$(EXENAME) erb README.erb.md > README.md
945
+ mlia -N aspera org --link=https://sedemo.ibmaspera.com/packages/public/receive?token=cpDktbNc8aHnyrbI_V49GzFwm5q3jxWnT_cDOjaewrc
946
+ mlia -N server --url=my_url_here --username=my_username_here --password=my_password_here --format=nagios nagios transfer --to-folder=/Upload
947
+ mlia -N server --url=my_url_here --username=my_username_here --ssh-keys=~/.ssh/id_rsa --format=nagios nagios app_services
948
+ mlia -N server --url=my_url_here --username=my_username_here --ssh-keys=~/.ssh/id_rsa ctl all:status
949
+ mlia -N server --url=my_url_here --username=my_username_here --ssh-keys=~/.ssh/id_rsa nodeadmin -- -l
950
+ mlia -Pnode_lmdk08 --url=my_url_here --username=my_username_here --password=my_password_here node acc create --value=@json:'{"id":"aoc_1","secret":"'$(NODE_PASS)'","storage":{"type":"local","path":"/"}}'
951
+ mlia -Pnode_lmdk08 --url=my_url_here --username=my_username_here --password=my_password_here node acc delete --id=aoc_1
952
+ mlia -h
953
+ mlia -w
954
+ mlia aspera admin ats access_key --id=testkey2 delete
955
+ mlia aspera admin ats access_key --id=testkey2 node browse /
956
+ mlia aspera admin ats access_key --id=testkey3 delete
957
+ mlia aspera admin ats access_key create --cloud=aws --region=eu-west-1 --params=@json:'{"id":"testkey3","name":"laurent key AWS","storage":{"type":"aws_s3","bucket":"sedemo-ireland","credentials":{"access_key_id":"my_access_key_id_here","secret_access_key":"my_secret_access_key_here"},"path":"/laurent"}}'
958
+ mlia aspera admin ats access_key create --cloud=softlayer --region=ams --params=@json:'{"id":"testkey2","name":"laurent key","storage":{"type":"softlayer_swift","container":"laurent","credentials":{"api_key":"my_api_key_here","username":"my_username_here"},"path":"/"}}'
959
+ mlia aspera admin ats access_key list --fields=name,id,secret
960
+ mlia aspera admin ats cluster clouds
961
+ mlia aspera admin ats cluster list
962
+ mlia aspera admin ats cluster show --cloud=aws --region=eu-west-1
963
+ mlia aspera admin ats cluster show --id=1f412ae7-869a-445c-9c05-02ad16813be2
964
+ mlia aspera admin eve --query=@json:'{"page":1,"per_page":2,"q":"*","sort":"-date"}'
965
+ mlia aspera admin res node v3 events --secret=my_secret_here
966
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v3 access_key create --value=@json:'{"id":"testsub1","storage":{"path":"/folder1"}}'
967
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v3 access_key delete --id=testsub1
968
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v3 events
969
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v4 browse /
970
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v4 delete /folder1
971
+ mlia aspera admin resource node --name=eudemo-sedemo --secret=my_secret_here v4 mkdir /folder1
972
+ mlia aspera admin resource workspace list
973
+ mlia aspera admin resource workspace_membership list --fields=ALL --query=@json:'{"page":1,"per_page":50,"embed":"member","inherited":false,"workspace_id":11363,"sort":"name"}'
974
+ mlia aspera admin set_client_key ERuzXGuPA @file:$(APIKEY)
975
+ mlia aspera apiinfo
976
+ mlia aspera bearer_token --display=data --scope=user:all
977
+ mlia aspera faspex
978
+ mlia aspera files browse /
979
+ mlia aspera files delete /newname
980
+ mlia aspera files download --to-folder=sample_dest_folder --transfer=connect --sources=@args /200KB.1
981
+ mlia aspera files file 18891
982
+ mlia aspera files find / --value='\.partial$$'
983
+ mlia aspera files http_node_download --to-folder=sample_dest_folder --sources=@args /200KB.1
984
+ mlia aspera files mkdir /testfolder
985
+ mlia aspera files rename /testfolder newname
986
+ mlia aspera files transfer --from-folder=/ --to-folder=xxx --sources=@args 200KB.1
987
+ mlia aspera files upload --to-folder=/ sample_file.bin
988
+ mlia aspera files v3 info
989
+ mlia aspera organization
990
+ mlia aspera packages list
991
+ mlia aspera packages list --format=csv --fields=id|head -n 1)
992
+ mlia aspera packages recv --id=ALL --once-only=yes --lock-port=12345
993
+ mlia aspera packages send --value=@json:'{"name":"'"$(PACKAGE_TITLE)"'","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com"]}' --sources=@args sample_file.bin
994
+ mlia aspera packages send --value=@json:'{"name":"'"$(PACKAGE_TITLE)"'","recipients":["laurent.martin.l+external@gmail.com"]}' --new-user-option=@json:'{"package_contact":true}' --sources=@args sample_file.bin
995
+ mlia aspera user info modify @json:'{"name":"dummy change"}'
996
+ mlia aspera user info show
997
+ mlia aspera workspace
998
+ mlia ats access_key --id=testkey2 cluster
999
+ mlia ats access_key --id=testkey2 delete
1000
+ mlia ats access_key --id=testkey2 node browse /
1001
+ mlia ats access_key --id=testkey3 delete
1002
+ mlia ats access_key create --cloud=aws --region=eu-west-1 --params=@json:'{"id":"testkey3","name":"laurent key AWS","storage":{"type":"aws_s3","bucket":"sedemo-ireland","credentials":{"access_key_id":"my_access_key_id_here","secret_access_key":"my_secret_access_key_here"},"path":"/laurent"}}'
1003
+ mlia ats access_key create --cloud=softlayer --region=ams --params=@json:'{"id":"testkey2","name":"laurent key","storage":{"type":"softlayer_swift","container":"laurent","credentials":{"api_key":"my_api_key_here","username":"my_username_here"},"path":"/"}}'
1004
+ mlia ats access_key list --fields=name,id,secret
1005
+ mlia ats api_key create
1006
+ mlia ats api_key instances
1007
+ mlia ats api_key list
1008
+ mlia ats cluster clouds
1009
+ mlia ats cluster list
1010
+ mlia ats cluster show --cloud=aws --region=eu-west-1
1011
+ mlia ats cluster show --id=1f412ae7-869a-445c-9c05-02ad16813be2
1012
+ mlia conf flush
1013
+ mlia conf wiz --url=my_url_here --config-file=$(SAMPLE_CONFIG_FILE) --client-id=$(HIDE_CLIENT_ID) --client-secret=$(HIDE_CLIENT_SECRET) --pkeypath='' --use-generic-client=no --username=my_username_here
1014
+ mlia conf wiz --url=my_url_here --config-file=$(SAMPLE_CONFIG_FILE) --pkeypath='' --username=my_username_here
1015
+ mlia config ascp connect id 'Aspera Connect for Windows' info
1016
+ mlia config ascp connect id 'Aspera Connect for Windows' links id 'Windows Installer' download --to-folder=.
1017
+ mlia config ascp connect id 'Aspera Connect for Windows' links list
1018
+ mlia config ascp connect list
1019
+ mlia config ascp products list
1020
+ mlia config ascp show
1021
+ mlia config email_test aspera.user1@gmail.com
1022
+ mlia config export
1023
+ mlia config genkey sample_dest_folder/mykey
1024
+ mlia config id conf_name delete
1025
+ mlia config id conf_name initialize @json:'{"p1":"v1","p2":"v2"}'
1026
+ mlia config id conf_name set param value
1027
+ mlia config id conf_name show
1028
+ mlia config id conf_name update --p1=v1 --p2=v2
1029
+ mlia config id default set shares conf_name
1030
+ mlia config list
1031
+ mlia config open
1032
+ mlia config overview
1033
+ mlia config plugins
1034
+ mlia config proxy_check --pac=file:///./examples/proxy.pac https://eudemo.asperademo.com
1035
+ mlia console transfer current list
1036
+ mlia faspex nagios_check
1037
+ mlia faspex package list
1038
+ mlia faspex package list --fields=delivery_id --format=csv --box=sent|tail -n 1) --box=sent
1039
+ mlia faspex package recv --to-folder=sample_dest_folder --id=ALL --once-only=yes
1040
+ mlia faspex package send --delivery-info=@json:'{"title":"'"$(PACKAGE_TITLE)"'","recipients":["laurent.martin.aspera@fr.ibm.com"]}' --sources=@args sample_file.bin
1041
+ mlia faspex recv_publink 'https://faspex.mycompany.com/aspera/faspex/external_deliveries/78780?passcode=a003aaf2f53e3869126b908525084db6bebc7031' --insecure=yes
1042
+ mlia faspex source name "Server Files" node br /
1043
+ mlia node async --id=1 counters
1044
+ mlia node async --id=1 summary
1045
+ mlia node async list
1046
+ mlia node browse / -r
1047
+ mlia node delete sample_dest_folder200KB.1
1048
+ mlia node download --to-folder=sample_dest_folder --sources=@args sample_dest_folder200KB.1
1049
+ mlia node info
1050
+ mlia node nagios_check
1051
+ mlia node service --id=service1 delete
1052
+ mlia node service create @json:'{"id":"service1","type":"WATCHD","run_as":{"user":"user1"}}'
1053
+ mlia node service list
1054
+ mlia node transfer list
1055
+ mlia node upload --to-folder=sample_dest_folder --ts=@json:'{"target_rate_cap_kbps":10000}' sample_file.bin
1056
+ mlia orchestrator info
1057
+ mlia orchestrator plugins
1058
+ mlia orchestrator processes
1059
+ mlia orchestrator workflow --id=10 inputs
1060
+ mlia orchestrator workflow --id=10 start --params=@json:'{"Param":"laurent"}'
1061
+ mlia orchestrator workflow --id=10 start --params=@json:'{"Param":"laurent"}' --result=ResultStep:Complete_status_message
1062
+ mlia orchestrator workflow --id=10 status
1063
+ mlia orchestrator workflow list
1064
+ mlia orchestrator workflow status
1065
+ mlia preview events --once-only=yes --skip-types=office
1066
+ mlia preview scan --skip-types=office --log-level=info
1067
+ mlia preview test ~/'Documents/Samples/YıçşöğüİÇŞÖĞÜ.pdf' --log-level=debug png --video=clips
1068
+ mlia preview test ~/Documents/Samples/anatomic-2k/TG18-CH/TG18-CH-2k-01.dcm --log-level=debug png --video=clips
1069
+ mlia server browse /
1070
+ mlia server browse /Upload/target_hot
1071
+ mlia server cp /Upload/200KB.1 /Upload/200KB.2
1072
+ mlia server delete /Upload/200KB.1
1073
+ mlia server delete /Upload/target_hot
1074
+ mlia server delete /Upload/to.delete
1075
+ mlia server df
1076
+ mlia server download --sources=@args /Upload/200KB.1 --transfer=node
1077
+ mlia server download --to-folder=sample_dest_folder --sources=@args /Upload/200KB.1
1078
+ mlia server du /
1079
+ mlia server info
1080
+ mlia server md5sum /Upload/200KB.1
1081
+ mlia server mkdir /Upload/123 --logger=stdout
1082
+ mlia server mkdir /Upload/target_hot
1083
+ mlia server mv /Upload/200KB.2 /Upload/to.delete
1084
+ mlia server rm /Upload/123
1085
+ mlia server upload --to-folder=/Upload --sources=@args sample_file.bin
1086
+ mlia server upload --to-folder=/Upload/target_hot --lock-port=12345 --ts=@json:'{"EX_ascp_args":["--remove-after-transfer","--remove-empty-directories","--exclude-newer-than=-8","--src-base","source_hot"]}' --sources=@args source_hot
1087
+ mlia shares repository browse /
1088
+ mlia shares repository delete /$(TEST_SHARE)/200KB.1
1089
+ mlia shares repository download --to-folder=sample_dest_folder --sources=@args /$(TEST_SHARE)/200KB.1
1090
+ mlia shares repository upload --to-folder=/$(TEST_SHARE) --sources=@args sample_file.bin
1091
+ mlia shares2 appinfo
1092
+ mlia shares2 organization list
1093
+ mlia shares2 project list --organization=Sport
1094
+ mlia shares2 repository browse /
1095
+ mlia shares2 userinfo
1096
+ mlia sync start --parameters=@json:'{"sessions":[{"name":"test","reset":true,"remote_dir":"/sync_test","local_dir":"contents","host":"10.25.0.8","user":"user1","private_key_path":"/Users/laurent/.ssh/id_rsa"}]}'
923
1097
 
924
1098
  ...and more
925
1099
  ```
@@ -929,21 +1103,8 @@ A non complete list of commands used in unit tests:
929
1103
  ```bash
930
1104
  $ mlia -h
931
1105
  NAME
932
- mlia -- a command line tool for Aspera Applications (v0.9.26)
1106
+ mlia -- a command line tool for Aspera Applications (v0.9.27)
933
1107
 
934
- COMMAND: config
935
- SUBCOMMANDS: gem_path, genkey, plugins, flush_tokens, list, overview, open, echo, id, documentation, wizard, export_to_cli, detect, coffee, ascp
936
- OPTIONS:
937
- --value=VALUE extended value for create, update, list filter
938
- --property=VALUE name of property to set
939
- --id=VALUE resource identifier (modify,delete,show)
940
- --override=ENUM override existing value: yes, no
941
- --config-file=VALUE read parameters from file in YAML format, current=/Users/laurent/.aspera/mlia/config.yaml
942
- -N, --no-default do not load default configuration for plugin
943
- --use-generic-client=ENUM wizard: AoC: use global or org specific jwt client id: yes, no
944
- --pkeypath=VALUE path to private key for JWT (wizard)
945
- --ascp-path=VALUE path to ascp
946
- --use-product=VALUE use ascp from specified product
947
1108
  SYNOPSIS
948
1109
  mlia COMMANDS [OPTIONS] [ARGS]
949
1110
 
@@ -951,35 +1112,34 @@ DESCRIPTION
951
1112
  Use Aspera application to perform operations on command line.
952
1113
  Documentation and examples: https://rubygems.org/gems/asperalm
953
1114
  execute: mlia conf doc
1115
+ or visit: http://www.rubydoc.info/gems/asperalm
954
1116
 
955
1117
  COMMANDS
956
- First level commands:
1118
+ To list first level commands, execute: mlia
957
1119
  Note that commands can be written shortened (provided it is unique).
958
1120
 
959
1121
  OPTIONS
960
1122
  Options begin with a '-' (minus), and value is provided on command line.
961
- Special values are supported beginning with special prefix, like: @base64: @json: @zlib: @ruby: @csvt: @val: @file: @path: @env: @stdin: @preset:.
1123
+ Special values are supported beginning with special prefix, like: @base64: @json: @zlib: @ruby: @csvt: @val: @file: @path: @env: @stdin:.
962
1124
  Dates format is 'DD-MM-YY HH:MM:SS', or 'now' or '-<num>h'
963
1125
 
964
1126
  ARGS
965
1127
  Some commands require mandatory arguments, e.g. a path.
966
1128
 
967
1129
  OPTIONS: global
1130
+ --interactive=ENUM use interactive input of missing params: yes, no
1131
+ --ask-options=ENUM ask even optional options: yes, no
968
1132
  --table-style=VALUE table display style, current=:.:
969
- -h, --help Show this message.
970
1133
  --bash-comp generate bash completion for command
971
1134
  --show-config Display parameters used for the provided action.
972
1135
  -r, --rest-debug more debug for HTTP calls
973
1136
  -v, --version display version
974
1137
  -w, --warnings check for language warnings
975
1138
  --display=ENUM output only some information: info, data, error
976
- --interactive=ENUM use interactive input of missing params: yes, no
977
- --ask-options=ENUM ask even optional options: yes, no
978
1139
  --ui=ENUM method to start browser: text, graphical
979
1140
  --log-level=ENUM Log level: debug, info, warn, error, fatal, unknown
980
1141
  --logger=ENUM log method: stderr, stdout, syslog
981
1142
  --format=ENUM output format: table, ruby, json, jsonpp, yaml, csv, nagios
982
- -P, --presetVALUE load the named option preset from current config file
983
1143
  --fields=VALUE comma separated list of fields, or ALL, or DEF
984
1144
  --select=VALUE select only some items in lists, extended value: hash (colum, value)
985
1145
  --fasp-proxy=VALUE URL of FASP proxy (dnat / dnats)
@@ -989,21 +1149,41 @@ OPTIONS: global
989
1149
  --insecure=ENUM do not validate HTTPS certificate: yes, no
990
1150
  --flat-hash=ENUM display hash values as additional keys: yes, no
991
1151
  --once-only=ENUM process only new items (some commands): yes, no
1152
+ -h, --help Show this message.
992
1153
  --ts=VALUE override transfer spec values (Hash, use @json: prefix), current={}
993
1154
  --to-folder=VALUE destination folder for downloaded files
994
1155
  --sources=VALUE list of source files (see doc)
995
1156
  --transfer=ENUM type of transfer: direct, connect, node, aoc
996
1157
  --transfer-info=VALUE additional information for transfer client
997
1158
 
1159
+ COMMAND: config
1160
+ SUBCOMMANDS: gem_path genkey plugins flush_tokens list overview open echo id documentation wizard export_to_cli detect coffee ascp email_test smtp_settings proxy_check
1161
+ OPTIONS:
1162
+ --value=VALUE extended value for create, update, list filter
1163
+ --property=VALUE name of property to set
1164
+ --id=VALUE resource identifier (modify,delete,show)
1165
+ --config-file=VALUE read parameters from file in YAML format, current=/Users/laurent/.aspera/mlia/config.yaml
1166
+ --override=ENUM override existing value: yes, no
1167
+ -N, --no-default do not load default configuration for plugin
1168
+ --use-generic-client=ENUM wizard: AoC: use global or org specific jwt client id: yes, no
1169
+ --pkeypath=VALUE path to private key for JWT (wizard)
1170
+ --ascp-path=VALUE path to ascp
1171
+ --use-product=VALUE use ascp from specified product
1172
+ --smtp=VALUE smtp configuration (extended value: hash)
1173
+ --pac=VALUE proxy auto configuration URL
1174
+ -P, --presetVALUE load the named option preset from current config file
1175
+
1176
+
998
1177
  COMMAND: shares
999
- SUBCOMMANDS: repository, admin
1178
+ SUBCOMMANDS: repository admin
1000
1179
  OPTIONS:
1001
1180
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1002
1181
  --username=VALUE username to log in
1003
1182
  --password=VALUE user's password
1004
1183
 
1184
+
1005
1185
  COMMAND: node
1006
- SUBCOMMANDS: postprocess, stream, transfer, cleanup, forward, access_key, watch_folder, service, async, central, asperabrowser, browse, upload, download, nagios_check, events, space, info, mkdir, mklink, mkfile, rename, delete
1186
+ SUBCOMMANDS: postprocess stream transfer cleanup forward access_key watch_folder service async central asperabrowser browse upload download nagios_check events space info mkdir mklink mkfile rename delete
1007
1187
  OPTIONS:
1008
1188
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1009
1189
  --username=VALUE username to log in
@@ -1011,8 +1191,9 @@ OPTIONS:
1011
1191
  --validator=VALUE identifier of validator (optional for central)
1012
1192
  --asperabrowserurl=VALUE URL for simple aspera web ui
1013
1193
 
1194
+
1014
1195
  COMMAND: orchestrator
1015
- SUBCOMMANDS: info, workflow, plugins, processes
1196
+ SUBCOMMANDS: info workflow plugins processes
1016
1197
  OPTIONS:
1017
1198
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1018
1199
  --username=VALUE username to log in
@@ -1021,14 +1202,16 @@ OPTIONS:
1021
1202
  --result=VALUE specify result value as: 'work step:parameter'
1022
1203
  --synchronous=ENUM work step:parameter expected as result: yes, no
1023
1204
 
1205
+
1024
1206
  COMMAND: aspera
1025
- SUBCOMMANDS: apiinfo, bearer_token, organization, user, workspace, packages, files, faspexgw, admin
1207
+ SUBCOMMANDS: apiinfo bearer_token organization user workspace packages files faspexgw admin
1026
1208
  OPTIONS:
1027
1209
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1028
1210
  --username=VALUE username to log in
1029
1211
  --password=VALUE user's password
1212
+
1030
1213
  COMMAND: ats
1031
- SUBCOMMANDS: cluster, access_key, api_key
1214
+ SUBCOMMANDS: cluster access_key api_key
1032
1215
  OPTIONS:
1033
1216
  --ibm-api-key=VALUE IBM API key, see https://console.bluemix.net/iam/#/apikeys
1034
1217
  --instance=VALUE ATS instance in bluemix
@@ -1054,8 +1237,9 @@ OPTIONS:
1054
1237
  --scope=VALUE scope for AoC API calls
1055
1238
  --bulk=ENUM bulk operation: yes, no
1056
1239
 
1240
+
1057
1241
  COMMAND: xnode
1058
- SUBCOMMANDS: postprocess, cleanup, forward
1242
+ SUBCOMMANDS: postprocess cleanup forward
1059
1243
  OPTIONS:
1060
1244
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1061
1245
  --username=VALUE username to log in
@@ -1063,8 +1247,9 @@ OPTIONS:
1063
1247
  --filter-transfer=VALUE Ruby expression for filter at transfer level (cleanup)
1064
1248
  --filter-file=VALUE Ruby expression for filter at file level (cleanup)
1065
1249
 
1250
+
1066
1251
  COMMAND: ats
1067
- SUBCOMMANDS: cluster, access_key, api_key
1252
+ SUBCOMMANDS: cluster access_key api_key
1068
1253
  OPTIONS:
1069
1254
  --secret=VALUE Access key secret
1070
1255
  --ibm-api-key=VALUE IBM API key, see https://console.bluemix.net/iam/#/apikeys
@@ -1075,8 +1260,9 @@ OPTIONS:
1075
1260
  --cloud=VALUE Cloud provider
1076
1261
  --region=VALUE Cloud region
1077
1262
 
1263
+
1078
1264
  COMMAND: faspex
1079
- SUBCOMMANDS: nagios_check, package, source, me, dropbox, recv_publink, v4, address_book, login_methods
1265
+ SUBCOMMANDS: nagios_check package source me dropbox recv_publink v4 address_book login_methods
1080
1266
  OPTIONS:
1081
1267
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1082
1268
  --username=VALUE username to log in
@@ -1086,8 +1272,9 @@ OPTIONS:
1086
1272
  --storage=VALUE Faspex local storage definition
1087
1273
  --box=ENUM package box: inbox, sent, archive
1088
1274
 
1275
+
1089
1276
  COMMAND: shares2
1090
- SUBCOMMANDS: repository, organization, project, team, share, appinfo, userinfo, admin
1277
+ SUBCOMMANDS: repository organization project team share appinfo userinfo admin
1091
1278
  OPTIONS:
1092
1279
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1093
1280
  --username=VALUE username to log in
@@ -1096,8 +1283,9 @@ OPTIONS:
1096
1283
  --project=VALUE project
1097
1284
  --share=VALUE share
1098
1285
 
1286
+
1099
1287
  COMMAND: preview
1100
- SUBCOMMANDS: scan, events, folder, check, test
1288
+ SUBCOMMANDS: scan events folder check test
1101
1289
  OPTIONS:
1102
1290
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1103
1291
  --username=VALUE username to log in
@@ -1131,22 +1319,25 @@ OPTIONS:
1131
1319
  --validate-mime=ENUM use magic number validation: yes, no
1132
1320
  --check-extension=ENUM check extra file extensions: yes, no
1133
1321
 
1322
+
1134
1323
  COMMAND: sync
1135
- SUBCOMMANDS: start, admin
1324
+ SUBCOMMANDS: start admin
1136
1325
  OPTIONS:
1137
1326
  --parameters=VALUE extended value for session set definition
1138
1327
  --session-name=VALUE name of session to use for admin commands, by default first one
1139
1328
 
1329
+
1140
1330
  COMMAND: server
1141
- SUBCOMMANDS: nagios, nodeadmin, userdata, configurator, ctl, download, upload, browse, delete, rename, ls, rm, mv, du, info, mkdir, cp, df, md5sum
1331
+ SUBCOMMANDS: nagios nodeadmin userdata configurator ctl download upload browse delete rename ls rm mv du info mkdir cp df md5sum
1142
1332
  OPTIONS:
1143
1333
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1144
1334
  --username=VALUE username to log in
1145
1335
  --password=VALUE user's password
1146
1336
  --ssh-keys=VALUE one ssh key at a time
1147
1337
 
1338
+
1148
1339
  COMMAND: console
1149
- SUBCOMMANDS: transfer, nagios_check
1340
+ SUBCOMMANDS: transfer nagios_check
1150
1341
  OPTIONS:
1151
1342
  --url=VALUE URL of application, e.g. https://org.asperafiles.com
1152
1343
  --username=VALUE username to log in
@@ -1154,8 +1345,6 @@ OPTIONS:
1154
1345
  --filter-from=DATE only after date
1155
1346
  --filter-to=DATE only before date
1156
1347
 
1157
- Documentation : http://www.rubydoc.info/gems/asperalm
1158
-
1159
1348
 
1160
1349
  ```
1161
1350
 
@@ -2066,6 +2255,53 @@ chkconfig xvfb on
2066
2255
  service xvfb start
2067
2256
  ```
2068
2257
 
2258
+ # SMTP for email notifications
2259
+
2260
+ Amelia can send email, for that setup SMTP configuration. This is done with option `smtp`.
2261
+
2262
+ The `smtp` option is a hash table (extended value) with the following fields:
2263
+ <table>
2264
+ <tr><th>field</th><th>default</th><th>example</th><th>description</th></tr>
2265
+ <tr><td>server</td><td>-</td><td>smtp.gmail.com</td><td>SMTP server address</td></tr>
2266
+ <tr><td>tls</td><td>true</td><td>false</td><td>use of TLS</td></tr>
2267
+ <tr><td>port</td><td>587 for tls<br/>25 else</td><td>587</td><td>port for service</td></tr>
2268
+ <tr><td>domain</td><td>domain of server</td><td>gmail.com</td><td>email domain of user</td></tr>
2269
+ <tr><td>username</td><td>-</td><td>john@example.com</td><td>user to authenticate on SMTP server, leave empty for open auth.</td></tr>
2270
+ <tr><td>password</td><td>-</td><td>Aspera123_</td><td>password for above username</td></tr>
2271
+ <tr><td>from\_email</td><td>username if defined</td><td>laurent.martin.l@gmail.com</td><td>address used if received replies</td></tr>
2272
+ <tr><td>from\_name</td><td>same as email</td><td>John Wayne</td><td>display name of sender</td></tr>
2273
+ </table>
2274
+
2275
+ ## Example of configuration:
2276
+
2277
+ ```
2278
+ $ mlia config id smtp_google set server smtp.google.com
2279
+ $ mlia config id smtp_google set username john@gmail.com
2280
+ $ mlia config id smtp_google set password P@ssw0rd
2281
+ ```
2282
+
2283
+ or
2284
+
2285
+ ```
2286
+ $ mlia config id smtp_google init @json:'{"server":"smtp.google.com","username":"john@gmail.com","password":"P@ssw0rd"}'
2287
+ ```
2288
+
2289
+ Set this configation as global default, for instance:
2290
+
2291
+ ```
2292
+ $ mlia config id cli_default set smtp @val:@preset:smtp_google
2293
+ $ mlia config id default set config cli_default
2294
+ ```
2295
+
2296
+ ## Test
2297
+
2298
+ Check settings with `smtp_settings` command. Send test email with `email_test`.
2299
+
2300
+ ```
2301
+ $ mlia config --smtp=@preset:smtp_google smtp
2302
+ $ mlia config --smtp=@preset:smtp_google email sample.dest@example.com
2303
+ ```
2304
+
2069
2305
  # Tool: `asession`
2070
2306
 
2071
2307
  This gem comes with a second executable tool providing a simplified standardized interface
@@ -2258,6 +2494,11 @@ Gems, or remove your ed25519 key from your `.ssh` folder to solve the issue. Not
2258
2494
 
2259
2495
  # Release Notes
2260
2496
 
2497
+ * version 0.9.27
2498
+
2499
+ * basic email support with SMTP
2500
+ * basic proxy auto config support
2501
+
2261
2502
  * version 0.9.26
2262
2503
 
2263
2504
  * table display with --fields=ALL now includes all column names from all lines, not only first one