You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.erb.md
+21-19Lines changed: 21 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -249,8 +249,8 @@ There are several ways to install <%=tool%>:
249
249
250
250
The following sections describe the various installation methods.
251
251
252
-
An internet connection is required for the installation.
253
-
If you do not have internet access, refer to section [Installation without internet access](#installation-in-air-gapped-environment).
252
+
An internet connection is required during installation.
253
+
If you do not have internet access, refer to section [Installation without internet access](#installation-in-an-air-gapped-environment).
254
254
255
255
### Single file executable
256
256
@@ -277,7 +277,7 @@ chmod a+x <%=cmd%>
277
277
278
278
> [!WARNING]
279
279
> On Linux, the executable requires a minimum GLIBC version, specified in the executable name on download site.
280
-
> If the minimuim version is not met, then executables (`ascp`, `transferd`) will exit with error.
280
+
> If the minimum version is not met, then executables (`ascp`, `transferd`) will exit with error.
281
281
282
282
On Linux, you can check your system's GLIBC version on this site: [repology.org](https://repology.org/project/glibc/versions), or check your GLIBC version with `ldd`:
283
283
@@ -585,7 +585,7 @@ JRUBY_OPTS=--dev <%=cmd%> -v
585
585
#### Optional gems
586
586
587
587
Some additional gems are required for either development, or some runtime specific features.
588
-
For JRuby, some replacement gems are proposed, or are nor available at all.
588
+
For JRuby, some replacement gems are proposed, or are not available at all.
589
589
Those are not installed as part of dependencies because they involve compilation of native code but concern less-used features.
590
590
591
591
See [Gemfile](<%=link_repo('Gemfile')%>):
@@ -742,7 +742,7 @@ Several methods are provided to start a transfer.
742
742
Use of a local client ([`direct`](#agent-direct) transfer agent) is one of them, but other methods are available.
743
743
Refer to section: [Transfer Agents](#transfer-clients-agents)
744
744
745
-
### Installation in air gapped environment
745
+
### Installation in an air-gapped environment
746
746
747
747
> [!NOTE]
748
748
> No pre-packaged version is provided yet.
@@ -925,8 +925,8 @@ As shown in the quick start, if you prefer to keep a running container with a sh
925
925
> <%=tool%> is run inside the container, so transfers are also executed inside the container and do not have access to host storage by default.
926
926
927
927
You may also probably want that files downloaded in the container are directed to the host.
928
-
For example, files transfered with <%=tool%> through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
929
-
In this case you need also to specify the shared transfer folder as a volume:
928
+
For example, files transferred with <%=tool%> through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
929
+
In this case you also need to specify the shared transfer folder as a volume:
930
930
931
931
```shell
932
932
--volume $HOME/xferdir:/xferfiles
@@ -1616,7 +1616,7 @@ In those cases, there is no character to protect because values are not parsed b
1616
1616
### Positional Arguments and Options
1617
1617
1618
1618
Command line arguments are the units of command line typically separated by spaces (the `argv` of C).
1619
-
The tokenization of the command line is typically done by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1619
+
Command line tokenization is typically performed by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1620
1620
1621
1621
<%=tool%> handles two types of command line arguments:
Many applications are available, including on internet, to generate key pairs.
3014
+
Many applications are available, including on the internet, to generate key pairs.
3015
3015
For example: <https://cryptotools.net/rsagen>
3016
3016
3017
3017
> [!WARNING]
@@ -3020,7 +3020,7 @@ For example: <https://cryptotools.net/rsagen>
3020
3020
### Web service
3021
3021
3022
3022
Some plugins start a local web server.
3023
-
This server can server HTTP or HTTPS (with certificate):
3023
+
This server can serve HTTP or HTTPS (with certificate):
3024
3024
3025
3025
The following parameters are supported:
3026
3026
@@ -3191,7 +3191,7 @@ HTTP connection parameters (not `ascp` WSS) can be adjusted using option `http_o
3191
3191
| `token_cache_max_age` | `Integer` | `1800` | `OAuth` class |
3192
3192
| `token_refresh_threshold` | `Integer` | `120` | `OAuth` class |
3193
3193
3194
-
Time values are in set **seconds** and can be of type either `Integer` or `Float`.
3194
+
Time values are set in **seconds** and can be of type either `Integer` or `Float`.
3195
3195
Default values are the ones of Ruby:
3196
3196
For a full list, refer to the Ruby library: [`Net::HTTP`](https://github.com/ruby/net-http/blob/master/lib/net/http.rb).
3197
3197
@@ -3337,7 +3337,7 @@ It provides the following commands for `ascp` sub-command:
3337
3337
- `show` : shows the path of `ascp` used
3338
3338
- `use` : specify the `ascp` path to use
3339
3339
- `products` : list Aspera transfer products available locally
3340
-
- `connect` : list and download connect client versions available on internet
3340
+
- `connect` : list and download connect client versions available on the internet
3341
3341
3342
3342
#### Selection of `ascp` location for [`direct`](#agent-direct) agent
3343
3343
@@ -4992,7 +4992,7 @@ The following parameters are supported:
4992
4992
| `pmax` | <%=tool%> | Maximum number of pages to request. |
4993
4993
| other | Native | Other specific parameters depending on resource type. |
4994
4994
4995
-
> [!INFO]
4995
+
> [!NOTE]
4996
4996
> Both `max` and `pmax` are processed internally in <%=tool%>, not included in actual API call and limit the number of successive pages requested to API.
4997
4997
> <%=tool%> will return all values using paging if not provided.
4998
4998
> `page` and `per_page` are normally added by <%=tool%> to build successive API calls to get all values if there are more than 1000.
@@ -5143,7 +5143,7 @@ Refer to section **Examples** of [ATS](#plugin-ats-ibm-aspera-transfer-service)
5143
5143
Aspera on Cloud Shared folders are implemented through a special type of file: `link`.
5144
5144
A `link` is the equivalent of a symbolic link on a file system: it points to another folder (not file).
5145
5145
5146
-
Listing a link (in terminal position of path) will information on the link itself, not the content of the folder it points to.
5146
+
Listing a link (in terminal position of path) will show information on the link itself, not the content of the folder it points to.
5147
5147
To list the target folder content, add a `/` at the end of the path.
5148
5148
5149
5149
Example:
@@ -5217,7 +5217,7 @@ Current Workspace: Default (default)
5217
5217
+-------+---------+
5218
5218
```
5219
5219
5220
-
#### Example: Find deactivated users since more than 2 years
5220
+
#### Example: Find deactivated users for more than 2 years
5221
5221
5222
5222
```shell
5223
5223
<%=cmd%> aoc admin user list --query=@ruby:'{"deactivated"=>true,"q"=>"last_login_at:<#{(DateTime.now.to_time.utc-2*365*86400).iso8601}"}'
@@ -6473,7 +6473,7 @@ Option `node_api` (`Hash`) controls some options of API used, with the following
6473
6473
6474
6474
| Parameter| Default | Description |
6475
6475
|----------|---------|-------------|
6476
-
|`cache`|`true`|`true` Folder content retrieved from Redis database (faster).<%=br%>`false` Folder content retrieved from storage. |
6476
+
|`cache`|`true`|`true` Folder content is retrieved from the Redis database (faster).<%=br%>`false` Folder content retrieved from storage. |
6477
6477
|`standard_ports`|`true`|`true` Use hard coded standard ports (`33001`)<%=br%>`false` Retrieve server ports from an API call (`download_setup`) which reads the information from `aspera.conf` on the server. |
6478
6478
|`accept_v4`|`true`|`true` (default) uses API header: `Accept-Version: 4.0`.<%=br%>`false` uses legacy method (refer to node API). |
6479
6479
|`per_page`| - | Requested number of items per API call.<%=br%>Set to `nil` (`@none:`) to deactivate paging.<%=br%>Default: `1000` when `accept_v4` is `true`. |
@@ -7079,7 +7079,7 @@ The user will use the following options:
7079
7079
7080
7080
### Faspex 5 public link authentication
7081
7081
7082
-
If all you have is a public link received by email or other, you can still do authorized actins with it.
7082
+
If all you have is a public link received by email or other, you can still do authorized actions with it.
7083
7083
7084
7084
For example, for a public link to post a package:
7085
7085
@@ -8218,7 +8218,9 @@ If the preview generator does not have access to files on the file system (it is
8218
8218
8219
8219
## Operational Utilities
8220
8220
8221
-
This section covers the specialized modules and utilities used to integrate <%=tool%> into your broader operational infrastructure. While the core plugins handle data movement, these tools provide the "connective tissue" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations. Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
8221
+
This section covers the specialized modules and utilities used to integrate <%=tool%> into your broader operational infrastructure.
8222
+
While the core plugins handle data movement, these tools provide the "integration layer" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations.
8223
+
Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
8222
8224
8223
8225
### IBM Aspera Sync
8224
8226
@@ -8420,7 +8422,7 @@ Interesting `ascp` features are found in its arguments: (see `ascp` manual):
8420
8422
- Send only files not modified since the last X seconds:
8421
8423
- `--exclude-newer-than` (`exclude_newer_than`)
8422
8424
- `--exclude-older-than` (`exclude_older_than`)
8423
-
- Top level folder shall not be created on destination
8425
+
- Top level folder should not be created on destination
Copy file name to clipboardExpand all lines: docs/README.md
+21-19Lines changed: 21 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -250,8 +250,8 @@ There are several ways to install `ascli`:
250
250
251
251
The following sections describe the various installation methods.
252
252
253
-
An internet connection is required for the installation.
254
-
If you do not have internet access, refer to section [Installation without internet access](#installation-in-air-gapped-environment).
253
+
An internet connection is required during installation.
254
+
If you do not have internet access, refer to section [Installation without internet access](#installation-in-an-air-gapped-environment).
255
255
256
256
### Single file executable
257
257
@@ -278,7 +278,7 @@ chmod a+x ascli
278
278
279
279
> [!WARNING]
280
280
> On Linux, the executable requires a minimum GLIBC version, specified in the executable name on download site.
281
-
> If the minimuim version is not met, then executables (`ascp`, `transferd`) will exit with error.
281
+
> If the minimum version is not met, then executables (`ascp`, `transferd`) will exit with error.
282
282
283
283
On Linux, you can check your system's GLIBC version on this site: [repology.org](https://repology.org/project/glibc/versions), or check your GLIBC version with `ldd`:
284
284
@@ -589,7 +589,7 @@ JRUBY_OPTS=--dev ascli -v
589
589
#### Optional gems
590
590
591
591
Some additional gems are required for either development, or some runtime specific features.
592
-
For JRuby, some replacement gems are proposed, or are nor available at all.
592
+
For JRuby, some replacement gems are proposed, or are not available at all.
593
593
Those are not installed as part of dependencies because they involve compilation of native code but concern less-used features.
594
594
595
595
See [Gemfile](../Gemfile):
@@ -790,7 +790,7 @@ Several methods are provided to start a transfer.
790
790
Use of a local client ([`direct`](#agent-direct) transfer agent) is one of them, but other methods are available.
791
791
Refer to section: [Transfer Agents](#transfer-clients-agents)
792
792
793
-
### Installation in air gapped environment
793
+
### Installation in an air-gapped environment
794
794
795
795
> [!NOTE]
796
796
> No pre-packaged version is provided yet.
@@ -973,8 +973,8 @@ As shown in the quick start, if you prefer to keep a running container with a sh
973
973
> `ascli` is run inside the container, so transfers are also executed inside the container and do not have access to host storage by default.
974
974
975
975
You may also probably want that files downloaded in the container are directed to the host.
976
-
For example, files transfered with `ascli` through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
977
-
In this case you need also to specify the shared transfer folder as a volume:
976
+
For example, files transferred with `ascli` through folder `/xferfiles` (right hand side) would be available on host in `$HOME/xferdir`.
977
+
In this case you also need to specify the shared transfer folder as a volume:
Command line arguments are the units of command line typically separated by spaces (the `argv` of C).
1667
-
The tokenization of the command line is typically done by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1667
+
Command line tokenization is typically performed by the shell, refer to the previous section [Command Line Parsing](#command-line-parsing-special-characters).
1668
1668
1669
1669
`ascli` handles two types of command line arguments:
Many applications are available, including on internet, to generate key pairs.
3170
+
Many applications are available, including on the internet, to generate key pairs.
3171
3171
For example: <https://cryptotools.net/rsagen>
3172
3172
3173
3173
> [!WARNING]
@@ -3176,7 +3176,7 @@ For example: <https://cryptotools.net/rsagen>
3176
3176
### Web service
3177
3177
3178
3178
Some plugins start a local web server.
3179
-
This server can server HTTP or HTTPS (with certificate):
3179
+
This server can serve HTTP or HTTPS (with certificate):
3180
3180
3181
3181
The following parameters are supported:
3182
3182
@@ -3347,7 +3347,7 @@ HTTP connection parameters (not `ascp` WSS) can be adjusted using option `http_o
3347
3347
| `token_cache_max_age` | `Integer` | `1800` | `OAuth` class |
3348
3348
| `token_refresh_threshold` | `Integer` | `120` | `OAuth` class |
3349
3349
3350
-
Time values are in set **seconds** and can be of type either `Integer` or `Float`.
3350
+
Time values are set in **seconds** and can be of type either `Integer` or `Float`.
3351
3351
Default values are the ones of Ruby:
3352
3352
For a full list, refer to the Ruby library: [`Net::HTTP`](https://github.com/ruby/net-http/blob/master/lib/net/http.rb).
3353
3353
@@ -3493,7 +3493,7 @@ It provides the following commands for `ascp` sub-command:
3493
3493
- `show` : shows the path of `ascp` used
3494
3494
- `use` : specify the `ascp` path to use
3495
3495
- `products` : list Aspera transfer products available locally
3496
-
- `connect` : list and download connect client versions available on internet
3496
+
- `connect` : list and download connect client versions available on the internet
3497
3497
3498
3498
#### Selection of `ascp` location for [`direct`](#agent-direct) agent
3499
3499
@@ -5531,7 +5531,7 @@ The following parameters are supported:
5531
5531
| `pmax` | `ascli` | Maximum number of pages to request. |
5532
5532
| other | Native | Other specific parameters depending on resource type. |
5533
5533
5534
-
> [!INFO]
5534
+
> [!NOTE]
5535
5535
> Both `max` and `pmax` are processed internally in `ascli`, not included in actual API call and limit the number of successive pages requested to API.
5536
5536
> `ascli` will return all values using paging if not provided.
5537
5537
> `page` and `per_page` are normally added by `ascli` to build successive API calls to get all values if there are more than 1000.
@@ -5682,7 +5682,7 @@ Refer to section **Examples** of [ATS](#plugin-ats-ibm-aspera-transfer-service)
5682
5682
Aspera on Cloud Shared folders are implemented through a special type of file: `link`.
5683
5683
A `link` is the equivalent of a symbolic link on a file system: it points to another folder (not file).
5684
5684
5685
-
Listing a link (in terminal position of path) will information on the link itself, not the content of the folder it points to.
5685
+
Listing a link (in terminal position of path) will show information on the link itself, not the content of the folder it points to.
5686
5686
To list the target folder content, add a `/` at the end of the path.
5687
5687
5688
5688
Example:
@@ -5756,7 +5756,7 @@ ascli aoc admin user list --query='@json:{"q":"dummyuser"}' --fields=id --displa
5756
5756
+-------+---------+
5757
5757
```
5758
5758
5759
-
#### Example: Find deactivated users since more than 2 years
5759
+
#### Example: Find deactivated users for more than 2 years
5760
5760
5761
5761
```shell
5762
5762
ascli aoc admin user list --query=@ruby:'{"deactivated"=>true,"q"=>"last_login_at:<#{(DateTime.now.to_time.utc-2*365*86400).iso8601}"}'
@@ -7213,7 +7213,7 @@ Option `node_api` (`Hash`) controls some options of API used, with the following
7213
7213
7214
7214
| Parameter| Default | Description |
7215
7215
|----------|---------|-------------|
7216
-
|`cache`|`true`|`true` Folder content retrieved from Redis database (faster).<br/>`false` Folder content retrieved from storage. |
7216
+
|`cache`|`true`|`true` Folder content is retrieved from the Redis database (faster).<br/>`false` Folder content retrieved from storage. |
7217
7217
|`standard_ports`|`true`|`true` Use hard coded standard ports (`33001`)<br/>`false` Retrieve server ports from an API call (`download_setup`) which reads the information from `aspera.conf` on the server. |
7218
7218
|`accept_v4`|`true`|`true` (default) uses API header: `Accept-Version: 4.0`.<br/>`false` uses legacy method (refer to node API). |
7219
7219
|`per_page`| - | Requested number of items per API call.<br/>Set to `nil` (`@none:`) to deactivate paging.<br/>Default: `1000` when `accept_v4` is `true`. |
@@ -7910,7 +7910,7 @@ The user will use the following options:
7910
7910
7911
7911
### Faspex 5 public link authentication
7912
7912
7913
-
If all you have is a public link received by email or other, you can still do authorized actins with it.
7913
+
If all you have is a public link received by email or other, you can still do authorized actions with it.
This section covers the specialized modules and utilities used to integrate `ascli` into your broader operational infrastructure. While the core plugins handle data movement, these tools provide the "connective tissue" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations. Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
9299
+
This section covers the specialized modules and utilities used to integrate `ascli` into your broader operational infrastructure.
9300
+
While the core plugins handle data movement, these tools provide the "integration layer" for enterprise environments: Aspera Sync and Hot Folder enable automated, folder-based synchronization; Nagios and SMTP modules provide health monitoring and automated email alerting for transfer status; and `asession` and module manage internal session states and environment configurations.
9301
+
Together, these features transform the CLI from a manual tool into a fully integrated component of an automated, monitored data workflow.
9300
9302
9301
9303
### IBM Aspera Sync
9302
9304
@@ -9631,7 +9633,7 @@ Interesting `ascp` features are found in its arguments: (see `ascp` manual):
9631
9633
- Send only files not modified since the last X seconds:
9632
9634
- `--exclude-newer-than` (`exclude_newer_than`)
9633
9635
- `--exclude-older-than` (`exclude_older_than`)
9634
-
- Top level folder shall not be created on destination
9636
+
- Top level folder should not be created on destination
0 commit comments