Syntax and Usage
General Syntax
# asconfigurator -x "command[;parameter,value;parameter,value]"The command is either a set command for setting a configuration or a delete command for removing a configuration. For any command you may enter one or more set of parameters and values separated by semicolons.
Note: The user executing asconfigurator commands must meet the
following requirements:
- Have write access to aspera.conf.
- Not be configured to use a shell that restricts command usage (aspshell does not allow the use of asconfigurator).
Commands for Setting Parameter Values
| Command | Description |
|---|---|
| set_user_data | Sets data in the user section. For parameters and values, see User, Group and Default Configurations. |
| set_group_data | Sets data in the group section. For parameters and values, see User, Group and Default Configurations. |
| set_trunk_data | Sets data in the trunk section, which contains Vlink settings. For parameters and values, see Trunk (Vlink) Configurations. |
| set_central_server_data | Sets data in the central server section, which contains Aspera Central and SOAP settings. For parameters and values, see Central Server Configurations. |
| set_database_data | Sets data in the database section, which contains settings for use with Aspera Console (earlier than 3.0). For parameters and values, see Database Configurations. |
| set_server_data | Sets data in the server section, which contains transfer server feature settings for use with the Node API. For parameters and values, see Server Configurations. |
| set_http_server_data | Sets data in the HTTP fallback server section. For parameters and values, see HTTP Server Configurations. |
| set_client_data | Sets data from the client section, which holds client transfer settings. For parameters and values, see Client Configurations. |
| set_node_data | Sets data in the default section, which holds the "global" node settings. For parameters and values, see User, Group and Default Configurations. |
Note: To reset a parameter to its default value, you can use a set command for
the parameter with a value of AS_NULL.
Commands for Deleting Configurations
Delete commands can be used for removing a user, group or Vlink configuration.| Command | Description |
|---|---|
| delete_user | Deletes a user's configurations. |
| delete_group | Deletes a group's configurations. |
| delete_trunk | Deletes a Vlink's configurations. |
Modifying Files other than aspera.conf
The general syntax above modifies the default aspera.conf. You can also run asconfigurator to modify an XML file of your choice instead of aspera.conf.The command below takes a path to a file to modify. If the file does not exist, it is created.
# asconfigurator -x "command[;parameter,value;parameter,value]" /path/to/fileThe command below takes paths to two files. The first file is used as a base, and the modifications are written to the second file.
# asconfigurator -x "command[;parameter,value;parameter,value]" /path/to/file /path/to/file1Using Fitness Rules
Fitness rules allow you to apply configuration settings conditionally when specified
rules are met. Fitness rules are added to aspera.conf
configurations as attributes within XML tags, such as the
following:
<value fitness="peer_ip"(192.168.15.81)>allow</value>In the example above, the parameter is set to allow if the peer IP
address is 192.168.15.81.
Fitness Rule Syntax:
# asconfigurator -x "command;parameter,value,fitness,fitness_rule(fitness_template)"| Fitness Rule | Example | Description |
|---|---|---|
| cookie() | cookie(wilcard_template) | The parameter value is applied if the cookie passed from the application matches the specified template. |
| peer_ip() | peer_ip(ip_address/netmask) | The parameter value is applied if the IP address of the peer (the client) matches the specified IP address and optionally, its netmask. |
| peer_domain() | peer_domain(wilcard_template) | The parameter value is applied if the domain of the peer (the client) matches the specified template. |
For example, to set a peer_ip fitness rule on the authorization_transfer_in_value configuration so that incoming transfers from 192.168.16.70 are denied, run the following command:
# asconfigurator -x "set_node_data;authorization_transfer_in_value,deny,fitness,peer_ip(192.168.16.70)"