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.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/BUGS.md +5 -10
  4. data/CHANGELOG.md +143 -2
  5. data/CODE_OF_CONDUCT.md +18 -0
  6. data/CONTRIBUTING.md +135 -56
  7. data/GOVERNANCE.md +30 -0
  8. data/LICENSE +201 -0
  9. data/README.md +103 -26
  10. data/SECURITY.md +70 -0
  11. data/bin/ascli +8 -5
  12. data/bin/asession +9 -6
  13. data/docs/README.md +1633 -609
  14. data/docs/test-mcp-with-ai.md +8 -8
  15. data/lib/aspera/agent/base.rb +23 -2
  16. data/lib/aspera/agent/connect.rb +16 -12
  17. data/lib/aspera/agent/desktop.rb +10 -7
  18. data/lib/aspera/agent/direct.rb +20 -19
  19. data/lib/aspera/agent/factory.rb +6 -3
  20. data/lib/aspera/agent/httpgw.rb +7 -5
  21. data/lib/aspera/agent/node.rb +15 -7
  22. data/lib/aspera/agent/transferd.rb +167 -43
  23. data/lib/aspera/api/alee.rb +4 -1
  24. data/lib/aspera/api/aoc.rb +14 -11
  25. data/lib/aspera/api/ats.rb +4 -2
  26. data/lib/aspera/api/cos_node.rb +7 -4
  27. data/lib/aspera/api/faspex.rb +16 -9
  28. data/lib/aspera/api/httpgw.rb +9 -6
  29. data/lib/aspera/api/node.rb +20 -20
  30. data/lib/aspera/ascmd.rb +8 -5
  31. data/lib/aspera/ascp/installation.rb +71 -65
  32. data/lib/aspera/ascp/log.schema.yaml +1084 -0
  33. data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
  34. data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
  35. data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
  36. data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
  37. data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
  38. data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
  39. data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
  40. data/lib/aspera/ascp/log_analyzer.rb +354 -0
  41. data/lib/aspera/ascp/management.rb +16 -8
  42. data/lib/aspera/ascp/session_errors.rb +217 -0
  43. data/lib/aspera/assert.rb +4 -0
  44. data/lib/aspera/cli/ascp_actions.rb +12 -19
  45. data/lib/aspera/cli/ascp_logs_actions.rb +176 -0
  46. data/lib/aspera/cli/async_transfer_store.rb +7 -4
  47. data/lib/aspera/cli/bootstrapper.rb +37 -33
  48. data/lib/aspera/cli/command_line.rb +24 -6
  49. data/lib/aspera/cli/command_registry.rb +6 -1
  50. data/lib/aspera/cli/command_spec.rb +34 -7
  51. data/lib/aspera/cli/completion/ascli.bash +19 -5
  52. data/lib/aspera/cli/completion/ascli.fish +13 -2
  53. data/lib/aspera/cli/completion/ascli.ps1 +31 -9
  54. data/lib/aspera/cli/completion/ascli.zsh +22 -6
  55. data/lib/aspera/cli/completion_actions.rb +303 -69
  56. data/lib/aspera/cli/context.rb +9 -4
  57. data/lib/aspera/cli/deprecation.rb +5 -2
  58. data/lib/aspera/cli/error.rb +3 -0
  59. data/lib/aspera/cli/extended_value.rb +61 -27
  60. data/lib/aspera/cli/formatter.rb +29 -22
  61. data/lib/aspera/cli/gem_checker.rb +9 -6
  62. data/lib/aspera/cli/hints.rb +22 -10
  63. data/lib/aspera/cli/http.rb +12 -9
  64. data/lib/aspera/cli/info.rb +12 -7
  65. data/lib/aspera/cli/mailer.rb +6 -3
  66. data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
  67. data/lib/aspera/cli/mcp/secrets.rb +8 -5
  68. data/lib/aspera/cli/mcp/tool.rb +15 -14
  69. data/lib/aspera/cli/option_declarator.rb +10 -4
  70. data/lib/aspera/cli/option_registry.rb +6 -3
  71. data/lib/aspera/cli/option_types.rb +17 -2
  72. data/lib/aspera/cli/option_value.rb +65 -12
  73. data/lib/aspera/cli/options.schema.yaml +487 -63
  74. data/lib/aspera/cli/parser.rb +56 -32
  75. data/lib/aspera/cli/plugins/alee.rb +7 -4
  76. data/lib/aspera/cli/plugins/aoc.rb +244 -35
  77. data/lib/aspera/cli/plugins/ats.rb +9 -8
  78. data/lib/aspera/cli/plugins/base.rb +17 -12
  79. data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
  80. data/lib/aspera/cli/plugins/config.rb +198 -103
  81. data/lib/aspera/cli/plugins/console.rb +6 -3
  82. data/lib/aspera/cli/plugins/cos.rb +8 -4
  83. data/lib/aspera/cli/plugins/factory.rb +21 -7
  84. data/lib/aspera/cli/plugins/faspex5.rb +28 -25
  85. data/lib/aspera/cli/plugins/faspio.rb +7 -5
  86. data/lib/aspera/cli/plugins/httpgw.rb +7 -4
  87. data/lib/aspera/cli/plugins/mcp.rb +28 -22
  88. data/lib/aspera/cli/plugins/node.rb +31 -30
  89. data/lib/aspera/cli/plugins/oauth.rb +5 -1
  90. data/lib/aspera/cli/plugins/orchestrator.rb +272 -72
  91. data/lib/aspera/cli/plugins/preview.rb +69 -44
  92. data/lib/aspera/cli/plugins/server.rb +63 -11
  93. data/lib/aspera/cli/plugins/shares.rb +86 -16
  94. data/lib/aspera/cli/plugins/transferd.rb +223 -0
  95. data/lib/aspera/cli/preset_actions.rb +144 -30
  96. data/lib/aspera/cli/preset_manager.rb +52 -18
  97. data/lib/aspera/cli/prompt.rb +4 -1
  98. data/lib/aspera/cli/result.rb +12 -8
  99. data/lib/aspera/cli/runner.rb +69 -46
  100. data/lib/aspera/cli/secret_finder.rb +4 -1
  101. data/lib/aspera/cli/security.rb +79 -9
  102. data/lib/aspera/cli/special_values.rb +4 -1
  103. data/lib/aspera/cli/sync_actions.rb +13 -10
  104. data/lib/aspera/cli/table_fitter.rb +3 -0
  105. data/lib/aspera/cli/terminal_formatter.rb +9 -6
  106. data/lib/aspera/cli/transfer_actions.rb +11 -8
  107. data/lib/aspera/cli/transfer_agent.rb +29 -20
  108. data/lib/aspera/cli/transfer_progress.rb +13 -45
  109. data/lib/aspera/cli/vault_actions.rb +45 -0
  110. data/lib/aspera/cli/vault_manager.rb +188 -42
  111. data/lib/aspera/cli/version.rb +4 -1
  112. data/lib/aspera/cli/web_secret.rb +12 -10
  113. data/lib/aspera/cli/wizard.rb +42 -39
  114. data/lib/aspera/command_line_builder.rb +9 -5
  115. data/lib/aspera/command_line_converter.rb +4 -1
  116. data/lib/aspera/coverage.rb +103 -33
  117. data/lib/aspera/data_repository.rb +4 -1
  118. data/lib/aspera/dot_container.rb +4 -1
  119. data/lib/aspera/duration.rb +5 -2
  120. data/lib/aspera/environment.rb +21 -12
  121. data/lib/aspera/exec_spec.rb +3 -0
  122. data/lib/aspera/faspex_gw.rb +13 -9
  123. data/lib/aspera/faspex_postproc.rb +15 -12
  124. data/lib/aspera/formatter_interface.rb +4 -1
  125. data/lib/aspera/graphql.rb +5 -1
  126. data/lib/aspera/hash_ext.rb +3 -0
  127. data/lib/aspera/id_generator.rb +4 -2
  128. data/lib/aspera/json_rpc/client.rb +6 -5
  129. data/lib/aspera/json_rpc/version.rb +3 -0
  130. data/lib/aspera/line_logger.rb +4 -1
  131. data/lib/aspera/link_header.rb +4 -1
  132. data/lib/aspera/log.rb +18 -5
  133. data/lib/aspera/markdown.rb +5 -2
  134. data/lib/aspera/mime.rb +3 -0
  135. data/lib/aspera/nagios.rb +6 -4
  136. data/lib/aspera/node_emulator.rb +15 -13
  137. data/lib/aspera/oauth/client/base.rb +91 -70
  138. data/lib/aspera/oauth/client/boot.rb +7 -4
  139. data/lib/aspera/oauth/client/factory.rb +6 -3
  140. data/lib/aspera/oauth/client/generic.rb +5 -1
  141. data/lib/aspera/oauth/client/json_credentials.rb +4 -1
  142. data/lib/aspera/oauth/client/jwt.rb +6 -3
  143. data/lib/aspera/oauth/client/shares_web.rb +85 -0
  144. data/lib/aspera/oauth/client/url_json.rb +4 -1
  145. data/lib/aspera/oauth/client/web.rb +39 -12
  146. data/lib/aspera/oauth/server/pkce.rb +6 -5
  147. data/lib/aspera/orchestrator_workflow_checker.rb +119 -1
  148. data/lib/aspera/persistency_action_once.rb +5 -3
  149. data/lib/aspera/persistency_folder.rb +6 -3
  150. data/lib/aspera/preview/file_types.rb +6 -3
  151. data/lib/aspera/preview/generator.rb +9 -5
  152. data/lib/aspera/preview/options.schema.yaml +3 -3
  153. data/lib/aspera/preview/terminal.rb +8 -4
  154. data/lib/aspera/preview/utils.rb +6 -4
  155. data/lib/aspera/products/connect.rb +5 -2
  156. data/lib/aspera/products/desktop.rb +4 -1
  157. data/lib/aspera/products/other.rb +4 -2
  158. data/lib/aspera/products/transferd.rb +6 -2
  159. data/lib/aspera/products/transferd_service.rb +610 -0
  160. data/lib/aspera/proxy_auto_config.js +2 -2
  161. data/lib/aspera/proxy_auto_config.rb +5 -2
  162. data/lib/aspera/rainbow.rb +3 -0
  163. data/lib/aspera/rest/aspera_errors.rb +4 -1
  164. data/lib/aspera/rest/call_error.rb +3 -0
  165. data/lib/aspera/rest/client.rb +22 -29
  166. data/lib/aspera/rest/error_analyzer.rb +5 -2
  167. data/lib/aspera/rest/list.rb +8 -4
  168. data/lib/aspera/rest/parameters.rb +3 -0
  169. data/lib/aspera/rest/util.rb +8 -5
  170. data/lib/aspera/rest.rb +9 -6
  171. data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
  172. data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
  173. data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
  174. data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
  175. data/lib/aspera/schema/async_tables.yaml +11 -10
  176. data/lib/aspera/schema/documentation.rb +8 -2
  177. data/lib/aspera/schema/reader.rb +7 -0
  178. data/lib/aspera/schema/registry.rb +43 -28
  179. data/lib/aspera/schema/transferd-config.schema.json +333 -0
  180. data/lib/aspera/schema/validator.rb +4 -1
  181. data/lib/aspera/sealed_hash.rb +166 -0
  182. data/lib/aspera/secret/hider.rb +201 -0
  183. data/lib/aspera/secret/reference.rb +150 -0
  184. data/lib/aspera/secret/resolver.rb +212 -0
  185. data/lib/aspera/secret/store/base.rb +153 -0
  186. data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
  187. data/lib/aspera/secret/store/factory.rb +103 -0
  188. data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
  189. data/lib/aspera/secret/store/keeper.rb +141 -0
  190. data/lib/aspera/secret/store/macos_security.rb +284 -0
  191. data/lib/aspera/secret/store/one_password_api.rb +99 -0
  192. data/lib/aspera/secret/store/one_password_base.rb +42 -0
  193. data/lib/aspera/secret/store/one_password_cli.rb +110 -0
  194. data/lib/aspera/secret/store/secret_service.rb +125 -0
  195. data/lib/aspera/secret/strength.rb +119 -0
  196. data/lib/aspera/servlet_helpers.rb +5 -2
  197. data/lib/aspera/ssh.rb +10 -7
  198. data/lib/aspera/ssl.rb +5 -2
  199. data/lib/aspera/string_ext.rb +3 -0
  200. data/lib/aspera/sync/args.schema.yaml +3 -0
  201. data/lib/aspera/sync/conf.schema.yaml +9 -4
  202. data/lib/aspera/sync/database.rb +3 -0
  203. data/lib/aspera/sync/operations.rb +16 -14
  204. data/lib/aspera/temp_file_manager.rb +8 -4
  205. data/lib/aspera/timer_limiter.rb +3 -0
  206. data/lib/aspera/transfer/error.rb +4 -1
  207. data/lib/aspera/transfer/faux_file.rb +4 -1
  208. data/lib/aspera/transfer/parameters.rb +17 -14
  209. data/lib/aspera/transfer/result.rb +3 -0
  210. data/lib/aspera/transfer/resumer.rb +6 -4
  211. data/lib/aspera/transfer/spec.rb +9 -22
  212. data/lib/aspera/transfer/units.rb +75 -0
  213. data/lib/aspera/uri_reader.rb +57 -7
  214. data/lib/aspera/web_auth/index.html.erb +6 -2
  215. data/lib/aspera/web_auth/paste.rb +109 -0
  216. data/lib/aspera/web_auth/receiver.rb +50 -0
  217. data/lib/aspera/web_auth/relay.rb +76 -0
  218. data/lib/aspera/web_auth/reply.html.erb +150 -0
  219. data/lib/aspera/web_auth/server.rb +47 -10
  220. data/lib/aspera/web_page.rb +7 -2
  221. data/lib/aspera/web_server_simple.rb +6 -3
  222. data/lib/aspera/yaml.rb +5 -1
  223. data/llms.txt +81 -0
  224. data/skills/ascli/SKILL.md +88 -0
  225. data.tar.gz.sig +0 -0
  226. metadata +72 -19
  227. metadata.gz.sig +0 -0
  228. data/lib/aspera/keychain/base.rb +0 -30
  229. data/lib/aspera/keychain/encrypted_hash.rb +0 -192
  230. data/lib/aspera/keychain/factory.rb +0 -58
  231. data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
  232. data/lib/aspera/keychain/macos_security.rb +0 -277
  233. data/lib/aspera/keychain/one_password_api.rb +0 -91
  234. data/lib/aspera/keychain/one_password_base.rb +0 -39
  235. data/lib/aspera/keychain/one_password_cli.rb +0 -100
  236. data/lib/aspera/secret_hider.rb +0 -196
  237. data/lib/aspera/secret_strength.rb +0 -114
@@ -0,0 +1,1084 @@
1
+ # cspell:ignore abrtxfer blks bwmeas drate dups mgmt peeros peerlic peerver rcvd rcvD rcvr rexreqs sndr srcbase userid xmit xmtD xnf
2
+ # Records of ascp log lines, output by `config ascp logs records`: field names are the ones of the log lines.
3
+ # Values are numbers when the log value is a number: rates in bps, durations in ms, s or µs, percentages without `%`.
4
+ # Sources (ascp 4): `fasp_session_rx_stats_to_str` (Receiver bl), `fasp_session_tx_stats_to_str` (Sender bl),
5
+ # `sink_sess_stats_log` and `source_sess_stats_log` (DS Qs), `as_mgmt_backlog_status` (mgmt backlog),
6
+ # `fasp_session_log` (Session Start/Stop/Params), `fasp.c` (Initializing FASP version), `msg_api.c` (Measured pMTU),
7
+ # `fasp_session.c` (datagram size), `fasp_rateparams_neg.c` (Peer requested rate params adopted),
8
+ # `fasp_ds_util.c` (Session Statistics), `action.c` (Transfer Start/Stop).
9
+ openapi: 3.1.0
10
+ info:
11
+ title: Ascp log records
12
+ version: 1.0.0
13
+ description: Lines of ascp logs parsed into records, with the field names of the
14
+ log lines.
15
+ paths: {}
16
+ components:
17
+ schemas:
18
+ LogFile:
19
+ description: Log file of the record, when several log files are analyzed.
20
+ type: string
21
+ Pid:
22
+ description: Process identifier of `ascp`.
23
+ type: string
24
+ Sample:
25
+ description: 'Statistics of a session, logged periodically: a `Receiver bl` or
26
+ `Sender bl` line, with its `DS Qs` line in `DS`. Counters are totals
27
+ since the start of the session, except the minimum and maximum values of
28
+ the period.'
29
+ discriminator:
30
+ propertyName: side
31
+ mapping:
32
+ Receiver: '#/components/schemas/ReceiverSample'
33
+ Sender: '#/components/schemas/SenderSample'
34
+ oneOf:
35
+ - $ref: '#/components/schemas/ReceiverSample'
36
+ - $ref: '#/components/schemas/SenderSample'
37
+ SampleControl:
38
+ description: Control messages rejected.
39
+ type: object
40
+ properties:
41
+ bm:
42
+ description: With a bad MAC.
43
+ type: integer
44
+ bs:
45
+ description: With a bad sequence number.
46
+ type: integer
47
+ additionalProperties: false
48
+ SampleProgress:
49
+ description: Progress of the session.
50
+ type: object
51
+ properties:
52
+ t:
53
+ description: Bytes transferred, without duplicates (bytes).
54
+ type: integer
55
+ f:
56
+ description: File bytes transferred (bytes).
57
+ type: integer
58
+ e:
59
+ description: Time since the first data packet (µs).
60
+ type: integer
61
+ additionalProperties: false
62
+ MgmtBacklog:
63
+ description: Data waiting to be written to each management socket.
64
+ type: array
65
+ items:
66
+ type: object
67
+ additionalProperties: false
68
+ properties:
69
+ i:
70
+ description: Index of the management socket.
71
+ type: integer
72
+ s:
73
+ description: Socket descriptor.
74
+ type: integer
75
+ n:
76
+ description: Bytes waiting to be written (bytes).
77
+ type: integer
78
+ ReceiverSample:
79
+ type: object
80
+ properties:
81
+ log_file:
82
+ $ref: '#/components/schemas/LogFile'
83
+ time:
84
+ description: Time of the line.
85
+ type: string
86
+ format: date-time
87
+ pid:
88
+ $ref: '#/components/schemas/Pid'
89
+ uuid:
90
+ description: Identifier of the session of the process, when logged before the
91
+ line.
92
+ type: string
93
+ side:
94
+ description: Side of the session.
95
+ type: string
96
+ enum:
97
+ - Receiver
98
+ bl:
99
+ description: Data blocks.
100
+ type: object
101
+ additionalProperties: false
102
+ properties:
103
+ t:
104
+ description: 'Blocks received: `o` + `r` + `d` (± 1, counters are read while
105
+ blocks arrive).'
106
+ type: integer
107
+ o:
108
+ description: Original blocks received (first transmission).
109
+ type: integer
110
+ r:
111
+ description: Retransmitted blocks received.
112
+ type: integer
113
+ d:
114
+ description: 'Blocks discarded: duplicates and drops, `d` + `r` + `a` + `x` +
115
+ `dl` of `bl2`.'
116
+ type: integer
117
+ ts:
118
+ description: Blocks sent by the sender, as reported by the sender (0 if not
119
+ reported).
120
+ type: integer
121
+ c:
122
+ description: Lowest block number not received yet (all blocks before it are
123
+ received).
124
+ type: integer
125
+ h:
126
+ description: Next block number expected.
127
+ type: integer
128
+ rex_rtt:
129
+ description: Round-trip time of retransmission requests (ms).
130
+ type: object
131
+ additionalProperties: false
132
+ properties:
133
+ l:
134
+ description: Minimum during the period (ms).
135
+ type: integer
136
+ h:
137
+ description: Maximum during the period (ms).
138
+ type: integer
139
+ s:
140
+ description: Smoothed (ms).
141
+ type: integer
142
+ o:
143
+ description: Retransmission timeout (ms).
144
+ type: integer
145
+ ooo_rtt:
146
+ description: Round-trip time of out-of-order blocks (ms).
147
+ type: object
148
+ additionalProperties: false
149
+ properties:
150
+ l:
151
+ description: Minimum during the period (ms).
152
+ type: integer
153
+ h:
154
+ description: Maximum during the period (ms).
155
+ type: integer
156
+ s:
157
+ description: Smoothed (ms).
158
+ type: integer
159
+ o:
160
+ description: Out-of-order timeout (ms).
161
+ type: integer
162
+ rate_rtt:
163
+ description: Network round-trip time, used by the rate controller (ms).
164
+ type: object
165
+ additionalProperties: false
166
+ properties:
167
+ b:
168
+ description: Base (minimum) (ms).
169
+ type: integer
170
+ l:
171
+ description: Minimum during the period (ms).
172
+ type: integer
173
+ h:
174
+ description: Maximum during the period (ms).
175
+ type: integer
176
+ s:
177
+ description: Smoothed (ms).
178
+ type: integer
179
+ r:
180
+ description: Resets of the base round-trip time during the period.
181
+ type: integer
182
+ f:
183
+ description: Rate adaptation mode.
184
+ type: integer
185
+ ctl:
186
+ $ref: '#/components/schemas/SampleControl'
187
+ rex:
188
+ description: Retransmission requests.
189
+ type: object
190
+ additionalProperties: false
191
+ properties:
192
+ n:
193
+ description: 'Retransmission requests outstanding: blocks in the retransmission
194
+ queue.'
195
+ type: integer
196
+ s:
197
+ description: Blocks requested for retransmission.
198
+ type: integer
199
+ q:
200
+ description: Messages of retransmission requests sent (a message carries several
201
+ requests).
202
+ type: integer
203
+ v:
204
+ description: Requests removed from the queue, because the block was received.
205
+ type: integer
206
+ a:
207
+ description: Failures to add a request to the queue (queue full).
208
+ type: integer
209
+ r:
210
+ description: Failures to remove a request from the queue (duplicate
211
+ retransmissions).
212
+ type: integer
213
+ bl2:
214
+ description: Data blocks lost, duplicated or dropped (second `bl` group of the
215
+ line).
216
+ type: object
217
+ additionalProperties: false
218
+ properties:
219
+ l:
220
+ description: Original blocks lost.
221
+ type: integer
222
+ d:
223
+ description: Duplicate blocks.
224
+ type: integer
225
+ o:
226
+ description: Blocks received out of order.
227
+ type: integer
228
+ r:
229
+ description: Dropped, because the ring buffer is full.
230
+ type: integer
231
+ a:
232
+ description: Dropped, because the file transfer is aborted.
233
+ type: integer
234
+ x:
235
+ description: Dropped, because the file transfer is not found or not ready.
236
+ type: integer
237
+ dl:
238
+ description: Duplicate last blocks.
239
+ type: integer
240
+ df:
241
+ description: Dropped, because of a bad format.
242
+ type: integer
243
+ dm:
244
+ description: Dropped, because of a bad MAC.
245
+ type: integer
246
+ ds:
247
+ description: Dropped, because of a bad sequence number.
248
+ type: integer
249
+ disk:
250
+ description: Ring buffer between network and storage.
251
+ type: object
252
+ additionalProperties: false
253
+ properties:
254
+ l:
255
+ description: Minimum of buffers occupied during the period.
256
+ type: integer
257
+ h:
258
+ description: Maximum of buffers occupied during the period.
259
+ type: integer
260
+ b:
261
+ description: 'Buffers occupied: backlog of writes to storage (blocks queued for
262
+ storage, without ring buffer).'
263
+ type: integer
264
+ vlink:
265
+ description: Virtual links.
266
+ type: object
267
+ additionalProperties: false
268
+ properties:
269
+ lq:
270
+ description: Queuing delay of the local virtual link (ms).
271
+ type: integer
272
+ lo:
273
+ description: Occupancy of the local virtual link (%).
274
+ type: integer
275
+ rq:
276
+ description: Queuing delay of the remote virtual link (ms).
277
+ type: integer
278
+ ro:
279
+ description: Occupancy of the remote virtual link (%).
280
+ type: integer
281
+ rate:
282
+ description: Rates (bps). A rate controller that is not active (policy `fixed`,
283
+ no virtual link) shows the target rate.
284
+ type: object
285
+ additionalProperties: false
286
+ properties:
287
+ t:
288
+ description: Target rate (bps).
289
+ type: integer
290
+ m:
291
+ description: Minimum rate (bps).
292
+ type: integer
293
+ c:
294
+ description: 'Calculated rate, sent to the sender: the minimum of `n`, `vl`,
295
+ `vr` and `r` (bps).'
296
+ type: integer
297
+ n:
298
+ description: Rate computed from network congestion (bps).
299
+ type: integer
300
+ vl:
301
+ description: Rate computed for the local virtual link (bps).
302
+ type: integer
303
+ vr:
304
+ description: Rate computed for the remote virtual link (bps).
305
+ type: integer
306
+ r:
307
+ description: Rate computed from storage input/output (bps).
308
+ type: integer
309
+ prog:
310
+ $ref: '#/components/schemas/SampleProgress'
311
+ rcvD:
312
+ description: Files received.
313
+ type: integer
314
+ DS:
315
+ description: '`Receiver DS Qs` line: files (data sessions) at each stage of
316
+ reception.'
317
+ type: object
318
+ additionalProperties: false
319
+ properties:
320
+ Qs:
321
+ description: Files in each queue.
322
+ type: object
323
+ additionalProperties: false
324
+ properties:
325
+ ds:
326
+ description: Active files.
327
+ type: integer
328
+ pn:
329
+ description: Before new.
330
+ type: integer
331
+ n:
332
+ description: New.
333
+ type: integer
334
+ rq:
335
+ description: Request received.
336
+ type: integer
337
+ pa:
338
+ description: Before preparation of attributes.
339
+ type: integer
340
+ ao:
341
+ description: Opening (asynchronous).
342
+ type: integer
343
+ ap:
344
+ description: Preparation of attributes.
345
+ type: integer
346
+ rd:
347
+ description: Ready.
348
+ type: integer
349
+ ru:
350
+ description: Running.
351
+ type: integer
352
+ 'no':
353
+ description: Dispatch without transfer of data.
354
+ type: integer
355
+ po:
356
+ description: Post-processing.
357
+ type: integer
358
+ pc:
359
+ description: Post-processing complete.
360
+ type: integer
361
+ do:
362
+ description: Done.
363
+ type: integer
364
+ tv:
365
+ description: Validation at threshold.
366
+ type: integer
367
+ sv:
368
+ description: Validation at stop.
369
+ type: integer
370
+ Rs:
371
+ description: Requests of files.
372
+ type: object
373
+ additionalProperties: false
374
+ properties:
375
+ i:
376
+ description: Requests received from the sender.
377
+ type: integer
378
+ o:
379
+ description: Responses sent to the sender.
380
+ type: integer
381
+ mgmt_backlog:
382
+ $ref: '#/components/schemas/MgmtBacklog'
383
+ additionalProperties: false
384
+ title: Sample of the receiver
385
+ SenderSample:
386
+ type: object
387
+ properties:
388
+ log_file:
389
+ $ref: '#/components/schemas/LogFile'
390
+ time:
391
+ description: Time of the line.
392
+ type: string
393
+ format: date-time
394
+ pid:
395
+ $ref: '#/components/schemas/Pid'
396
+ uuid:
397
+ description: Identifier of the session of the process, when logged before the
398
+ line.
399
+ type: string
400
+ side:
401
+ description: Side of the session.
402
+ type: string
403
+ enum:
404
+ - Sender
405
+ bl:
406
+ description: Data blocks.
407
+ type: object
408
+ additionalProperties: false
409
+ properties:
410
+ t:
411
+ description: Blocks sent.
412
+ type: integer
413
+ o:
414
+ description: Original blocks sent (first transmission).
415
+ type: integer
416
+ r:
417
+ description: Retransmitted blocks sent.
418
+ type: integer
419
+ dl:
420
+ description: Duplicate last blocks.
421
+ type: integer
422
+ c:
423
+ description: Lowest block number not received yet by the receiver.
424
+ type: integer
425
+ h:
426
+ description: Next block number.
427
+ type: integer
428
+ ctl:
429
+ $ref: '#/components/schemas/SampleControl'
430
+ rex:
431
+ description: Retransmission requests.
432
+ type: object
433
+ additionalProperties: false
434
+ properties:
435
+ b:
436
+ description: Blocks requested for retransmission.
437
+ type: integer
438
+ r:
439
+ description: Retransmission requests received.
440
+ type: integer
441
+ n:
442
+ description: Size of the retransmission table.
443
+ type: integer
444
+ r_ott:
445
+ description: Reverse one-way trip time (receiver to sender).
446
+ type: object
447
+ additionalProperties: false
448
+ properties:
449
+ q:
450
+ description: 'Queuing delay: current minus minimum (ms).'
451
+ type: integer
452
+ s:
453
+ description: Clock skew between receiver and sender (× 10000).
454
+ type: integer
455
+ n:
456
+ description: Number of samples.
457
+ type: integer
458
+ rate:
459
+ description: Rates (bps). The rates of the receiver are reported by the receiver
460
+ (ascp 4). A rate controller that is not active (no virtual link)
461
+ shows the target rate.
462
+ type: object
463
+ additionalProperties: false
464
+ properties:
465
+ t:
466
+ description: Target rate (bps).
467
+ type: integer
468
+ m:
469
+ description: Minimum rate (bps).
470
+ type: integer
471
+ c:
472
+ description: 'Calculated rate: the sending rate (bps).'
473
+ type: integer
474
+ rc:
475
+ description: 'Calculated rate of the receiver: the minimum of `n`, `vl`, `vr`
476
+ and `r` (bps).'
477
+ type: integer
478
+ n:
479
+ description: Rate computed by the receiver from network congestion (bps).
480
+ type: integer
481
+ vl:
482
+ description: Rate computed by the receiver for its local virtual link (bps).
483
+ type: integer
484
+ vr:
485
+ description: Rate computed by the receiver for its remote virtual link (bps).
486
+ type: integer
487
+ r:
488
+ description: Rate computed by the receiver from storage input/output (bps).
489
+ type: integer
490
+ prog:
491
+ $ref: '#/components/schemas/SampleProgress'
492
+ xmtD:
493
+ description: Files sent.
494
+ type: integer
495
+ drate:
496
+ description: Rate of reading from storage (bps).
497
+ type: integer
498
+ DS:
499
+ description: '`Sender DS Qs` line: files (data sessions) at each stage of
500
+ sending.'
501
+ type: object
502
+ additionalProperties: false
503
+ properties:
504
+ Qs:
505
+ description: Files in each queue.
506
+ type: object
507
+ additionalProperties: false
508
+ properties:
509
+ ds:
510
+ description: Active files.
511
+ type: integer
512
+ re:
513
+ description: Retry.
514
+ type: integer
515
+ a:
516
+ description: Source arguments.
517
+ type: integer
518
+ d:
519
+ description: Folders.
520
+ type: integer
521
+ ao:
522
+ description: Opening (asynchronous).
523
+ type: integer
524
+ eo:
525
+ description: Error at opening.
526
+ type: integer
527
+ n:
528
+ description: New.
529
+ type: integer
530
+ ap:
531
+ description: Preparation of attributes.
532
+ type: integer
533
+ rq:
534
+ description: Request sent.
535
+ type: integer
536
+ rd:
537
+ description: Ready.
538
+ type: integer
539
+ ru:
540
+ description: Running.
541
+ type: integer
542
+ cl:
543
+ description: Clean-up.
544
+ type: integer
545
+ di:
546
+ description: Dispatch.
547
+ type: integer
548
+ do:
549
+ description: Done.
550
+ type: integer
551
+ Rs:
552
+ description: Requests of files.
553
+ type: object
554
+ additionalProperties: false
555
+ properties:
556
+ o:
557
+ description: Requests sent to the receiver.
558
+ type: integer
559
+ i:
560
+ description: Responses received from the receiver.
561
+ type: integer
562
+ mgmt_backlog:
563
+ $ref: '#/components/schemas/MgmtBacklog'
564
+ additionalProperties: false
565
+ title: Sample of the sender
566
+ Session:
567
+ description: 'A session: `Session Start`, `Session Params`, `Session Stop` and
568
+ `Session Statistics` lines, and the lines of the process about the
569
+ session (`Initializing FASP version`, `Measured pMTU`, `datagram size`,
570
+ `Peer requested rate params adopted`). `Session Stop` has the fields of
571
+ `Session Start`, with their final values. Fields `account no.` and
572
+ `license no.` of `Initializing FASP version` are never output. Field
573
+ `cookie` of `Session Params` is never output.'
574
+ type: object
575
+ properties:
576
+ log_file:
577
+ $ref: '#/components/schemas/LogFile'
578
+ uuid:
579
+ description: Identifier of the session.
580
+ type: string
581
+ pid:
582
+ $ref: '#/components/schemas/Pid'
583
+ start:
584
+ description: Time of `Session Start`.
585
+ type: string
586
+ format: date-time
587
+ stop:
588
+ description: Time of `Session Stop`.
589
+ type: string
590
+ format: date-time
591
+ op:
592
+ description: Direction of the session.
593
+ type: string
594
+ enum:
595
+ - send
596
+ - recv
597
+ status:
598
+ description: Status of the session.
599
+ type: string
600
+ enum:
601
+ - started
602
+ - success
603
+ - failed
604
+ - timeout
605
+ errcode:
606
+ description: Error code, when failed (see `config ascp errors session`).
607
+ type: integer
608
+ errstr:
609
+ description: Error message, when failed.
610
+ type: string
611
+ peer_errcode:
612
+ description: Error code of the peer, when the peer aborted the session.
613
+ type: integer
614
+ peer_errstr:
615
+ description: Error message of the peer, when the peer aborted the session.
616
+ type: string
617
+ source:
618
+ description: First source path, `-` if none.
619
+ type: string
620
+ dest:
621
+ description: Destination path, `-` if none.
622
+ type: string
623
+ source_prefix:
624
+ description: Prefix of source paths, `-` if none.
625
+ type: string
626
+ local:
627
+ description: 'Local address: IP:port.'
628
+ type: string
629
+ peer:
630
+ description: 'Address of the peer: IP:port.'
631
+ type: string
632
+ tcp_port:
633
+ description: TCP port of the session (SSH or FASP).
634
+ type: integer
635
+ wss_port:
636
+ description: Port of the WebSocket session, instead of `tcp_port`.
637
+ type: integer
638
+ os:
639
+ description: Local operating system.
640
+ type: string
641
+ ver:
642
+ description: Local version of `ascp`, and build.
643
+ type: string
644
+ lic:
645
+ description: 'Local license: product:account:license.'
646
+ type: string
647
+ peeros:
648
+ description: Operating system of the peer.
649
+ type: string
650
+ peerver:
651
+ description: Version of `ascp` of the peer, and build.
652
+ type: string
653
+ peerlic:
654
+ description: 'License of the peer: product:account:license.'
655
+ type: string
656
+ proto_sess:
657
+ description: Version of the session protocol (hexadecimal).
658
+ type: string
659
+ proto_udp:
660
+ description: Version of the UDP protocol (hexadecimal).
661
+ type: string
662
+ proto_bwmeas:
663
+ description: Version of the bandwidth measurement protocol (hexadecimal).
664
+ type: string
665
+ proto_data:
666
+ description: Version of the data protocol (hexadecimal).
667
+ type: string
668
+ userid:
669
+ description: Identifier of the transfer user.
670
+ type: integer
671
+ user:
672
+ description: Transfer user, `-` if none.
673
+ type: string
674
+ targetrate:
675
+ description: Target rate (bps).
676
+ type: integer
677
+ minrate:
678
+ description: Minimum rate (bps).
679
+ type: integer
680
+ rate_policy:
681
+ description: 'Rate policy: `fixed`, `high`, `fair` or `low`.'
682
+ type: string
683
+ cipher:
684
+ description: Transport encryption cipher.
685
+ type: string
686
+ resume:
687
+ description: 'Resume policy: 0 none, 1 file attributes, 2 sparse checksum, 3
688
+ full checksum.'
689
+ type: integer
690
+ create:
691
+ description: Create policy.
692
+ type: integer
693
+ extra_create:
694
+ description: Extra create policy.
695
+ type: integer
696
+ ovr:
697
+ description: Overwrite policy.
698
+ type: integer
699
+ times:
700
+ description: Policy of file times (preserve times).
701
+ type: integer
702
+ precalc:
703
+ description: 'Size of the transfer calculated before the transfer: `yes` or `no`.'
704
+ type: string
705
+ precalc_disable:
706
+ description: 'Calculation of the size before the transfer is disabled: `true` or
707
+ `false`.'
708
+ type: string
709
+ mf:
710
+ description: Manifest policy.
711
+ type: integer
712
+ mf_path:
713
+ description: Folder of the manifest, `-` if none.
714
+ type: string
715
+ mf_suffix:
716
+ description: Suffix of the manifest file while the transfer is in progress.
717
+ type: string
718
+ partial_file_suffix:
719
+ description: Suffix of partial files, `-` if none.
720
+ type: string
721
+ files_encrypt:
722
+ description: 'Encryption of files at rest: `yes` or `no`.'
723
+ type: string
724
+ files_decrypt:
725
+ description: 'Decryption of files at rest: `yes` or `no`.'
726
+ type: string
727
+ file_csum:
728
+ description: Type of file checksum, `NONE` if none.
729
+ type: string
730
+ fips_enabled:
731
+ description: 'FIPS mode: `yes` or `no`.'
732
+ type: string
733
+ dgram_sz:
734
+ description: Datagram size requested, 0 for automatic (bytes).
735
+ type: integer
736
+ tcp_mode:
737
+ description: 'TCP friendly mode: `yes` or `no`.'
738
+ type: string
739
+ rtt_auto:
740
+ description: 'Automatic correction of the base round-trip time: `yes` or `no`.'
741
+ type: string
742
+ vl_proto_ver:
743
+ description: Local version of the virtual link protocol.
744
+ type: integer
745
+ peer_vl_proto_ver:
746
+ description: Version of the virtual link protocol of the peer.
747
+ type: integer
748
+ vl_local:
749
+ description: Capacity of the local virtual link, 0 if none (bps).
750
+ type: integer
751
+ vlink_remote:
752
+ description: Capacity of the remote virtual link, 0 if none (bps).
753
+ type: integer
754
+ vl_sess_id:
755
+ description: Identifier of the session in virtual links.
756
+ type: integer
757
+ srcbase:
758
+ description: Base of source paths, `-` if none.
759
+ type: string
760
+ rd_sz:
761
+ description: Size of read blocks, 0 for default (bytes).
762
+ type: integer
763
+ wr_sz:
764
+ description: Size of write blocks, 0 for default (bytes).
765
+ type: integer
766
+ cluster_num_nodes:
767
+ description: Number of sessions of a multi-session transfer.
768
+ type: integer
769
+ cluster_node_id:
770
+ description: Index of the session in a multi-session transfer.
771
+ type: integer
772
+ cluster_multi_session_threshold:
773
+ description: Minimum size of a file split across the sessions of a multi-session
774
+ transfer, -1 if not set (bytes).
775
+ type: integer
776
+ range:
777
+ description: 'Byte range of the transfer: low-high, 0-0 if none.'
778
+ type: string
779
+ keepalive:
780
+ description: 'Keepalive mode (persistent session): `yes` or `no`.'
781
+ type: string
782
+ test_login:
783
+ description: 'Test of login only: `yes` or `no`.'
784
+ type: string
785
+ proxy_ip:
786
+ description: Address of the proxy, `-` if none.
787
+ type: string
788
+ net_rc_alg:
789
+ description: Algorithm of network rate control.
790
+ type: string
791
+ exclude_older_than:
792
+ description: Files older than this are excluded, 0 if not set (s, from
793
+ `exclude_older/newer_than`).
794
+ type: integer
795
+ exclude_newer_than:
796
+ description: Files newer than this are excluded, 0 if not set (s, from
797
+ `exclude_older/newer_than`).
798
+ type: integer
799
+ xfer_id:
800
+ description: Identifier of the transfer, `-` if none.
801
+ type: string
802
+ job_id:
803
+ description: Identifier of the job.
804
+ type: string
805
+ delay:
806
+ description: Network round-trip time (ms).
807
+ type: integer
808
+ rex_delay:
809
+ description: Retransmission timeout (ms).
810
+ type: integer
811
+ ooo_delay:
812
+ description: Out-of-order timeout (ms, receiver).
813
+ type: integer
814
+ solicited_rex:
815
+ description: Blocks retransmitted on request of the receiver (%).
816
+ type: number
817
+ unsolicited_rex:
818
+ description: Blocks retransmitted without request (%, sender).
819
+ type: number
820
+ rcvd_rex:
821
+ description: Retransmitted blocks received (%, receiver).
822
+ type: number
823
+ rcvd_dups:
824
+ description: Duplicate blocks received (%, receiver).
825
+ type: number
826
+ ave_xmit_rate:
827
+ description: Average rate of transmission (bps).
828
+ type: integer
829
+ effective:
830
+ description: 'Efficiency: useful blocks among the blocks sent (%).'
831
+ type: number
832
+ effective_rate:
833
+ description: Rate of useful data (bps).
834
+ type: integer
835
+ detail:
836
+ description: Data blocks.
837
+ type: object
838
+ additionalProperties: false
839
+ properties:
840
+ good_blks:
841
+ description: Useful blocks.
842
+ type: integer
843
+ bl_total:
844
+ description: Blocks sent or received.
845
+ type: integer
846
+ bl_orig:
847
+ description: Original blocks (first transmission).
848
+ type: integer
849
+ bl_rex:
850
+ description: Retransmitted blocks.
851
+ type: integer
852
+ dup_blks:
853
+ description: Duplicate blocks (receiver).
854
+ type: integer
855
+ dup_last_blks:
856
+ description: Duplicate last blocks.
857
+ type: integer
858
+ drop_blks_xnf:
859
+ description: Blocks dropped, because the file transfer is not found (receiver).
860
+ type: integer
861
+ sndr_ctl:
862
+ description: Control messages from the sender (`sndr ctl`).
863
+ type: object
864
+ additionalProperties: false
865
+ properties:
866
+ sent:
867
+ description: Messages sent by the sender.
868
+ type: integer
869
+ rcvd:
870
+ description: Messages received by the receiver.
871
+ type: integer
872
+ lost:
873
+ description: Messages lost.
874
+ type: integer
875
+ lost_pct:
876
+ description: Messages lost (%, second `lost` of the group).
877
+ type: number
878
+ rcvr_ctl:
879
+ description: Control messages from the receiver (`rcvr ctl`).
880
+ type: object
881
+ additionalProperties: false
882
+ properties:
883
+ sent:
884
+ description: Messages sent by the receiver.
885
+ type: integer
886
+ rcvd:
887
+ description: Messages received by the sender.
888
+ type: integer
889
+ lost:
890
+ description: Messages lost.
891
+ type: integer
892
+ lost_pct:
893
+ description: Messages lost (%, second `lost` of the group).
894
+ type: number
895
+ rex_ctl:
896
+ description: Retransmission requests from the receiver (`rex ctl`).
897
+ type: object
898
+ additionalProperties: false
899
+ properties:
900
+ sent:
901
+ description: Messages sent by the receiver.
902
+ type: integer
903
+ rcvd:
904
+ description: Messages received by the sender.
905
+ type: integer
906
+ lost:
907
+ description: Messages lost.
908
+ type: integer
909
+ lost_pct:
910
+ description: Messages lost (%, second `lost` of the group).
911
+ type: number
912
+ progress:
913
+ description: Progress of the session.
914
+ type: object
915
+ additionalProperties: false
916
+ properties:
917
+ tx_bytes:
918
+ description: Bytes transferred, without duplicates (bytes).
919
+ type: integer
920
+ file_bytes:
921
+ description: File bytes transferred (bytes).
922
+ type: integer
923
+ tx_time:
924
+ description: Duration of the data transfer (µs).
925
+ type: integer
926
+ estimate_transfer_size:
927
+ description: Size of the source files (bytes, sender).
928
+ type: integer
929
+ num_rex_xfer_not_found:
930
+ description: Retransmission requests of a file transfer not found (sender).
931
+ type: integer
932
+ num_rex_abrtxfer_not_found:
933
+ description: Retransmission requests of an aborted file transfer not found
934
+ (sender).
935
+ type: integer
936
+ rex_xmit_blks:
937
+ description: Blocks retransmitted by the sender (receiver).
938
+ type: integer
939
+ xmit_total:
940
+ description: Blocks sent by the sender (receiver).
941
+ type: integer
942
+ rex_xmit_pct:
943
+ description: Blocks retransmitted by the sender (%, receiver).
944
+ type: number
945
+ fasp_version:
946
+ description: Version of `ascp` and build (`Initializing FASP version`).
947
+ type: string
948
+ license_max_rate:
949
+ description: Maximum rate of the license (bps), absent if unlimited
950
+ (`Initializing FASP version`, `max rate`).
951
+ type: integer
952
+ license_expires:
953
+ description: Expiry date of the license, as logged, absent if none
954
+ (`Initializing FASP version`, `license expires on`).
955
+ type: string
956
+ pMTU:
957
+ description: Path MTU measured at the start of the session (bytes, `Measured
958
+ pMTU`).
959
+ type: integer
960
+ start_brtt:
961
+ description: Base round-trip time measured at the start of the session (ms,
962
+ `Measured pMTU`).
963
+ type: integer
964
+ datagram_size:
965
+ description: Size of UDP packets (bytes, `datagram size`).
966
+ type: integer
967
+ block_size:
968
+ description: Size of data blocks (bytes, `block size`).
969
+ type: integer
970
+ path_mtu:
971
+ description: Path MTU used for the session (bytes, `path MTU` of the `datagram
972
+ size` line, absent in old versions).
973
+ type: integer
974
+ peer_rate_params:
975
+ description: Rate parameters adopted at the request of the peer, in the order of
976
+ the log (`Peer requested rate params adopted`).
977
+ type: array
978
+ items:
979
+ type: object
980
+ additionalProperties: false
981
+ properties:
982
+ time:
983
+ description: Time of the line.
984
+ type: string
985
+ format: date-time
986
+ target_rate:
987
+ description: Target rate (bps).
988
+ type: integer
989
+ min_rate:
990
+ description: Minimum rate (bps).
991
+ type: integer
992
+ transfer_policy:
993
+ description: 'Rate policy: `fixed`, `high`, `fair` or `low`.'
994
+ type: string
995
+ additionalProperties: false
996
+ Transfer:
997
+ description: 'A file transfer: `Transfer Start` and `Transfer Stop` lines of a
998
+ file. `Transfer Stop` has the fields of `Transfer Start`, with their
999
+ final values.'
1000
+ type: object
1001
+ properties:
1002
+ log_file:
1003
+ $ref: '#/components/schemas/LogFile'
1004
+ uuid:
1005
+ description: Identifier of the session.
1006
+ type: string
1007
+ pid:
1008
+ $ref: '#/components/schemas/Pid'
1009
+ start:
1010
+ description: Time of `Transfer Start`.
1011
+ type: string
1012
+ format: date-time
1013
+ stop:
1014
+ description: Time of `Transfer Stop`.
1015
+ type: string
1016
+ format: date-time
1017
+ op:
1018
+ description: Direction of the session.
1019
+ type: string
1020
+ enum:
1021
+ - send
1022
+ - recv
1023
+ status:
1024
+ description: Status of the file transfer.
1025
+ type: string
1026
+ enum:
1027
+ - started
1028
+ - success
1029
+ - failed
1030
+ errcode:
1031
+ description: Error code, when failed.
1032
+ type: integer
1033
+ errstr:
1034
+ description: Error message, when failed.
1035
+ type: string
1036
+ file:
1037
+ description: Path of the file.
1038
+ type: string
1039
+ size:
1040
+ description: Size of the file (bytes).
1041
+ type: integer
1042
+ start_byte:
1043
+ description: Offset where the transfer starts, when resumed (bytes).
1044
+ type: integer
1045
+ rate:
1046
+ description: Rate of the file transfer (bps).
1047
+ type: integer
1048
+ elapsed:
1049
+ description: Duration of the file transfer (s, `Transfer Stop`).
1050
+ type: number
1051
+ loss:
1052
+ description: Blocks lost (%).
1053
+ type: number
1054
+ rexreqs:
1055
+ description: Retransmitted blocks.
1056
+ type: integer
1057
+ overhead:
1058
+ description: Duplicate blocks.
1059
+ type: integer
1060
+ csum:
1061
+ description: Checksum of the file, when requested (`Transfer Stop`).
1062
+ type: string
1063
+ mtime:
1064
+ description: Modification time of the file, when preserved.
1065
+ type: string
1066
+ ctime:
1067
+ description: Creation time of the file, when preserved.
1068
+ type: string
1069
+ ol_legal_hold:
1070
+ description: 'Object lock legal hold: `on` or `off`.'
1071
+ type: string
1072
+ ol_retention:
1073
+ description: Object lock retention.
1074
+ type: object
1075
+ additionalProperties: false
1076
+ properties:
1077
+ mode:
1078
+ description: 'Retention mode: `governance` or `compliance`.'
1079
+ type: string
1080
+ until:
1081
+ description: End of retention.
1082
+ type: string
1083
+ additionalProperties: false
1084
+ security: []