Nodeum

https://docs.nodeum.io/
Admin
Nodeum is a hybrid storage and data management solution designed to automate high-performance,...
Tokens:313,322
Snippets:1,579
Trust Score:7.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/task-options.md

Example request for querying the documentation dynamically using the ask parameter.

```http
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/task-options.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Ansible Prerequisites

Source: https://docs.nodeum.io/data-mover/install-and-deploy/ansible-based-installation.md

Commands to install EPEL release and sshpass for multi-node deployments.

```bash
$ yum install epel-release
```

```bash
$ yum install sshpass
```

--------------------------------

### Install Ansible collections

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Commands to install and verify the community.general Ansible collection.

```bash
$ ansible-galaxy collection install community.general --upgrade
$ ansible-galaxy collection list community.general

# /root/.ansible/collections/ansible_collections
Collection        Version
----------------- -------
community.general 13.0.1

# /usr/local/lib/python3.9/site-packages/ansible_collections
Collection        Version
----------------- -------
community.general 7.5.2
```

--------------------------------

### Install gluster.gluster collection

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install the gluster.gluster collection via ansible-galaxy.

```bash
$ ansible-galaxy collection install gluster.gluster
```

--------------------------------

### Install Nodeum Package Dependencies

Source: https://docs.nodeum.io/data-mover/install-and-deploy/ansible-based-installation.md

Commands to install wget and download the Nodeum package.

```bash
yum install wget
```

```bash
wget get.nodeum.io/public/nodeum-v2-x-y-zzz.tar.gz
```

--------------------------------

### GET /faq/advanced-settings-proxy-configuration.md

Source: https://docs.nodeum.io/faq/advanced-settings-proxy-configuration.md

Perform an HTTP GET request to query the documentation dynamically for specific information.

```APIDOC
## GET /faq/advanced-settings-proxy-configuration.md

### Description
Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve answers, relevant excerpts, and sources from the documentation.

### Method
GET

### Endpoint
https://docs.nodeum.io/faq/advanced-settings-proxy-configuration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Install Python 3.9

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install Python 3.9 using the DNF package manager.

```bash
$ dnf install python39
```

--------------------------------

### Install Python 3.10 and pip on Ubuntu 22.04

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Commands to install Python 3.10 and upgrade pip.

```bash
$ apt install python3.10
```

```bash
$ apt install python3-pip
$ pip3 install pip3 --upgrade
```

--------------------------------

### Install Python 3.12 and pip on Ubuntu 24.04

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Commands to install Python 3.12 and upgrade pip.

```bash
$ apt install python3.12
```

```bash
$ apt install python3-pip
$ pip3 install pip3 --upgrade
```

--------------------------------

### Run Ansible playbooks

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Execute the installation playbook to deploy Nodeum.

```bash
$ ansible-playbook install.yml
```

--------------------------------

### GET /containers/-/configure

Source: https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/containers.md

Check the result of a containers reconfiguration job.

```APIDOC
## GET /containers/-/configure

### Description
Check the result of the containers reconfiguration process.

### Method
GET

### Endpoint
/containers/-/configure

### Parameters
#### Query Parameters
- **job_id** (string) - Required - ID of active job

### Response
#### Success Response (200/202)
- **job_id** (string) - The ID of the job
- **status** (string) - The current status of the job (queued, working, completed, failed)
- **progress** (integer) - The current progress of the job
- **total** (integer) - The total work units for the job
```

--------------------------------

### Perform a GET request using cURL

Source: https://docs.nodeum.io/data-archiving/api-developers/restful-api-guide.md

Basic example of a GET request to the files endpoint on the local nodeum instance.

```bash
$ curl "https://nodeum.local/api/v2/files"
```

--------------------------------

### Start Nodeum Services

Source: https://docs.nodeum.io/data-archiving/container/cache-configuration-requirements.md

Initializes all core Nodeum services using the startup script.

```bash
/usr/mtc/bin>./core_start all
[core_start] core_superv has started successfully (CORE_START/cstart_start_superv)
[core_start] library_manager has started successfully (CORE_START/cstart_start_library)
[core_start] core_manager has started successfully (CORE_START/cstart_start_manager)
[core_start] data_mining has started successfully (CORE_START/cstart_start_data_mining
[core_start] core_fuse has started successfully (CORE_START/cstart_start_fuse).
[core_start] core_watchdog has started successfully (CORE_START/cstart_start_watchdog)
```

--------------------------------

### Ansible rclone installation failure output

Source: https://docs.nodeum.io/faq/ansible-role-s3fs-install-rclone.md

Example of the error output generated when the ansible-role-s3fs role fails to install rclone due to missing archive extraction utilities.

```bash
TASK [ansible-role-s3fs : Install rclone] ********************************************************************************************************************************
fatal: [srv01]: FAILED! =>
    changed: true
    cmd:
    - /tmp/install_rclone.sh
    delta: '0:00:00.016487'
    end: '2026-06-08 12:12:00.381065'
    msg: non-zero return code
    rc: 4
    start: '2026-06-08 12:12:00.364578'
    stderr: ''
    stderr_lines: <omitted>
    stdout: |4-

        None of the supported tools for extracting zip archives (unzip 7z busybox) were found. Please install one of them and try again.
    stdout_lines: <omitted>
```

--------------------------------

### GET /data-mover/install-and-deploy.md

Source: https://docs.nodeum.io/data-mover/install-and-deploy.md

Queries the documentation dynamically by providing a question and an optional goal to receive a context-aware answer.

```APIDOC
## GET /data-mover/install-and-deploy.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.nodeum.io/data-mover/install-and-deploy.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### ND Client Path Usage Examples

Source: https://docs.nodeum.io/data-mover/nd-client.md

Demonstrates using absolute paths, relative paths, and nod:// URIs for file copy operations.

```bash
# by passing absolute path
nd copy /mnt/nas/data/file.txt /mnt/backup/archive/

# this only works if file is mounted which will get absolute path then c
nd copy ./data/file.txt /mnt/backup/


nd copy nod://mypool/data/file.txt nod://backup/archive/
```

--------------------------------

### GET /security-guide.md

Source: https://docs.nodeum.io/security-guide

Performs a dynamic query against the security guide documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /security-guide.md

### Description
Performs a dynamic query against the documentation to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.nodeum.io/security-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Install nd on Linux

Source: https://docs.nodeum.io/data-mover/nd-client.md

Downloads the Linux binary, sets execution permissions, and adds it to the current session PATH.

```bash
# Download the binary
curl https://get.nodeum.io/public/nd-2.0.13-linux-amd64 \
  --create-dirs \
  -o $HOME/nodeum-binaries/nd

# Make it executable
chmod +x $HOME/nodeum-binaries/nd

# Add to PATH (temporary for current session)
export PATH=$PATH:$HOME/nodeum-binaries/

# Test it
nd --help
```

--------------------------------

### GET /data-archiving/install-and-deploy.md

Source: https://docs.nodeum.io/data-archiving/install-and-deploy.md

Queries the documentation dynamically by providing a question and an optional goal to receive a context-aware answer.

```APIDOC
## GET /data-archiving/install-and-deploy.md

### Description
Perform an HTTP GET request on the documentation page URL to query information dynamically. The system returns a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.nodeum.io/data-archiving/install-and-deploy.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nodeum.io/data-archiving/system-reliability/backup-and-restore.md

Use this request to ask specific questions about backup and restore procedures. The ask parameter is required, while the goal parameter is optional for context.

```http
GET https://docs.nodeum.io/data-archiving/system-reliability/backup-and-restore.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install Ansible

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install Ansible via pip. Ensure the version is between 2.15 and 2.19.

```bash
$ pip install ansible
```

--------------------------------

### Display Nodeum CLI Help

Source: https://docs.nodeum.io/data-mover/nd-client.md

Use this command to view available CLI options, including configuration file paths.

```bash
[nodeum01@]$ nd --help 
NAME:
   nd - Nodeum CLI
....
   --config value                  path to configuration file (default: <config-dir>/config.json) [$ND_CONFIG]
   --config-dir value, -C value    path to configuration folder (default: "/home/nodeum01/.config/.nd") [$ND_CONFIG_DIR]
```

--------------------------------

### Backup MariaDB database on source server

Source: https://docs.nodeum.io/faq/mariadb-migration-from-10.4-to-10.6.md

Create a backup and prepare it for transfer using mariadb-backup.

```bash
mariadb-backup --backup --user=<user> --password=<password> --target-dir=/root/backup
mariadb-backup --prepare --user=<user> --password=<password> --target-dir=/root/backup
tar -cf backup.tar backup
```

--------------------------------

### Install Ansible on Ubuntu 24.04

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install Ansible via pip3 using the break-system-packages flag.

```bash
$ pip3 install "ansible-core<2.19" "ansible" --break-system-packages
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nodeum.io/data-archiving/console/system-settings/tape-library-configuration.md

Use this request to ask specific questions about tape library configuration. The ask parameter contains the query, while the optional goal parameter provides context for the request.

```http
GET https://docs.nodeum.io/data-archiving/console/system-settings/tape-library-configuration.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/mounts.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information.

```http
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/mounts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /data-archiving/install-and-deploy/ansible-based-installation.md

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /data-archiving/install-and-deploy/ansible-based-installation.md

### Description
Perform an HTTP GET request on the current page URL to retrieve answers, excerpts, and sources from the documentation based on a natural language query.

### Method
GET

### Endpoint
https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### Install nd via RPM

Source: https://docs.nodeum.io/data-mover/nd-client.md

Downloads and installs the nd package using the dnf package manager.

```bash
# Download the RPM

wget https://get.nodeum.io/public/nd-2.0.13-x86_64.rpm

# Install the RPM
dnf install ./nd-2.0.13-x86_64.rpm
```

--------------------------------

### Initialize and Select Cache Disk

Source: https://docs.nodeum.io/data-archiving/container/cache-configuration-requirements.md

Commands to format and select a device as the cache disk. Replace sdX with the appropriate device identifier.

```bash
/opt/nodeum/bin/core/cache_disk_format.sh /dev/sdX
```

```bash
/opt/nodeum/bin/core/cache_disk_select.sh /dev/sdX
```

--------------------------------

### Install Ansible on Ubuntu 22.04

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install Ansible via pip3. Ensure version is between 2.15 and 2.19.

```bash
$ pip3 install ansible
```

--------------------------------

### Access Nodeum CLI Help

Source: https://docs.nodeum.io/data-mover/nd-client.md

Displays the main help menu, listing all available commands, global options, and version information.

```bash
[nodeum01@]$ nd 
NAME:
   nd - Nodeum CLI

USAGE:
   nd [global options] command [command options] [arguments...]

VERSION:
   2.0.13

COMMANDS:
   admin
   auth-service   Service that manages users based on Linux users
   config         configure the Nodeum Client
   copy, cp       create copy task
   move, mv       create move task
   pool           manage pools
   server-config
   settings       manage user preferences (synced with the web UI)
   task
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --json                          output as JSON (default: false)
   --debug                         enable verbose logging (default: false) [$ND_DEBUG]
   --config value                  path to configuration file (default: <config-dir>/config.json) [$ND_CONFIG]
   --config-dir value, -C value    path to configuration folder (default: "/home/valery/.config/.nd") [$ND_CONFIG_DIR]
   --alias value                   alias in configuration file for authentication (default: "default") [$ND_ALIAS]
   --url value                     URL of Nodeum [$ND_URL]
   --auth-type value               Auth type (empty or ldap) [$ND_AUTH_TYPE]
   --access-token value            for API authentication (1st authentication method) [$ND_ACCESS_TOKEN]
   --refresh-token value           for API authentication (1st authentication method, not saved in config) [$ND_REFRESH_TOKEN]
   --authorization-endpoint value  for Device Authorization Flow (2nd authentication method)
   --token-endpoint value          for Device Authorization Flow (2nd authentication method)
   --client-id value               for Device Authorization Flow (2nd authentication method)
   --scopes value                  for Device Authorization Flow (2nd authentication method)
   --persist-session               persist Device Authorization session on disk for 1 hour (default: true)
   --persist-session-renew         if persist session is enabled, renew the token (default: false)
   --username value                for API authentication (3rd authentication method) [$ND_USERNAME]
   --password value                for API authentication (3rd authentication method) [$ND_PASSWORD]
   --anonymous                     no login (default: false)
   --help, -h                      show help
   --version, -v                   print the version

COPYRIGHT:
   nd is a property of Nodeum and its subsidiaries, if any. The intellectual and
   technical concepts contained herein are proprietary to Nodeum and its
   subsidiaries 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.
```

--------------------------------

### Initialize New Cluster

Source: https://docs.nodeum.io/data-archiving/system-reliability/failover-active-passive.md

Start a new cluster instance after manual state file modification.

```bash
$ galera_new_cluster
```

--------------------------------

### Install and Upgrade Pip

Source: https://docs.nodeum.io/data-archiving/install-and-deploy/ansible-based-installation.md

Install the pip package manager linked to Python 3.9 and upgrade it to the latest version.

```bash
$ dnf install python-pip
$ pip install pip --upgrade
```

--------------------------------

### Install nd on macOS

Source: https://docs.nodeum.io/data-mover/nd-client.md

Downloads the macOS binary, sets execution permissions, and adds it to the current session PATH.

```bash
# Download the binary
curl https://get.nodeum.io/public/nd-2.0.13-darwin-amd64 \
  --create-dirs \
  -o $HOME/nodeum-binaries/nd

# Make it executable
chmod +x $HOME/nodeum-binaries/nd

# Add to PATH (temporary for current session)
export PATH=$PATH:$HOME/nodeum-binaries/

# Test it
nd --help
```

--------------------------------

### GET /data-archiving/api-developers.md

Source: https://docs.nodeum.io/data-archiving/api-developers.md

Perform an HTTP GET request to query the documentation dynamically for information not explicitly present on the page.

```APIDOC
## GET /data-archiving/api-developers.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.nodeum.io/data-archiving/api-developers.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Querying documentation via HTTP GET

Source: https://docs.nodeum.io/data-archiving/alerts.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.nodeum.io/data-archiving/alerts.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Create a basic copy task

Source: https://docs.nodeum.io/data-mover/nd-client.md

Initiates a data transfer between a POSIX storage path and a cloud storage container with required metadata.

```bash
nd copy \ --md project_name=<my project name> \ --md project_domain_name=<my projectdomain name> \ --md user_domain_name=<my user domain name> \ nod://posix_storage/path/subpath/ \ nod-cloud://cloud_storage/container
```

```bash
nd copy \
--md project_name=<my project name> \
--md project_domain_name=<my projectdomain name> \
--md user_domain_name=<my user domain name> \
nod://posix_storage/path/subpath/ \
nod-cloud://cloud_storage/container
```

--------------------------------

### GET /users/-/systems

Source: https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/users.md

List all system users.

```APIDOC
## GET /users/-/systems

### Description
List all system users.

### Method
GET

### Endpoint
/users/-/systems

### Response
#### Success Response (200)
- **count** (integer) - The number of users.
- **users** (array) - List of system users.
```

--------------------------------

### Start Nodeum Services

Source: https://docs.nodeum.io/data-mover/install-and-deploy/docker-based-deployment.md

Command to initialize the Nodeum environment using Docker Compose in detached mode.

```bash
$ docker compose up --detach
```

--------------------------------

### Apply License via ND Client

Source: https://docs.nodeum.io/data-mover/console/system-settings/license-application.md

Use the nd admin command to apply a license key file from the command line.

```bash
$ nd admin license --file=path-to-key
      Issuer: Nodeum
Company Name: Nodeum dev
      Serial: - 423e05fd-b126-4ac5-eb87-84868938e049
            : - 01234567-89ab-cdef-0123-456789abcdef
   Issued at: 2023-08-02 12:22:23 +0000 +0000
```

--------------------------------

### GET /files

Source: https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/files.md

Lists files on the root directory.

```APIDOC
## GET /files

### Description
Lists files on the root directory.

### Method
GET

### Endpoint
/files

### Response
#### Success Response (200)
- **count** (integer) - Total number of files.
- **files** (array) - List of file objects.

#### Response Example
{
  "count": 1,
  "files": [
    {
      "id": 1,
      "name": "example_file.txt",
      "type": "file",
      "size": 1024
    }
  ]
}
```

--------------------------------

### GET /tasks

Source: https://docs.nodeum.io/data-mover/api-developers/api-reference-nodeum-data-mover/tasks.md

Lists all tasks available in the system.

```APIDOC
## GET /tasks

### Description
Retrieves a list of all tasks. This operation requires the 'tasks / index' API key scope.

### Method
GET

### Endpoint
/tasks

### Query Parameters
- **limit** (integer) - Optional - The number of items to display.

### Response
#### Success Response (200)
- **count** (integer) - The total number of tasks.
- **tasks** (array) - A list of task objects.

#### Response Example
{
  "count": 1,
  "tasks": [
    {
      "id": "task-id-123",
      "name": "Example Task",
      "workflow_type": "data_migration",
      "workflow_action": "copy"
    }
  ]
}
```
Tokens:
Raw