Node Admin Tool

Use the asnodeadmin tool to manage (add, modify, delete, and list) Node API users. Root privileges are required.

Syntax: 

# /opt/aspera/bin/asnodeadmin [options]

Usage Examples

These examples use short options; run asnodeadmin -h to see the corresponding long options.

1. Add Node API username usr1 with the Node API password pass1 (you are prompted to enter if the -p option is not given) and associate them with the transfer user aspera:  

# /opt/aspera/bin/asnodeadmin -au usr1 -x aspera [-p pass1]

2. Add Node API username usr2 with Node API password pass2 and associate them with transfer user root: 

# /opt/aspera/bin/asnodeadmin -au usr2 -p pass2 -x root

3. Modify Node API username usr1 by assigning a different password, pass1.1:        

# /opt/aspera/bin/asnodeadmin -mu usr1 -p pass1.1

4. List Node API usernames in the current user database:

# /opt/aspera/bin/asnodeadmin -l

5. Delete Node API username usr1:

# /opt/aspera/bin/asnodeadmin -du usr1

6. Create a bearer token: See Bearer Tokens.

All Options

-h,--help                     Display usage.
-A,--version                  Display version.
-a,--add                      Add a user (also reloads configuration).
--access-key access_key        Specify the access_key. Use with --transfer options, --bearer-create, --bearer-verify,
                              and --access-key-backup.
--access-key-backup filename   Backup tenant data to an AOF file. Use with --access-key.
--access-key-restore filename  Restore tenant data from an AOF file. Use with -u to change the Node API user (and
                              system user associated with the access key). 
--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.
-b,--backup=filename           Backup user data to a file.
--bearer-create               Generate bearer token.
    --expires-at utc_date          Specify the expiration date for --bearer-create.
    --group-ids id1,id2,...        Specify the group-id for --bearer-create.
    --key-file-path dir           Specify the key file directory for --bearer-create.
    --scope-role role              Specify the scope role for --bearer-create.
    --token-key-length            Specify the RSA key length for --bearer-create.
    --user-id user_id              Specify the user-id for --bearer-create.  
--bearer-verify               Verify bearer token.  
-f conf_filename                Specify the configuration file (default: aspera.conf).
-D...                         Debug level (default: no debug output).
-d,--del[ete]                 Delete an existing user (also reloads configuration).
--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.
--internal                    Required for adding, modifying, or deleting internal users.
-L local_log_dir               Local logging directory (default: no logging).
-l,--list                     List users.
-m,--mod[ify]                 Modify an existing user (also reloads configuration).
-P                            Display hashed passwords when listing users (with -l).
-p,--{pwd|password}=passwd    Specify Node API user password.
-r,--restore=filename          Restore user data from a file.
--reload                      Reload configuration settings, including the conf file
                              (also done implicitly upon user add, modify and delete).
--show-transfer-queue         Displays the current transfer queue.
--show-transfer-log           Displays the output of data.
--transfer-bandwidth-cleanup  Removes invalid bandwidth data.
--transfer-bandwidth-del-all  Deletes all bandwidth counter data.
    --interruptible               Allow bandwidth-del-all to be stopped while running.
--transfer-log-cleanup        Delete all transfers from the activity log older than activity_retention_hrs.
--transfer-log-list           List transfers from the transfer log.
--transfer-log-del xnid       Delete an individual transfer from the activity log.
--transfer-queue              Display the transfer queue.
-u,--user=username             Specify Node API username (use with -a, -m, -d, --access-key-restore).
-x,--xuser=xfer_username        Specify system transfer user.