The Nodeum Client nd command line tool provides a modern set of commands to execute data movement operations with Nodeum. The nd command line tool is built for compatibility with the Nodeum v2 for expected functionality and behavior.
nd has the following syntax:
nd [GLOBALFLAGS] COMMAND --help
See Command Quick Reference for a list of supported commands.
Copyright
nd is a property of Nodeum and its subsidaries, if any. The intellectual and technical concepts contained herein are proprietary to Nodeum and its subsidaries and may be covered by Belgium and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Nodeum.
Related Version: ND-2.0.8
Quickstart
Install nd
Install the nd command line tool onto the host machine. Go in the section that corresponds to the host machine operating system or environment:
Linux
The following commands add a temporary extension to your system PATH for running the nd bash client. Defer to your operating system instructions for making permanent modifications to your system PATH.
Alternatively, execute nd by navigating to the parent folder and running ./nd --help
Once download, rename the file to nd.exe and execute the file by double clicking on it, or by running the following in the command prompt or powershell:
The nd client provides a Bash completion mechanism to facilitate the search of commands.
Metadata key can't include an = character.
Global Parameters
Mandatory Parameters for OpenID integration
Parameters are available for each data movement task.
Standard Parameters
Parameters are available for each data movement task.
Advanced Parameters
Parameters are available for each data movement task.
3. Configuration
nd uses a JSON formatted configuration file used for storing certain kinds of information, such as the authentication and authorization options. By default, this configuration file is unique by user. It is stored in its home directory.
For Linux and macOS, the default configuration file location is .config/.nd/config.json which is store in the $HOME. For Windows, the configuration file is stored in $AppData$.
You can display the configuration file location in using the command nd --help:
You can use the --config value where value is the path to a JSON formatted configuration file that nd uses for storing data. The ND_CONFIG environment variable can be used to set the value.
Store the configuration file in a 'central' directory to allow each user to get the same nd client configuration. For this, the --config-dir value is available.
Command
SSL
nd client allows SSL configuration to communicate with the Data Mover service which listen in HTTPS. It is required to add the public certificate generated with the server.
The public certificate file has to be stored in this config-dir folder: .config/.nd/certs/CAs/.
The certificates on the server side have been generated following this command:
The nd client provides an OpenID authentication mechanism. In this case, nd Client has to be configured with the appropriated IDP to handle proper token management.
The standard behavior is to request a token, which is automatic if there is no token available. The token will be stored in a cache during 15 minutes. The --persist-session-renew option can be defined to true to force a request token process any time the user has to interface with the nd client.
The token renewal is automatic based on the renewal token.
Alias & default flags
Description
Alias & default flags allow structuration of different group of settings. Different alias can be defined in the configuration file.
Definition of alias & default flags
Alias and flags are declared in the configuration file ~/.config/.nd/config.json". Default flags are defined for each available parameter command. Flags can be overwritted in the nd command.
Example in config file:
{// ...// default: name of alias used by default"default": { // ..."default_flags": {// this is the name of the command, example: nd copy"copy": {// this is the flag, example: nd copy --md project_domain_name=MYPROJECTDOMAIN --md user_domain_name=MYUSERDOMAIN"md": ["project_domain_name=MYPROJECTDOMAIN","user_domain_name=MYUSERDOMAIN"] } } },// myorganisation: name of another alias"myorganisation": { // ... }}
Alias usage
The nd command allows the usage of alias, example : nd --alias myorganisation copy
4. Data Mover Service Status
Command
Data Management Monitoring Services
nd admin status command requests the Data Management Monitoring service to retrieve the status and health of each services part of the cluster. This command returns list of services. The following information are displayed:
The definition of a working directory allows to define where the files will be stored at the destination. Different options are available, they are described in the following definition.
The objective of defer task is to create the task and already initiate the authentication process but defers its execution. Unique IDs will be returned.
This command list all tasks created by the user in the data mover service.
The columns describe:
Output
+--------------------------+------------------------------------------------------------+---------+-------------------+-----------------------+
| TASK ID | TASK NAME |COMMENT |CREATED | LAST EXECUTION STATUS |
+--------------------------+------------------------------------------------------------+---------+-------------------+-----------------------+
| 6287a774a91db0b194e97d8d | From /largedata2_pool/storagetestdata/data5 to my_pool1 | | USER 1 | done |
| 628b45f5a91db04211739dc6 | From /largedata2_pool/storagetestdata/data5 to my_pool1 | | USER 1 | done |
| 628b468ea91db04211739dc9 | From /largedata2_pool/storagetestdata/data5 to my_pool1 | | USER 1 | done |
| 6331d52ba91db02d6797e6ae | From nod://largedata2_pool/storagetestdata/ to vg--1598 | | USER 1 | stopped_by_user |
| 6331d5aca91db02d6797e6b1 | From nod://largedata2_pool/storagetestdata/ to vg--1598 | | USER 1 | stopped_by_user |
| 6331d5c5a91db02d6797e6b4 | From nod://largedata2_pool/storagetestdata/ to vg--1590 | | USER 1 | stopped_by_user |
| 6331d677a91db02d6797e6b7 | From nod://largedata2_pool/storagetestdata/ to vg--1598 | | USER 1 | done |
| 6331d692a91db02d6797e6ba | From nod://largedata2_pool/storagetestdata/ to vg--1598 | | USER 1 | stopped_by_user |
| 6331d948a91db02d6797e6c6 | From nod://largedata2_pool/storagetestdata/ to vg--1598 | | USER 1 | stopped_by_user |
| 6333ffdda91db091264b68a5 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | finished with warning |
| 6333fff6a91db092d94b68a2 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | finished with warning |
| 63355214a91db0397f128dbf | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | done |
| 63355218a91db0397f128dc2 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | done |
| 63355220a91db0a6ec22073e | From nod://largedata2_pool/storagetestdata/ to vg--1501 | | USER 1 | done |
| 6335549aa91db0397f128dc5 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | done |
| 6335549da91db0397f128dc8 | From nod://largedata2_pool/storagetestdata/ to vg--1502 | | USER 1 | done |
| 633554a1a91db0a6ec220741 | From nod://largedata2_pool/storagetestdata/ to vg--1506 | | USER 1 | done |
| 63358216a91db0397f128dcb | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | finished with warning |
| 6335822da91db0397f128dce | From nod://largedata2_pool/storagetestdata/ to vg--1502 | | USER 1 | done |
| 633584d5a91db0397f128dd1 | From nod://largedata2_pool/storagetestdata/ to vg--1502 | | USER 1 | finished with warning |
| 6336b341a91db0397f128dd4 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | done |
| 6336b35da91db0c2985ff420 | From nod://largedata2_pool/storagetestdata/ to vg--1500 | | USER 1 | done |
+--------------------------+------------------------------------------------------------+---------+-------------------+-----------------------+
| NUMBER OF TASK(S) 22 | | | |
+--------------------------+------------------------------------------------------------+---------+-------------------+-----------------------+
Tasks status
Description
At the end of each task execution, the task result is displayed if the --progress parameter is set at true.
The nd task status command allow to display the status any task. The default command execution display a summary of the task status including number of files copied, size copied, overall status, ....
Additional parameters are available to get more insights about the task.
Additional Parameters
Example of Command
# nd task status 633ecc74a91db0f38f7abc2e
where 633ecc74a91db0f38f7abc2e is the id of the task
