vStor 4.12 Documentation
  • Welcome to vStor!
  • Introduction
  • Installation
    • Deploying Catalogic vStor on Physical Appliances
    • Deploying Catalogic vStor Virtual Appliance for VMware
    • Deploying Catalogic vStor Virtual Appliance for Microsoft Hyper-V
    • Required Ports for Catalogic vStor
    • Updating Catalogic vStor
  • Quick Start
    • Catalogic vStor for VMware
    • Catalogic vStor for Hyper-V
  • Basic Configuration
    • Initializing vStor
    • Adding Catalogic vStor Node to Catalogic DPX
      • Using vStor API Keys with Catalogic DPX
    • Configuring vStor System Settings
    • Configuring vStor Network Settings
    • Backing up Configuration Settings of Catalogic vStor
    • Restoring Configuration Settings of Catalogic vStor
  • Storage Management
    • Adding Disks
    • Managing Storage Pools
    • Managing Volumes
      • Migrating Volumes
      • Creating Volume Snapshots
      • Using vStor Autosnapshot
    • ZFS Compression and Deduplication
    • Managing Shares
    • Managing Hosts for LUN Volumes
    • Using vStor Snapshot Explorer
  • Data Protection
    • Catalogic vStor Backup and Recovery
    • vStor Partnerships
      • Creating Replication Groups
      • Establishing Cross-Version Partnerships
    • Enabling Volume Encryption
    • Immutability in vStor
    • Using GuardMode Scan
    • Using Remote Keystore
  • Advanced Configuration
    • Using Multipath Storage
    • Managing Certificates
    • Adding Encryption URLs
    • Managing MinIO Buckets
    • Assigning an E-mail to a vStor Account
    • Managing vStor User Accounts
    • Using Multifactor Authentication (MFA)
  • vStor Command Line Interface
    • Catalogic vStor Server CLI Overview
  • Best Practices
    • Hardware Configurations: Best Practices
    • Data Backup: Best Practices
    • Data Archiving: Best Practices
    • Backup Storage: Best Practices
    • Frequently Asked Questions: Best Practices
  • Technical Support
Powered by GitBook
On this page
  • Generating an API Key
  • Connecting to DPX with API Key
  1. Basic Configuration
  2. Adding Catalogic vStor Node to Catalogic DPX

Using vStor API Keys with Catalogic DPX

PreviousAdding Catalogic vStor Node to Catalogic DPXNextConfiguring vStor System Settings

Last updated 17 days ago

vStor allows generating API keys that can be used to authenticate with DPX instead of a username and password. This provides an alternative way to connect vStor nodes to DPX.

Generating an API Key

To generate an API key:

  1. Click your account name in the top navigation bar and select Manage API Keys.\

  2. In the popup dialog, click Generate new API Key.

  1. Specify a name for the API key.

  1. Click Generate API Key. This will generate a unique API key and token that can be used to authenticate as your user account.

Attention! The API key and token are only shown once after they are generated. Make sure to copy and save them in a secure place or use the credentials right away.

Connecting to DPX with API Key

To use the API key for connecting a vStor node to DPX:

  1. Open a web browser and go to the DPX Master Server’s IP address.

  2. Go to the Nodes section in the sidebar.

  3. Click the Add Node button in the upper right corner.

  4. Select vStor as the node type.

  5. Provide the details for your new node.

  6. Enter the API key as the username.

  7. Enter the API token as the password.

  1. Click Test to verify the entered details (optional).

  2. Click Save to add the node.

The node will now connect to DPX using the API key instead of your vStor username and password.

Tip. You can generate multiple API keys if needed. Each key can be independently revoked in the Manage API Keys section.

See also. For more details concerning adding vStor as a storage node to the DPX Master Server, see in the DPX 4.12 Guide.

Adding a vStore Storage Node