Node Admin Tool

The asnodeadmin utility is used to configure node users. The syntax and command options are described below.

Note: Running asnodeadmin requires admin privileges.


> asnodeadmin [options]

To view asnodeadmin options run the following command:

> asnodeadmin -h

The output is similar to the example below:

-h,--help                     Display usage.
-A,--version                  Display version.
-f conf_file                  Conf file pathname (default: aspera.conf).
--reload                      Reload configuration settings, including the conf file
                              (also done implicitly upon user add, modify and delete).
-a,--add                      Add a user (also reloads configuration).
-d,--del[ete]                 Delete an existing user (also reloads configuration).
-m,--mod[ify]                 Modify an existing user (also reloads configuration).
--acl-add                     Add new ACLs for a user.  May be used with -m or -a.
--acl-set                     Sets ACLs (clears old ACLs) for a user.  May be used with -m or -a.
--acl-del                     Deletes ACLs for a user.  May be used with -m.
--acl-list                    Lists all current ACLs for a user.
--internal                    Required for adding, modifying, or deleting internal users.
-l,--list                     List users.
-u,--user=username           Specify username.
-p,--{pwd|password}=passwd   Specify password.
-x,--xuser=xfer_username      Specify system transfer user.
-b,--backup=filename         Back_up user data to a file.
-r,--restore=filename        Restore user data from a file.
-P                            Display hashed passwords as well when listing users.
-L local_log_dir              Local logging directory (default: no logging).
-D...                         Debug level (default: no debug output).
--show-transfer-queue         Displays the current transfer queue
--transfer-log-del xnid     Delete an individual transfer from the activity log.
--access-key access_key       Specifies which access_key --transfer-log-del, --bearer-create, and --bearer-verify will use
--transfer-log-cleanup        Delete all transfers from the activity log older than activity_retention_hrs.
--show-transfer-log           Displays the output of data.
--bearer-create               Generate bearer token.
--key-file-path               Specifies the file path to read and write pem files for --bearer-create.
--token-key-length            Specifies the RSA key length for --bearer-create.
--user-id user_id           Specifies the user-id for --bearer-create.
--group-ids id1,id2,...     Specifies the group-id for --bearer-create.
--scope-role role           Specifies the scope role for --bearer-create.
--expires-at utc_date       Specifies the expiration date for --bearer-create.
--bearer-verify               Verify bearer token.
--db-status                   Display the database status.
--db-startup                  Start up the database.
--db-shutdown                 Shut down the database.
--db-cleanup                  Clean up the database.
--db-update                   Update KV store keys format to the latest version.
--db-update-local             Update KV store keys format to the latest version only if using the local redis.
--transfer-bandwidth-cleanup  Removes invalid bandwidth data.
--transfer-bandwidth-del-all  Deletes all bandwidth counter data.
--interruptible               Forces bandwidth-del-all to run so that it can be stopped while running.