aspera-cli 4.28.0 → 4.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +143 -2
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +135 -56
- data/GOVERNANCE.md +30 -0
- data/LICENSE +201 -0
- data/README.md +103 -26
- data/SECURITY.md +70 -0
- data/bin/ascli +8 -5
- data/bin/asession +9 -6
- data/docs/README.md +1633 -609
- data/docs/test-mcp-with-ai.md +8 -8
- data/lib/aspera/agent/base.rb +23 -2
- data/lib/aspera/agent/connect.rb +16 -12
- data/lib/aspera/agent/desktop.rb +10 -7
- data/lib/aspera/agent/direct.rb +20 -19
- data/lib/aspera/agent/factory.rb +6 -3
- data/lib/aspera/agent/httpgw.rb +7 -5
- data/lib/aspera/agent/node.rb +15 -7
- data/lib/aspera/agent/transferd.rb +167 -43
- data/lib/aspera/api/alee.rb +4 -1
- data/lib/aspera/api/aoc.rb +14 -11
- data/lib/aspera/api/ats.rb +4 -2
- data/lib/aspera/api/cos_node.rb +7 -4
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +20 -20
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +71 -65
- data/lib/aspera/ascp/log.schema.yaml +1084 -0
- data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
- data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
- data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
- data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
- data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
- data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
- data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
- data/lib/aspera/ascp/log_analyzer.rb +354 -0
- data/lib/aspera/ascp/management.rb +16 -8
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +12 -19
- data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
- data/lib/aspera/cli/async_transfer_store.rb +7 -4
- data/lib/aspera/cli/bootstrapper.rb +37 -33
- data/lib/aspera/cli/command_line.rb +24 -6
- data/lib/aspera/cli/command_registry.rb +6 -1
- data/lib/aspera/cli/command_spec.rb +34 -7
- data/lib/aspera/cli/completion/ascli.bash +19 -5
- data/lib/aspera/cli/completion/ascli.fish +13 -2
- data/lib/aspera/cli/completion/ascli.ps1 +31 -9
- data/lib/aspera/cli/completion/ascli.zsh +22 -6
- data/lib/aspera/cli/completion_actions.rb +303 -69
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +3 -0
- data/lib/aspera/cli/extended_value.rb +61 -27
- data/lib/aspera/cli/formatter.rb +29 -22
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -10
- data/lib/aspera/cli/http.rb +12 -9
- data/lib/aspera/cli/info.rb +12 -7
- data/lib/aspera/cli/mailer.rb +6 -3
- data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
- data/lib/aspera/cli/mcp/secrets.rb +8 -5
- data/lib/aspera/cli/mcp/tool.rb +15 -14
- data/lib/aspera/cli/option_declarator.rb +10 -4
- data/lib/aspera/cli/option_registry.rb +6 -3
- data/lib/aspera/cli/option_types.rb +17 -2
- data/lib/aspera/cli/option_value.rb +65 -12
- data/lib/aspera/cli/options.schema.yaml +487 -63
- data/lib/aspera/cli/parser.rb +56 -32
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +244 -35
- data/lib/aspera/cli/plugins/ats.rb +9 -8
- data/lib/aspera/cli/plugins/base.rb +17 -12
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +198 -103
- data/lib/aspera/cli/plugins/console.rb +6 -3
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +21 -7
- data/lib/aspera/cli/plugins/faspex5.rb +28 -25
- data/lib/aspera/cli/plugins/faspio.rb +7 -5
- data/lib/aspera/cli/plugins/httpgw.rb +7 -4
- data/lib/aspera/cli/plugins/mcp.rb +28 -22
- data/lib/aspera/cli/plugins/node.rb +31 -30
- data/lib/aspera/cli/plugins/oauth.rb +5 -1
- data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
- data/lib/aspera/cli/plugins/preview.rb +69 -44
- data/lib/aspera/cli/plugins/server.rb +63 -11
- data/lib/aspera/cli/plugins/shares.rb +86 -16
- data/lib/aspera/cli/plugins/transferd.rb +223 -0
- data/lib/aspera/cli/preset_actions.rb +144 -30
- data/lib/aspera/cli/preset_manager.rb +52 -18
- data/lib/aspera/cli/prompt.rb +4 -1
- data/lib/aspera/cli/result.rb +12 -8
- data/lib/aspera/cli/runner.rb +69 -46
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +79 -9
- data/lib/aspera/cli/special_values.rb +4 -1
- data/lib/aspera/cli/sync_actions.rb +13 -10
- data/lib/aspera/cli/table_fitter.rb +3 -0
- data/lib/aspera/cli/terminal_formatter.rb +9 -6
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +29 -20
- data/lib/aspera/cli/transfer_progress.rb +13 -45
- data/lib/aspera/cli/vault_actions.rb +45 -0
- data/lib/aspera/cli/vault_manager.rb +188 -42
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.rb +12 -10
- data/lib/aspera/cli/wizard.rb +42 -39
- data/lib/aspera/command_line_builder.rb +9 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +4 -1
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/duration.rb +5 -2
- data/lib/aspera/environment.rb +21 -12
- data/lib/aspera/exec_spec.rb +3 -0
- data/lib/aspera/faspex_gw.rb +13 -9
- data/lib/aspera/faspex_postproc.rb +15 -12
- data/lib/aspera/formatter_interface.rb +4 -1
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +4 -2
- data/lib/aspera/json_rpc/client.rb +6 -5
- data/lib/aspera/json_rpc/version.rb +3 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +18 -5
- data/lib/aspera/markdown.rb +5 -2
- data/lib/aspera/mime.rb +3 -0
- data/lib/aspera/nagios.rb +6 -4
- data/lib/aspera/node_emulator.rb +15 -13
- data/lib/aspera/oauth/client/base.rb +91 -70
- data/lib/aspera/oauth/client/boot.rb +7 -4
- data/lib/aspera/oauth/client/factory.rb +6 -3
- data/lib/aspera/oauth/client/generic.rb +5 -1
- data/lib/aspera/oauth/client/json_credentials.rb +4 -1
- data/lib/aspera/oauth/client/jwt.rb +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +85 -0
- data/lib/aspera/oauth/client/url_json.rb +4 -1
- data/lib/aspera/oauth/client/web.rb +39 -12
- data/lib/aspera/oauth/server/pkce.rb +6 -5
- data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
- data/lib/aspera/persistency_action_once.rb +5 -3
- data/lib/aspera/persistency_folder.rb +6 -3
- data/lib/aspera/preview/file_types.rb +6 -3
- data/lib/aspera/preview/generator.rb +9 -5
- data/lib/aspera/preview/options.schema.yaml +3 -3
- data/lib/aspera/preview/terminal.rb +8 -4
- data/lib/aspera/preview/utils.rb +6 -4
- data/lib/aspera/products/connect.rb +5 -2
- data/lib/aspera/products/desktop.rb +4 -1
- data/lib/aspera/products/other.rb +4 -2
- data/lib/aspera/products/transferd.rb +6 -2
- data/lib/aspera/products/transferd_service.rb +610 -0
- data/lib/aspera/proxy_auto_config.js +2 -2
- data/lib/aspera/proxy_auto_config.rb +5 -2
- data/lib/aspera/rainbow.rb +3 -0
- data/lib/aspera/rest/aspera_errors.rb +4 -1
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +22 -29
- data/lib/aspera/rest/error_analyzer.rb +5 -2
- data/lib/aspera/rest/list.rb +8 -4
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +8 -5
- data/lib/aspera/rest.rb +9 -6
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
- data/lib/aspera/schema/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +8 -2
- data/lib/aspera/schema/reader.rb +7 -0
- data/lib/aspera/schema/registry.rb +43 -28
- data/lib/aspera/schema/transferd-config.schema.json +333 -0
- data/lib/aspera/schema/validator.rb +4 -1
- data/lib/aspera/sealed_hash.rb +166 -0
- data/lib/aspera/secret/hider.rb +201 -0
- data/lib/aspera/secret/reference.rb +150 -0
- data/lib/aspera/secret/resolver.rb +212 -0
- data/lib/aspera/secret/store/base.rb +153 -0
- data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
- data/lib/aspera/secret/store/factory.rb +103 -0
- data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
- data/lib/aspera/secret/store/keeper.rb +141 -0
- data/lib/aspera/secret/store/macos_security.rb +284 -0
- data/lib/aspera/secret/store/one_password_api.rb +99 -0
- data/lib/aspera/secret/store/one_password_base.rb +42 -0
- data/lib/aspera/secret/store/one_password_cli.rb +110 -0
- data/lib/aspera/secret/store/secret_service.rb +125 -0
- data/lib/aspera/secret/strength.rb +119 -0
- data/lib/aspera/servlet_helpers.rb +5 -2
- data/lib/aspera/ssh.rb +10 -7
- data/lib/aspera/ssl.rb +5 -2
- data/lib/aspera/string_ext.rb +3 -0
- data/lib/aspera/sync/args.schema.yaml +3 -0
- data/lib/aspera/sync/conf.schema.yaml +9 -4
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +16 -14
- data/lib/aspera/temp_file_manager.rb +8 -4
- data/lib/aspera/timer_limiter.rb +3 -0
- data/lib/aspera/transfer/error.rb +4 -1
- data/lib/aspera/transfer/faux_file.rb +4 -1
- data/lib/aspera/transfer/parameters.rb +17 -14
- data/lib/aspera/transfer/result.rb +3 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +9 -22
- data/lib/aspera/transfer/units.rb +75 -0
- data/lib/aspera/uri_reader.rb +57 -7
- data/lib/aspera/web_auth/index.html.erb +6 -2
- data/lib/aspera/web_auth/paste.rb +109 -0
- data/lib/aspera/web_auth/receiver.rb +50 -0
- data/lib/aspera/web_auth/relay.rb +76 -0
- data/lib/aspera/web_auth/reply.html.erb +150 -0
- data/lib/aspera/web_auth/server.rb +47 -10
- data/lib/aspera/web_page.rb +7 -2
- data/lib/aspera/web_server_simple.rb +6 -3
- data/lib/aspera/yaml.rb +5 -1
- data/llms.txt +81 -0
- data/skills/ascli/SKILL.md +88 -0
- data.tar.gz.sig +0 -0
- metadata +72 -19
- metadata.gz.sig +0 -0
- data/lib/aspera/keychain/base.rb +0 -30
- data/lib/aspera/keychain/encrypted_hash.rb +0 -192
- data/lib/aspera/keychain/factory.rb +0 -58
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
- data/lib/aspera/keychain/macos_security.rb +0 -277
- data/lib/aspera/keychain/one_password_api.rb +0 -91
- data/lib/aspera/keychain/one_password_base.rb +0 -39
- data/lib/aspera/keychain/one_password_cli.rb +0 -100
- data/lib/aspera/secret_hider.rb +0 -196
- data/lib/aspera/secret_strength.rb +0 -114
|
@@ -1,8 +1,11 @@
|
|
|
1
|
-
openapi: 3.
|
|
1
|
+
openapi: 3.1.0
|
|
2
2
|
info:
|
|
3
3
|
title: Aspera CLI Options Schema
|
|
4
4
|
version: 1.0.0
|
|
5
5
|
description: Schema definitions for Aspera CLI options
|
|
6
|
+
license:
|
|
7
|
+
name: Apache-2.0
|
|
8
|
+
identifier: Apache-2.0
|
|
6
9
|
paths: {}
|
|
7
10
|
components:
|
|
8
11
|
schemas:
|
|
@@ -39,10 +42,15 @@ components:
|
|
|
39
42
|
mode:
|
|
40
43
|
type: string
|
|
41
44
|
description: >-
|
|
42
|
-
`auto`: `browser` on Windows and macOS, or if env var `DISPLAY` is set, else `terminal`.
|
|
43
|
-
|
|
44
|
-
`
|
|
45
|
+
- `auto`: `browser` on Windows and macOS, or if env var `DISPLAY` is set, else `terminal`.
|
|
46
|
+
|
|
47
|
+
- `terminal`: URLs to open are displayed on terminal, and secrets are entered on terminal.
|
|
48
|
+
|
|
49
|
+
- `browser`: a browser opens URLs, and secrets are entered on a web page.
|
|
50
|
+
|
|
45
51
|
`text` is an alias for `terminal`, and `graphical` is an alias for `browser`.
|
|
52
|
+
|
|
53
|
+
Files to edit are always opened with a text editor, whatever the `mode`.
|
|
46
54
|
enum:
|
|
47
55
|
- auto
|
|
48
56
|
- terminal
|
|
@@ -50,11 +58,27 @@ components:
|
|
|
50
58
|
- text
|
|
51
59
|
- graphical
|
|
52
60
|
default: auto
|
|
61
|
+
web_auth:
|
|
62
|
+
type: string
|
|
63
|
+
description: >-
|
|
64
|
+
How the result of a web login (`--auth=web`, SSO) is received.
|
|
65
|
+
|
|
66
|
+
- `port`: `ascli` listens on the loopback port of `redirect_uri`, the browser is redirected to it.
|
|
67
|
+
|
|
68
|
+
- `paste`: no port is opened. After login, the browser shows a connection error on `redirect_uri`:
|
|
69
|
+
copy the full URL from the address bar of the browser and paste it in the terminal.
|
|
70
|
+
Use it when the browser cannot reach the host that runs `ascli` and a SSH tunnel is not possible.
|
|
71
|
+
For `shares`, Shares displays a code (a long text of letters, digits, `-` and `_`) instead: paste it in the terminal.
|
|
72
|
+
enum:
|
|
73
|
+
- port
|
|
74
|
+
- paste
|
|
75
|
+
default: port
|
|
53
76
|
command:
|
|
54
77
|
type: array
|
|
78
|
+
x-security: low
|
|
55
79
|
description: >-
|
|
56
80
|
Command that opens a URL, instead of the system default.
|
|
57
|
-
First item is the executable, then its arguments. The URL is added as last argument.
|
|
81
|
+
First item is the executable (full path, or name of an executable found in `PATH`), then its arguments. The URL is added as last argument.
|
|
58
82
|
When set, it is used to open URLs, whatever the `mode`.
|
|
59
83
|
items:
|
|
60
84
|
type: string
|
|
@@ -69,9 +93,13 @@ components:
|
|
|
69
93
|
level:
|
|
70
94
|
type: string
|
|
71
95
|
description: >-
|
|
72
|
-
`low`: no restriction.
|
|
73
|
-
|
|
74
|
-
`
|
|
96
|
+
- `low`: no restriction.
|
|
97
|
+
|
|
98
|
+
- `medium`: `@file:` reads only files in `allowed_paths`, `@ruby:`, `@uri:` and `@env:` are refused, files are written only in `writable_paths`.
|
|
99
|
+
|
|
100
|
+
- `high`: `@ruby:`, `@file:`, `@uri:` and `@env:` are refused, files are written only in `writable_paths`.
|
|
101
|
+
|
|
102
|
+
Features that execute code, load plugins, or write a file chosen by the client (e.g. `--out.file`) are available only at level `low`.
|
|
75
103
|
enum:
|
|
76
104
|
- low
|
|
77
105
|
- medium
|
|
@@ -83,6 +111,13 @@ components:
|
|
|
83
111
|
A symbolic link leading outside of them is refused.
|
|
84
112
|
items:
|
|
85
113
|
type: string
|
|
114
|
+
writable_paths:
|
|
115
|
+
type: array
|
|
116
|
+
description: >-
|
|
117
|
+
With levels `medium` and `high`: folders where files can be written (downloaded files, results of `config download`), none by default.
|
|
118
|
+
A symbolic link leading outside of them is refused.
|
|
119
|
+
items:
|
|
120
|
+
type: string
|
|
86
121
|
TempOptions:
|
|
87
122
|
type: object
|
|
88
123
|
description: >-
|
|
@@ -92,10 +127,13 @@ components:
|
|
|
92
127
|
properties:
|
|
93
128
|
folder:
|
|
94
129
|
type: string
|
|
130
|
+
x-cli-complete: folder
|
|
95
131
|
description: >-
|
|
96
132
|
Folder for temporary files, e.g. certificate for WSS transfers, logs of `transferd`.
|
|
97
|
-
|
|
98
|
-
`@
|
|
133
|
+
|
|
134
|
+
- `@sys`: temporary folder of the system for the current user (Ruby `Etc.systmpdir`).
|
|
135
|
+
|
|
136
|
+
- `@env`: from environment variables, e.g. `TMPDIR` (Ruby `Dir.tmpdir`).
|
|
99
137
|
default: '@sys'
|
|
100
138
|
clean:
|
|
101
139
|
type: boolean
|
|
@@ -273,12 +311,10 @@ components:
|
|
|
273
311
|
default: []
|
|
274
312
|
spawn_timeout_sec:
|
|
275
313
|
type: number
|
|
276
|
-
format: float
|
|
277
314
|
description: Multi session - Maximum time (in seconds) to verify that `ascp` is running.
|
|
278
315
|
default: 2
|
|
279
316
|
spawn_delay_sec:
|
|
280
317
|
type: number
|
|
281
|
-
format: float
|
|
282
318
|
description: Multi session - Delay (in seconds) between starting each `ascp` session.
|
|
283
319
|
default: 2
|
|
284
320
|
multi_incr_udp:
|
|
@@ -390,6 +426,16 @@ components:
|
|
|
390
426
|
type: boolean
|
|
391
427
|
description: Stop the daemon when `ascli` exits.
|
|
392
428
|
default: true
|
|
429
|
+
api_key:
|
|
430
|
+
type: string
|
|
431
|
+
description: >-
|
|
432
|
+
API key of an existing daemon (`start` is `false`) that has `authentication` enabled in its configuration.
|
|
433
|
+
It is sent in the metadata `api_key` of each call.
|
|
434
|
+
ca_file:
|
|
435
|
+
type: string
|
|
436
|
+
description: >-
|
|
437
|
+
Path to the certificate authority file (PEM) that signed the certificate of an existing daemon (`start` is `false`)
|
|
438
|
+
that has `tls` enabled in its configuration. A self-signed certificate is its own authority.
|
|
393
439
|
TransferAgentOptions:
|
|
394
440
|
description: >-
|
|
395
441
|
Transfer agent selector and agent-specific parameters.
|
|
@@ -420,7 +466,8 @@ components:
|
|
|
420
466
|
server:
|
|
421
467
|
type: string
|
|
422
468
|
description: SMTP server address.
|
|
423
|
-
|
|
469
|
+
examples:
|
|
470
|
+
- smtp.gmail.com
|
|
424
471
|
tls:
|
|
425
472
|
type: boolean
|
|
426
473
|
description: Enable `STARTTLS` (port 587).
|
|
@@ -435,29 +482,102 @@ components:
|
|
|
435
482
|
Port for the SMTP service.
|
|
436
483
|
|
|
437
484
|
Defaults: `587` (TLS), `465` (SSL), `25` (plain).
|
|
438
|
-
|
|
485
|
+
examples:
|
|
486
|
+
- 587
|
|
439
487
|
domain:
|
|
440
488
|
type: string
|
|
441
489
|
description: Email domain of the user. Defaults to the domain part of `server`.
|
|
442
|
-
|
|
490
|
+
examples:
|
|
491
|
+
- gmail.com
|
|
443
492
|
username:
|
|
444
493
|
type: string
|
|
445
494
|
description: >-
|
|
446
495
|
User to authenticate on the SMTP server.
|
|
447
496
|
Leave empty for open (unauthenticated) relay.
|
|
448
|
-
|
|
497
|
+
examples:
|
|
498
|
+
- john@example.com
|
|
449
499
|
password:
|
|
450
500
|
type: string
|
|
451
501
|
description: Password for the above `username`.
|
|
452
|
-
|
|
502
|
+
examples:
|
|
503
|
+
- "<PASSWORD>"
|
|
453
504
|
from_email:
|
|
454
505
|
type: string
|
|
455
506
|
description: Sender address (used in `From:` header and as reply-to). Defaults to `username` when defined.
|
|
456
|
-
|
|
507
|
+
examples:
|
|
508
|
+
- johnny@example.com
|
|
457
509
|
from_name:
|
|
458
510
|
type: string
|
|
459
511
|
description: Display name of the sender. Defaults to the local-part of `from_email`.
|
|
460
|
-
|
|
512
|
+
examples:
|
|
513
|
+
- John Wayne
|
|
514
|
+
ServiceOptions:
|
|
515
|
+
type: object
|
|
516
|
+
description: >-
|
|
517
|
+
Installation parameters of the transfer daemon (`transferd`) as a system service.
|
|
518
|
+
The content of the daemon configuration file is described by its own schema.
|
|
519
|
+
additionalProperties: false
|
|
520
|
+
properties:
|
|
521
|
+
name:
|
|
522
|
+
type: string
|
|
523
|
+
description: >-
|
|
524
|
+
Name of the service.
|
|
525
|
+
The unit file is `<name>.service`.
|
|
526
|
+
default: aspera-transferd
|
|
527
|
+
minLength: 1
|
|
528
|
+
user:
|
|
529
|
+
type: string
|
|
530
|
+
description: >-
|
|
531
|
+
Account that runs the daemon.
|
|
532
|
+
It must exist, it is not created.
|
|
533
|
+
default: asperadaemon
|
|
534
|
+
minLength: 1
|
|
535
|
+
group:
|
|
536
|
+
type: string
|
|
537
|
+
description: Group that runs the daemon. Defaults to the primary group of `user`.
|
|
538
|
+
minLength: 1
|
|
539
|
+
unit_dir:
|
|
540
|
+
type: string
|
|
541
|
+
description: Folder where the unit file is created.
|
|
542
|
+
default: /etc/systemd/system
|
|
543
|
+
minLength: 1
|
|
544
|
+
after:
|
|
545
|
+
type: array
|
|
546
|
+
description: Units that shall be started before the daemon (`After=` in the unit).
|
|
547
|
+
items:
|
|
548
|
+
type: string
|
|
549
|
+
default:
|
|
550
|
+
- network.target
|
|
551
|
+
environment:
|
|
552
|
+
type: object
|
|
553
|
+
description: >-
|
|
554
|
+
Environment variables set in the unit.
|
|
555
|
+
None is set unless given here.
|
|
556
|
+
`TRANSFERD_ADDRESS`, `TRANSFERD_PORT`, `TRANSFERD_MGMT_PORT` and `TRANSFERD_MGMT_ADDRESS` override the configuration file.
|
|
557
|
+
additionalProperties:
|
|
558
|
+
type: string
|
|
559
|
+
version:
|
|
560
|
+
type: string
|
|
561
|
+
description: >-
|
|
562
|
+
Version of the SDK to install, used by `install` when the SDK folder is named `current` (versions side by side).
|
|
563
|
+
Defaults to the SDK version of this tool.
|
|
564
|
+
pattern: '^\d+(\.\d+)*$'
|
|
565
|
+
purge:
|
|
566
|
+
type: boolean
|
|
567
|
+
description: Used by `uninstall`. Also remove the configuration file and the log folder.
|
|
568
|
+
default: false
|
|
569
|
+
TransferdServiceConfig:
|
|
570
|
+
type: object
|
|
571
|
+
description: >-
|
|
572
|
+
Configuration of the transfer daemon (`transferd`) as a system service.
|
|
573
|
+
additionalProperties: false
|
|
574
|
+
properties:
|
|
575
|
+
service:
|
|
576
|
+
$ref: "#/components/schemas/ServiceOptions"
|
|
577
|
+
config:
|
|
578
|
+
type: object
|
|
579
|
+
description: >-
|
|
580
|
+
Content of `transferd.json`, validated against the transfer daemon configuration schema.
|
|
461
581
|
HttpOptions:
|
|
462
582
|
type: object
|
|
463
583
|
description: >-
|
|
@@ -528,7 +648,11 @@ components:
|
|
|
528
648
|
default: 120
|
|
529
649
|
VaultHashicorpOptions:
|
|
530
650
|
type: object
|
|
531
|
-
description:
|
|
651
|
+
description: >-
|
|
652
|
+
IBM HashiCorp Vault secret store.
|
|
653
|
+
Labels of `config vault` and `@vault:<label>.<field>` are in mount `secret` (KV v2).
|
|
654
|
+
Reference `@vault://<store>/<mount>/<path>#<field>` (field required) in any KV v2 mount, options `version=<n>`, `mount=<mount>` (when the mount contains `/`).
|
|
655
|
+
additionalProperties: false
|
|
532
656
|
required:
|
|
533
657
|
- type
|
|
534
658
|
- url
|
|
@@ -540,14 +664,49 @@ components:
|
|
|
540
664
|
url:
|
|
541
665
|
type: string
|
|
542
666
|
description: URL of the HashiCorp Vault server.
|
|
543
|
-
|
|
667
|
+
examples:
|
|
668
|
+
- "http://127.0.0.1:8200"
|
|
544
669
|
token:
|
|
545
670
|
type: string
|
|
546
|
-
description:
|
|
547
|
-
|
|
671
|
+
description: >-
|
|
672
|
+
The authentication token. Its value, or `@file:<path>` (e.g. written and renewed by Vault Agent), read again when modified.
|
|
673
|
+
One of `token` or `approle` is required.
|
|
674
|
+
For the default store, defaults to the value of `vault_password`, unless `approle` is set.
|
|
675
|
+
examples:
|
|
676
|
+
- "<TOKEN>"
|
|
677
|
+
approle:
|
|
678
|
+
type: object
|
|
679
|
+
description: >-
|
|
680
|
+
AppRole authentication: the token is obtained by login, renewed, and obtained again when refused.
|
|
681
|
+
properties:
|
|
682
|
+
role_id:
|
|
683
|
+
type: string
|
|
684
|
+
description: Role ID.
|
|
685
|
+
secret_id:
|
|
686
|
+
type: string
|
|
687
|
+
description: "Secret ID (if the role requires one): the value, or `@file:<path>`."
|
|
688
|
+
mount:
|
|
689
|
+
type: string
|
|
690
|
+
description: Mount path of the AppRole auth method.
|
|
691
|
+
default: approle
|
|
692
|
+
required:
|
|
693
|
+
- role_id
|
|
694
|
+
namespace:
|
|
695
|
+
type: string
|
|
696
|
+
description: Namespace (Vault Enterprise).
|
|
697
|
+
ca_file:
|
|
698
|
+
type: string
|
|
699
|
+
x-cli-complete: file
|
|
700
|
+
description: File with the CA certificates that verify the certificate of the server (HTTPS).
|
|
701
|
+
allowed_prefixes:
|
|
702
|
+
type: array
|
|
703
|
+
description: "Allowed prefixes of `<mount>/<path>` of references: a prefix ending with `/` is a folder, else a path or a folder. All paths are allowed if not set."
|
|
704
|
+
items:
|
|
705
|
+
type: string
|
|
548
706
|
VaultSystemOptions:
|
|
549
707
|
type: object
|
|
550
708
|
description: macOS system keychain secret store.
|
|
709
|
+
additionalProperties: false
|
|
551
710
|
required:
|
|
552
711
|
- type
|
|
553
712
|
properties:
|
|
@@ -559,9 +718,25 @@ components:
|
|
|
559
718
|
type: string
|
|
560
719
|
description: Name of the keychain to use (file `<name>.keychain-db` in the keychain search list).
|
|
561
720
|
default: ascli
|
|
721
|
+
VaultSecretServiceOptions:
|
|
722
|
+
type: object
|
|
723
|
+
description: Linux Secret Service secret store (GNOME Keyring, KWallet, KeePassXC...), using `secret-tool`.
|
|
724
|
+
additionalProperties: false
|
|
725
|
+
required:
|
|
726
|
+
- type
|
|
727
|
+
properties:
|
|
728
|
+
type:
|
|
729
|
+
type: string
|
|
730
|
+
description: Vault type selector.
|
|
731
|
+
enum: [secret_service]
|
|
732
|
+
name:
|
|
733
|
+
type: string
|
|
734
|
+
description: Name of the group of secrets (attribute `service` of the items).
|
|
735
|
+
default: ascli
|
|
562
736
|
VaultOnePasswordOptions:
|
|
563
737
|
type: object
|
|
564
738
|
description: 1Password secret store (Connect REST API or CLI).
|
|
739
|
+
additionalProperties: false
|
|
565
740
|
required:
|
|
566
741
|
- type
|
|
567
742
|
- source
|
|
@@ -578,22 +753,46 @@ components:
|
|
|
578
753
|
url:
|
|
579
754
|
type: string
|
|
580
755
|
description: Base URL of the 1Password Connect server (required when `source` is `api`).
|
|
581
|
-
|
|
756
|
+
examples:
|
|
757
|
+
- "http://localhost:8080"
|
|
582
758
|
vault_id:
|
|
583
759
|
type: string
|
|
584
760
|
description: ID of the 1Password vault to use (required when `source` is `api`).
|
|
585
761
|
token:
|
|
586
762
|
type: string
|
|
587
|
-
description: Bearer token for the Connect API (required when `source` is `api`).
|
|
763
|
+
description: Bearer token for the Connect API (required when `source` is `api`). For the default store, defaults to the value of `vault_password`.
|
|
588
764
|
vault:
|
|
589
765
|
type: string
|
|
590
766
|
description: Name or ID of the 1Password vault to use with the CLI (used when `source` is `cli`). Uses the default vault if omitted.
|
|
591
767
|
account:
|
|
592
768
|
type: string
|
|
593
769
|
description: Account shorthand for `op` (used when `source` is `cli`). Uses the default account if omitted.
|
|
770
|
+
VaultKeeperOptions:
|
|
771
|
+
type: object
|
|
772
|
+
description: >-
|
|
773
|
+
Keeper Secrets Manager secret store (Keeper Vault), using gem `keeper_secrets_manager`.
|
|
774
|
+
A secret is a record shared with the application: its label is its title or its UID.
|
|
775
|
+
Reference `@vault://<store>/<title or uid>[#<field>]`, field `password` by default: standard field by type (`login`, `password`, `url`...), custom field by label, or `notes`.
|
|
776
|
+
additionalProperties: false
|
|
777
|
+
required:
|
|
778
|
+
- type
|
|
779
|
+
properties:
|
|
780
|
+
type:
|
|
781
|
+
type: string
|
|
782
|
+
description: Vault type selector.
|
|
783
|
+
enum: [keeper]
|
|
784
|
+
config:
|
|
785
|
+
type: string
|
|
786
|
+
description: >-
|
|
787
|
+
Configuration of the client device (base64 or JSON, e.g. from `ksm profile export`): the value, or `@file:<path>`.
|
|
788
|
+
For the default store, defaults to the value of `vault_password`.
|
|
789
|
+
folder_uid:
|
|
790
|
+
type: string
|
|
791
|
+
description: UID of the shared folder where `config vault create` adds records (not needed to read).
|
|
594
792
|
VaultFileOptions:
|
|
595
793
|
type: object
|
|
596
|
-
description: Encrypted file secret store.
|
|
794
|
+
description: Encrypted file secret store. Reference `@vault://<store>/<label>[#<field>]`, field `password` by default.
|
|
795
|
+
additionalProperties: false
|
|
597
796
|
required:
|
|
598
797
|
- type
|
|
599
798
|
properties:
|
|
@@ -601,12 +800,23 @@ components:
|
|
|
601
800
|
type: string
|
|
602
801
|
description: Vault type selector.
|
|
603
802
|
enum: [file]
|
|
604
|
-
|
|
803
|
+
file:
|
|
605
804
|
type: string
|
|
805
|
+
x-cli-complete: file
|
|
606
806
|
description: >-
|
|
607
|
-
Path to the encrypted vault file.
|
|
807
|
+
Path to the encrypted vault file, created when the first secret is added.
|
|
608
808
|
Relative paths are resolved from the configuration folder.
|
|
809
|
+
Read when used, and again when modified.
|
|
609
810
|
default: vault.bin
|
|
811
|
+
name:
|
|
812
|
+
type: string
|
|
813
|
+
x-cli-complete: file
|
|
814
|
+
description: Same as `file` (compatibility).
|
|
815
|
+
password:
|
|
816
|
+
type: string
|
|
817
|
+
description: >-
|
|
818
|
+
Password of the vault file: the value, or `@file:<path>`, read again when modified.
|
|
819
|
+
For the default store, defaults to the value of `vault_password`.
|
|
610
820
|
VaultSecret:
|
|
611
821
|
type: object
|
|
612
822
|
description: Secret entry in the vault
|
|
@@ -628,21 +838,58 @@ components:
|
|
|
628
838
|
description:
|
|
629
839
|
type: string
|
|
630
840
|
description: Human-readable description of this secret
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
841
|
+
VaultStore:
|
|
842
|
+
type: object
|
|
843
|
+
title: Secret store
|
|
844
|
+
description: Parameters of a secret store. Set `type` to select the store type.
|
|
634
845
|
oneOf:
|
|
635
846
|
- $ref: "#/components/schemas/VaultHashicorpOptions"
|
|
636
847
|
- $ref: "#/components/schemas/VaultSystemOptions"
|
|
848
|
+
- $ref: "#/components/schemas/VaultSecretServiceOptions"
|
|
637
849
|
- $ref: "#/components/schemas/VaultFileOptions"
|
|
638
850
|
- $ref: "#/components/schemas/VaultOnePasswordOptions"
|
|
851
|
+
- $ref: "#/components/schemas/VaultKeeperOptions"
|
|
639
852
|
discriminator:
|
|
640
853
|
propertyName: type
|
|
641
854
|
mapping:
|
|
642
855
|
vault: "#/components/schemas/VaultHashicorpOptions"
|
|
643
856
|
system: "#/components/schemas/VaultSystemOptions"
|
|
857
|
+
secret_service: "#/components/schemas/VaultSecretServiceOptions"
|
|
644
858
|
file: "#/components/schemas/VaultFileOptions"
|
|
645
|
-
1password: "#/components/schemas/VaultOnePasswordOptions"
|
|
859
|
+
1password: "#/components/schemas/VaultOnePasswordOptions" # HashiCorpIgnore
|
|
860
|
+
keeper: "#/components/schemas/VaultKeeperOptions"
|
|
861
|
+
VaultStores:
|
|
862
|
+
type: object
|
|
863
|
+
title: Secret stores
|
|
864
|
+
description: Named secret stores, and the default store.
|
|
865
|
+
additionalProperties: false
|
|
866
|
+
required:
|
|
867
|
+
- stores
|
|
868
|
+
properties:
|
|
869
|
+
default:
|
|
870
|
+
type: string
|
|
871
|
+
description: >-
|
|
872
|
+
Name of the default store, in `stores`: read by `@vault:<label>.<field>`, managed by `config vault`, unlocked with option `vault_password`.
|
|
873
|
+
No default store if not set.
|
|
874
|
+
cache_ttl:
|
|
875
|
+
type: number
|
|
876
|
+
minimum: 0
|
|
877
|
+
description: Time in seconds a value read by reference is kept in memory, `0` for no cache.
|
|
878
|
+
default: 60
|
|
879
|
+
stores:
|
|
880
|
+
type: object
|
|
881
|
+
description: >-
|
|
882
|
+
Name of store (letters, digits, `_`, `.`, `-`) → parameters of store, with `type`.
|
|
883
|
+
Secrets are read by reference with `@vault://<store>/<path>[?<options>][#<field>]` from any store.
|
|
884
|
+
additionalProperties:
|
|
885
|
+
$ref: "#/components/schemas/VaultStore"
|
|
886
|
+
VaultOptions:
|
|
887
|
+
type: object
|
|
888
|
+
title: Secret vault configuration
|
|
889
|
+
description: Named secret stores (`stores`), or (deprecated) the parameters of one store, which is the default store, named after its type.
|
|
890
|
+
oneOf:
|
|
891
|
+
- $ref: "#/components/schemas/VaultStores"
|
|
892
|
+
- $ref: "#/components/schemas/VaultStore"
|
|
646
893
|
ImageOptions:
|
|
647
894
|
type: object
|
|
648
895
|
description: Options for displaying images and thumbnails in the terminal.
|
|
@@ -662,9 +909,96 @@ components:
|
|
|
662
909
|
Default is `true` if the terminal supports Unicode (see `utf8`).
|
|
663
910
|
font_ratio:
|
|
664
911
|
type: number
|
|
665
|
-
format: float
|
|
666
912
|
description: Terminal font aspect ratio (height divided by width).
|
|
667
913
|
default: 2.3
|
|
914
|
+
AscpLogsOptions:
|
|
915
|
+
type: object
|
|
916
|
+
description: Analysis of `ascp` log files (`config ascp logs`).
|
|
917
|
+
additionalProperties: false
|
|
918
|
+
properties:
|
|
919
|
+
period:
|
|
920
|
+
type: integer
|
|
921
|
+
description: Snapshot period, in minutes.
|
|
922
|
+
default: 1
|
|
923
|
+
zero_bytes:
|
|
924
|
+
type: boolean
|
|
925
|
+
description: Include sessions without transferred bytes.
|
|
926
|
+
default: false
|
|
927
|
+
mtu:
|
|
928
|
+
type: integer
|
|
929
|
+
description: MTU, when not found in logs.
|
|
930
|
+
resolve:
|
|
931
|
+
type: boolean
|
|
932
|
+
description: Resolve peer addresses to host names.
|
|
933
|
+
default: false
|
|
934
|
+
timezone:
|
|
935
|
+
type: string
|
|
936
|
+
description: Time zone of the log lines (`UTC` or `+HH:MM`), to read a log from another time zone. Default is the local time zone.
|
|
937
|
+
health_minutes:
|
|
938
|
+
type: integer
|
|
939
|
+
description: Window in minutes to report transfer errors and low efficiency.
|
|
940
|
+
default: 60
|
|
941
|
+
remote_max_size:
|
|
942
|
+
type: integer
|
|
943
|
+
description: Maximum total size in bytes of the log files read from a server (`server logs`).
|
|
944
|
+
default: 536870912
|
|
945
|
+
thresholds:
|
|
946
|
+
type: object
|
|
947
|
+
description: Diagnostic thresholds.
|
|
948
|
+
additionalProperties: false
|
|
949
|
+
properties:
|
|
950
|
+
efficiency:
|
|
951
|
+
type: number
|
|
952
|
+
description: Minimum efficiency percentage below which a warning is emitted.
|
|
953
|
+
default: 90.0
|
|
954
|
+
control_loss_percent:
|
|
955
|
+
type: number
|
|
956
|
+
description: Minimum percentage of lost control messages to trigger a warning.
|
|
957
|
+
default: 5.0
|
|
958
|
+
control_loss_sent:
|
|
959
|
+
type: integer
|
|
960
|
+
description: Minimum number of control messages sent before checking control loss.
|
|
961
|
+
default: 10
|
|
962
|
+
retry_window:
|
|
963
|
+
type: integer
|
|
964
|
+
description: Maximum interval in seconds between sessions to link a retry.
|
|
965
|
+
default: 3600
|
|
966
|
+
last_error_window:
|
|
967
|
+
type: integer
|
|
968
|
+
description: Window in seconds before exit to attribute the last logged error.
|
|
969
|
+
default: 60
|
|
970
|
+
rate_decline_ratio:
|
|
971
|
+
type: number
|
|
972
|
+
description: Ratio of second half rate to first half rate below which rate decline is diagnosed.
|
|
973
|
+
default: 0.7
|
|
974
|
+
rate_decline_min_samples:
|
|
975
|
+
type: integer
|
|
976
|
+
description: Minimum number of samples to evaluate rate decline.
|
|
977
|
+
default: 10
|
|
978
|
+
rate_decline_delay:
|
|
979
|
+
type: integer
|
|
980
|
+
description: Delay in seconds after session start before evaluating rate decline samples.
|
|
981
|
+
default: 20
|
|
982
|
+
rate_decline_end_fraction:
|
|
983
|
+
type: number
|
|
984
|
+
description: Fraction of samples to discard from the end of a session when evaluating rate decline.
|
|
985
|
+
default: 0.1
|
|
986
|
+
license_expiry_days:
|
|
987
|
+
type: integer
|
|
988
|
+
description: Number of days before the expiry of the license of ascp (or less, if already expired) at which a warning is emitted.
|
|
989
|
+
default: 30
|
|
990
|
+
small_files_min_count:
|
|
991
|
+
type: integer
|
|
992
|
+
description: Minimum number of transferred files to check for the small-files diagnostic.
|
|
993
|
+
default: 100
|
|
994
|
+
small_files_max_mean:
|
|
995
|
+
type: integer
|
|
996
|
+
description: Maximum mean file size in bytes below which the small-files diagnostic is emitted.
|
|
997
|
+
default: 1000000
|
|
998
|
+
small_mtu_max:
|
|
999
|
+
type: integer
|
|
1000
|
+
description: Path MTU in bytes below which the small-MTU diagnostic is emitted (ascp measures 1492, 1006, 508 or 296).
|
|
1001
|
+
default: 1400
|
|
668
1002
|
PackageFolderOptions:
|
|
669
1003
|
type: object
|
|
670
1004
|
title: Package download folder organization
|
|
@@ -680,7 +1014,9 @@ components:
|
|
|
680
1014
|
items:
|
|
681
1015
|
type: string
|
|
682
1016
|
maxItems: 2
|
|
683
|
-
|
|
1017
|
+
examples:
|
|
1018
|
+
- - name
|
|
1019
|
+
- id
|
|
684
1020
|
seq:
|
|
685
1021
|
type: boolean
|
|
686
1022
|
description: >-
|
|
@@ -711,7 +1047,8 @@ components:
|
|
|
711
1047
|
user_id:
|
|
712
1048
|
type: string
|
|
713
1049
|
description: Identifier of the user for whom the token is generated.
|
|
714
|
-
|
|
1050
|
+
examples:
|
|
1051
|
+
- jdoe # cspell:disable-line
|
|
715
1052
|
_validity:
|
|
716
1053
|
type: integer
|
|
717
1054
|
description: Token lifetime in seconds (convenience key, removed before signing).
|
|
@@ -737,7 +1074,8 @@ components:
|
|
|
737
1074
|
description: >-
|
|
738
1075
|
Token expiry timestamp in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).
|
|
739
1076
|
Computed automatically from `_validity` when absent.
|
|
740
|
-
|
|
1077
|
+
examples:
|
|
1078
|
+
- "2030-01-01T00:00:00Z"
|
|
741
1079
|
NodeEmulatorOptions:
|
|
742
1080
|
type: object
|
|
743
1081
|
description: >-
|
|
@@ -756,26 +1094,34 @@ components:
|
|
|
756
1094
|
default: http://localhost:8080
|
|
757
1095
|
cert:
|
|
758
1096
|
type: string
|
|
1097
|
+
x-cli-complete: file
|
|
759
1098
|
description: >-
|
|
760
1099
|
Path to the TLS certificate file.
|
|
761
1100
|
Accepted formats: PEM (`.pem`) or PKCS12 (`.p12` / `.pfx`).
|
|
762
|
-
|
|
1101
|
+
examples:
|
|
1102
|
+
- /path/to/cert.pem
|
|
763
1103
|
key:
|
|
764
1104
|
type: string
|
|
1105
|
+
x-cli-complete: file
|
|
765
1106
|
description: >-
|
|
766
1107
|
Path to the PEM private key file, or the PKCS12 passphrase when `cert` is a `.p12`/`.pfx` file.
|
|
767
|
-
|
|
1108
|
+
examples:
|
|
1109
|
+
- /path/to/key.pem
|
|
768
1110
|
chain:
|
|
769
1111
|
type: string
|
|
1112
|
+
x-cli-complete: file
|
|
770
1113
|
description: Path to the PEM certificate chain file (appended as extra chain certificates).
|
|
771
|
-
|
|
1114
|
+
examples:
|
|
1115
|
+
- /path/to/chain.pem
|
|
772
1116
|
docroot:
|
|
773
1117
|
type: string
|
|
1118
|
+
x-cli-complete: folder
|
|
774
1119
|
description: >-
|
|
775
1120
|
Local folder of the node files.
|
|
776
1121
|
Paths of `/files/browse` and local paths of transfers (sources of `send`, destination of `receive`) are relative to it, and confined in it.
|
|
777
1122
|
Defaults to the current working directory.
|
|
778
|
-
|
|
1123
|
+
examples:
|
|
1124
|
+
- /data/aspera
|
|
779
1125
|
retention_sec:
|
|
780
1126
|
type: integer
|
|
781
1127
|
minimum: 1
|
|
@@ -788,13 +1134,15 @@ components:
|
|
|
788
1134
|
Set together with `password`.
|
|
789
1135
|
When not set, requests are accepted without authentication.
|
|
790
1136
|
Mandatory when `url` is not a loopback address (`localhost`, `127.0.0.0/8`, `::1`).
|
|
791
|
-
|
|
1137
|
+
examples:
|
|
1138
|
+
- node_user
|
|
792
1139
|
password:
|
|
793
1140
|
type: string
|
|
794
1141
|
description: >-
|
|
795
1142
|
Password expected from clients in HTTP Basic authentication, for the above `username`.
|
|
796
1143
|
Generate it with `openssl rand -hex 32`: a weak password is refused (see `password_min_bits`).
|
|
797
|
-
|
|
1144
|
+
examples:
|
|
1145
|
+
- "<PASSWORD>"
|
|
798
1146
|
password_min_bits:
|
|
799
1147
|
type: integer
|
|
800
1148
|
minimum: 0
|
|
@@ -818,14 +1166,15 @@ components:
|
|
|
818
1166
|
url:
|
|
819
1167
|
type: string
|
|
820
1168
|
description: Base URL of the Instana backend (without `/v1`).
|
|
821
|
-
|
|
1169
|
+
examples:
|
|
1170
|
+
- https://my-instana.example.com
|
|
822
1171
|
key:
|
|
823
1172
|
type: string
|
|
824
1173
|
description: Instana API key sent in the `x-instana-key` header.
|
|
825
|
-
|
|
1174
|
+
examples:
|
|
1175
|
+
- my-instana-api-key
|
|
826
1176
|
interval:
|
|
827
1177
|
type: number
|
|
828
|
-
format: float
|
|
829
1178
|
description: >-
|
|
830
1179
|
Polling interval in seconds. Use `0` for a single-shot run (no loop).
|
|
831
1180
|
default: 10
|
|
@@ -834,7 +1183,8 @@ components:
|
|
|
834
1183
|
description: >-
|
|
835
1184
|
Value sent in the `x-instana-host` header.
|
|
836
1185
|
Defaults to the local machine's hostname.
|
|
837
|
-
|
|
1186
|
+
examples:
|
|
1187
|
+
- hsts-prod-01
|
|
838
1188
|
OrchestratorWorkflowStart:
|
|
839
1189
|
type: object
|
|
840
1190
|
description: >-
|
|
@@ -852,13 +1202,15 @@ components:
|
|
|
852
1202
|
description: >-
|
|
853
1203
|
Name of the work step providing the result.
|
|
854
1204
|
Requires `variable`, and implies `synchronous`.
|
|
855
|
-
|
|
1205
|
+
examples:
|
|
1206
|
+
- ResultStep
|
|
856
1207
|
variable:
|
|
857
1208
|
type: string
|
|
858
1209
|
description: >-
|
|
859
1210
|
Name of the output variable of `step` returned as result.
|
|
860
1211
|
Requires `step`, and implies `synchronous`.
|
|
861
|
-
|
|
1212
|
+
examples:
|
|
1213
|
+
- Complete_status_message
|
|
862
1214
|
OrchestratorInitiateParameters:
|
|
863
1215
|
type: object
|
|
864
1216
|
description: >-
|
|
@@ -910,13 +1262,15 @@ components:
|
|
|
910
1262
|
filename:
|
|
911
1263
|
type: string
|
|
912
1264
|
description: Path of the workflow file (`.yml` or `.wkf`) on the Orchestrator host.
|
|
913
|
-
|
|
1265
|
+
examples:
|
|
1266
|
+
- /opt/aspera/orchestrator/var/run/orchestrator/workflows/import/my_workflow.yml
|
|
914
1267
|
add_as_revision:
|
|
915
1268
|
type: integer
|
|
916
1269
|
description: >-
|
|
917
1270
|
ID of an existing workflow: the file is imported as a new revision of this workflow (to be published).
|
|
918
1271
|
If not set, a new workflow is created.
|
|
919
|
-
|
|
1272
|
+
examples:
|
|
1273
|
+
- 123
|
|
920
1274
|
subwf_constraints:
|
|
921
1275
|
type: object
|
|
922
1276
|
description: 'Resolution for each sub-workflow, by name: `Map to the Existing Sub-Workflow`, `Create a new Sub-Workflow with a unique name`, or `Add a new revision to the existing Sub-Workflow`.'
|
|
@@ -959,9 +1313,66 @@ components:
|
|
|
959
1313
|
description: List of plugin names to reload.
|
|
960
1314
|
items:
|
|
961
1315
|
type: string
|
|
962
|
-
|
|
963
|
-
- soap_requests
|
|
964
|
-
|
|
1316
|
+
examples:
|
|
1317
|
+
- - soap_requests
|
|
1318
|
+
- frameio_operations # cspell:disable-line
|
|
1319
|
+
DetectOptions:
|
|
1320
|
+
type: object
|
|
1321
|
+
description: Application to detect (`config detect`).
|
|
1322
|
+
additionalProperties: false
|
|
1323
|
+
properties:
|
|
1324
|
+
url:
|
|
1325
|
+
type: string
|
|
1326
|
+
description: URL of the application. Asked interactively if not provided.
|
|
1327
|
+
examples:
|
|
1328
|
+
- https://app.example.com/aspera/app
|
|
1329
|
+
plugin:
|
|
1330
|
+
type: string
|
|
1331
|
+
description: 'Check only this plugin (default: all plugins).'
|
|
1332
|
+
examples:
|
|
1333
|
+
- aoc
|
|
1334
|
+
PresetLookupCriteria:
|
|
1335
|
+
type: object
|
|
1336
|
+
description: Criteria to find a preset (`config preset lookup`).
|
|
1337
|
+
additionalProperties: false
|
|
1338
|
+
required:
|
|
1339
|
+
- url
|
|
1340
|
+
- username
|
|
1341
|
+
properties:
|
|
1342
|
+
url:
|
|
1343
|
+
type: string
|
|
1344
|
+
description: URL of the application, compared with option `url` of presets.
|
|
1345
|
+
examples:
|
|
1346
|
+
- https://app.example.com/aspera/app
|
|
1347
|
+
username:
|
|
1348
|
+
type: string
|
|
1349
|
+
description: User name (or access key), compared with option `username` of presets.
|
|
1350
|
+
WizardOptions:
|
|
1351
|
+
type: object
|
|
1352
|
+
description: Application to configure with the wizard (`config wizard`). Options of the plugin (e.g. `--username`, `--password`, `--client-id`, `--private-key`) are given on the command line.
|
|
1353
|
+
additionalProperties: false
|
|
1354
|
+
properties:
|
|
1355
|
+
url:
|
|
1356
|
+
type: string
|
|
1357
|
+
description: URL of the application. Asked interactively if not provided.
|
|
1358
|
+
examples:
|
|
1359
|
+
- https://app.example.com/aspera/app
|
|
1360
|
+
plugin:
|
|
1361
|
+
type: string
|
|
1362
|
+
description: 'Check only this plugin (default: all plugins).'
|
|
1363
|
+
examples:
|
|
1364
|
+
- aoc
|
|
1365
|
+
preset:
|
|
1366
|
+
type: string
|
|
1367
|
+
description: 'Name of the preset to create (default: generated from the product, URL and user).'
|
|
1368
|
+
examples:
|
|
1369
|
+
- my_preset
|
|
1370
|
+
override:
|
|
1371
|
+
type: boolean
|
|
1372
|
+
description: 'Override the existing default preset of the plugin, if it exists (default: no).'
|
|
1373
|
+
default:
|
|
1374
|
+
type: boolean
|
|
1375
|
+
description: 'Set the preset as default configuration for the plugin (default: yes).'
|
|
965
1376
|
TableOptions:
|
|
966
1377
|
type: object
|
|
967
1378
|
description: Terminal table rendering options.
|
|
@@ -986,6 +1397,8 @@ components:
|
|
|
986
1397
|
default: data
|
|
987
1398
|
file:
|
|
988
1399
|
type: string
|
|
1400
|
+
x-cli-complete: file
|
|
1401
|
+
x-security: low
|
|
989
1402
|
description: Destination file for results (use `-` for stdout).
|
|
990
1403
|
fields:
|
|
991
1404
|
description: >-
|
|
@@ -1039,19 +1452,25 @@ components:
|
|
|
1039
1452
|
default: http://localhost:8080
|
|
1040
1453
|
cert:
|
|
1041
1454
|
type: string
|
|
1455
|
+
x-cli-complete: file
|
|
1042
1456
|
description: >-
|
|
1043
1457
|
Path to the TLS certificate file.
|
|
1044
1458
|
Accepted formats: PEM (`.pem`) or PKCS12 (`.p12` / `.pfx`).
|
|
1045
|
-
|
|
1459
|
+
examples:
|
|
1460
|
+
- /path/to/cert.pem
|
|
1046
1461
|
key:
|
|
1047
1462
|
type: string
|
|
1463
|
+
x-cli-complete: file
|
|
1048
1464
|
description: >-
|
|
1049
1465
|
Path to the PEM private key file, or the PKCS12 passphrase when `cert` is a `.p12`/`.pfx` file.
|
|
1050
|
-
|
|
1466
|
+
examples:
|
|
1467
|
+
- /path/to/key.pem
|
|
1051
1468
|
chain:
|
|
1052
1469
|
type: string
|
|
1470
|
+
x-cli-complete: file
|
|
1053
1471
|
description: Path to the PEM certificate chain file (appended as extra chain certificates).
|
|
1054
|
-
|
|
1472
|
+
examples:
|
|
1473
|
+
- /path/to/chain.pem
|
|
1055
1474
|
Faspex4GatewayOptions:
|
|
1056
1475
|
description: >-
|
|
1057
1476
|
Configuration for the Faspex 4 gateway emulator (`faspex5 gateway`, `aoc gateway`).
|
|
@@ -1078,13 +1497,15 @@ components:
|
|
|
1078
1497
|
Set together with `password`.
|
|
1079
1498
|
When not set, requests are accepted without authentication.
|
|
1080
1499
|
Mandatory when `url` is not a loopback address (`localhost`, `127.0.0.0/8`, `::1`).
|
|
1081
|
-
|
|
1500
|
+
examples:
|
|
1501
|
+
- fx4_user
|
|
1082
1502
|
password:
|
|
1083
1503
|
type: string
|
|
1084
1504
|
description: >-
|
|
1085
1505
|
Password expected from clients in HTTP Basic authentication, for the above `username`.
|
|
1086
1506
|
Generate it with `openssl rand -hex 32`: a weak password is refused (see `password_min_bits`).
|
|
1087
|
-
|
|
1507
|
+
examples:
|
|
1508
|
+
- "<PASSWORD>"
|
|
1088
1509
|
password_min_bits:
|
|
1089
1510
|
type: integer
|
|
1090
1511
|
minimum: 0
|
|
@@ -1115,11 +1536,13 @@ components:
|
|
|
1115
1536
|
chain: {}
|
|
1116
1537
|
script_folder:
|
|
1117
1538
|
type: string
|
|
1539
|
+
x-cli-complete: folder
|
|
1118
1540
|
description: >-
|
|
1119
1541
|
Folder containing the post-processing scripts.
|
|
1120
1542
|
The URL path (after the base path) is appended to this folder to locate the script to execute.
|
|
1121
1543
|
default: "."
|
|
1122
|
-
|
|
1544
|
+
examples:
|
|
1545
|
+
- /opt/faspex/scripts
|
|
1123
1546
|
fail_on_error:
|
|
1124
1547
|
type: boolean
|
|
1125
1548
|
description: >-
|
|
@@ -1160,10 +1583,11 @@ components:
|
|
|
1160
1583
|
This parameter or `secret_token` is required when `url` is not a local address.
|
|
1161
1584
|
oneOf:
|
|
1162
1585
|
- type: string
|
|
1163
|
-
|
|
1586
|
+
examples:
|
|
1587
|
+
- "192.168.1.10"
|
|
1164
1588
|
- type: array
|
|
1165
1589
|
items:
|
|
1166
1590
|
type: string
|
|
1167
|
-
|
|
1168
|
-
- "192.168.1.10"
|
|
1169
|
-
|
|
1591
|
+
examples:
|
|
1592
|
+
- - "192.168.1.10"
|
|
1593
|
+
- "10.89.0.0/24"
|