Step-by-Step Guide
to
Remote Snapshot Control with CLI/API
Software Version: DSS ver. 7.00 up11

Presentation updated: July 2013

www.open-e.com

1
Remote Snapshot Control with CLI/API of DSS V7
TO SET UP REMOTE SNAPSHOT CONTROL WITH CLI/API, PERFORM THE
FOLLOWING STEPS:
1. Download PuTTYgen and Plink for Windows
2. Create an iSCSI Logical Volume with Snapshot
3. Configure CLI/API on DSS V7
4. Convert key with PuTTY Key Generator
5. Issue the "snapshot_task" command with "start", "status" and "stop" options

www.open-e.com

2
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

1. Download PuTTYgen and Plink for Windows

Download PuTTYgen and Plink from
http://putty.nl/download.html on your
PC.

www.open-e.com

3
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

2. Create iSCSI Logical Volume with Snapshot

After logging on the DSS V7, please
go to "CONFIGURATION" →
Volume manager → Vol. Groups
and select the appropriate volume
group (vg00) from the list on the left.
Use Volume manager to create a
new iSCSI volume of the required
size. Click apply button to confirm.

www.open-e.com

4
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

2. Create iSCSI Logical Volume with Snapshot

After reloading the page, select
"new snapshot" from "Action"
dropdown menu. Set size to
10GB and click apply.

www.open-e.com

5
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

2. Create iSCSI Logical Volume with Snapshot

Use Snapshot definition to
assign an appropriate snapshot
to logical volume (in this example
lv0000) and click apply.

HINT:
For additional details about creating
targets for the logical volume and the
snapshot volume, please refer to the
documents in the How-to Resources
section on the web.
www.open-e.com

6
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

3. Configure CLI/API on DSS V7

In order to enable server
remote control, go to "SETUP"
→ "Administrator settings".
In CLI/API Configuration
check "Use CLI/API" checkbox.
Set the "Password" and click
apply button.

After reloading page, click on
"Show advanced".

www.open-e.com

7
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

3. Configure CLI/API on DSS V7

Please click on generate and
download button.

www.open-e.com

8
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

3. Configure CLI/API on DSS V7

Next, save the generated key
into a local folder, e.g. C:API.

www.open-e.com

9
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

4. Convert the key with PuTTY Key Generator

Please run puttygen.exe and
select Conversions → Import
Key in the main menu.

www.open-e.com

10
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

4. Convert the key with PuTTY Key Generator

Next, load key from e.g. C:API.

www.open-e.com

11
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

4. Convert the key with PuTTY Key Generator

Then, click on "Save private
key" button.

www.open-e.com

12
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

4. Convert the key with PuTTY Key Generator

Next, click on "YES" button.

www.open-e.com

13
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

4. Convert the key with PuTTY Key Generator

Please save new
privatekey.ppk on C:API
folder.

www.open-e.com

14
Remote Snapshot Control with CLI/API of DSS V7
Syntax examples for the plink command using the key:
plink -i path_to_the_downloaded_key -2 -P 22223 -l api ip_address command
• option: -i sets the path to the downloaded key file,
• option: -2 sets the version of the SSH protocol used for the connection,
• option: -P sets the connection port (default: 22223),
• option: -l sets the user (the user must be api),
• option: ip_address sets the IP address of the storage server you want to connect to,
• option: command; the command consist of the command name and optional parameters and
optional object names.
NOTE:
Plink uses capital "P" and the ssh use small "p" in the command line.

HINT:
In order to list the full command set, please issue the 'help' command. If you enter a command with missing
parameters or missing object name, the system will prompt with full syntax of the command. Once complete
command is entered, it will run at once and non- interactive. A user script with API commands must be
executed first on a testing system, not on a production system.
www.open-e.com

15
Remote Snapshot Control with CLI/API of DSS V7
Please run the DOS command prompt
box and change directory to the
directory where you have saved the
key, e.g.: C:API.

5. Issue the "snapshot_task" command with "start", "status"
and "stop" options

HINT:
Entering the command line, please use the tab key for
auto-complete of the program and key path or name
www.open-e.com

Please enter the
"snapshot_task" API command
with "start" option.

16
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

5. Issue the "snapshot_task" command with "start", "status"
and "stop" options

Please use "STATUS"→ Tasks
→ Running tasks to check
snapshot status.
It should be "in use/active".

www.open-e.com

17
Remote Snapshot Control with CLI/API of DSS V7
You can check the snapshot
status with the following API
command: "snapshot_task" with
option "status".

5. Issue the "snapshot_task" command with "start", "status"
and "stop" options

HINT:
Entering the command line, please use tab key for
auto-complete of the program and key path or name.
www.open-e.com

The API command
"snapshot_task status" returns
status: "active".

18
Remote Snapshot Control with CLI/API of DSS V7
In order to stop the snapshot
remotely, please issue the
"snapshot_task" command with
option "stop".

5. Issue the "snapshot_task" command with "start", "status"
and "stop" options

HINT:
Entering the command line, please use tab key for
auto-complete of the program and key path or name.
www.open-e.com

19
Remote Snapshot Control with CLI/API of DSS V7
Data Server (DSS)
IP Address:192.168.0.220

5. Issue the "snapshot_task" command with "start", "status"
and "stop" options

Now the STATUS → Tasks →
Running tasks form show no
active snapshot.

www.open-e.com

20
Thank you!

Follow Open-E:
www.open-e.com

21

More Related Content

PDF
Open-E DSS V7 Active-Active Load Balanced iSCSI HA Cluster (with bonding)
PDF
Open-E DSS V7 Asynchronous Data Replication within a System
PDF
Open-E DSS V7 Asynchronous Data Replication over a WAN
PDF
Open-E DSS V7 Synchronous Volume Replication over a LAN
PDF
Open-E DSS V7 Asynchronous Data Replication over a LAN
PDF
Open-E DSS V7 Active-Passive iSCSI Failover
PDF
Open-E DSS V7 Active-Active Load Balanced iSCSI HA Cluster (without bonding)
PDF
Open-E DSS V7 Active-Active iSCSI Failover on Intel Server Systems
Open-E DSS V7 Active-Active Load Balanced iSCSI HA Cluster (with bonding)
Open-E DSS V7 Asynchronous Data Replication within a System
Open-E DSS V7 Asynchronous Data Replication over a WAN
Open-E DSS V7 Synchronous Volume Replication over a LAN
Open-E DSS V7 Asynchronous Data Replication over a LAN
Open-E DSS V7 Active-Passive iSCSI Failover
Open-E DSS V7 Active-Active Load Balanced iSCSI HA Cluster (without bonding)
Open-E DSS V7 Active-Active iSCSI Failover on Intel Server Systems

What's hot (20)

PDF
Open-E DSS V7 Active-Passive iSCSI Failover on Intel Server Systems
PDF
9i hp relnotes
PDF
Install oracle11gr2 rhel5
PDF
11g r2 rac_guide
PPT
Oracle Golden Gate
DOC
Schema replication using oracle golden gate 12c
DOCX
Asm disk group migration from
PDF
Colvin RMAN New Features
PDF
Oracle goldengate 11g schema replication from standby database
DOCX
General commands for navisphere cli
PDF
Rac on NFS
PDF
Perl Programming - 04 Programming Database
PPT
Oracle 10g Performance: chapter 00 sampling
DOCX
C mode class
DOC
gcis-zenworks7.2
PDF
[India Merge World Tour] Meru Networks
DOCX
DNS windows server(2008R2) & linux(SLES 11)
PDF
9i lin relnotes
PPTX
Hive data migration (export/import)
PPT
Open-E Backup to Attached Tape Drive
Open-E DSS V7 Active-Passive iSCSI Failover on Intel Server Systems
9i hp relnotes
Install oracle11gr2 rhel5
11g r2 rac_guide
Oracle Golden Gate
Schema replication using oracle golden gate 12c
Asm disk group migration from
Colvin RMAN New Features
Oracle goldengate 11g schema replication from standby database
General commands for navisphere cli
Rac on NFS
Perl Programming - 04 Programming Database
Oracle 10g Performance: chapter 00 sampling
C mode class
gcis-zenworks7.2
[India Merge World Tour] Meru Networks
DNS windows server(2008R2) & linux(SLES 11)
9i lin relnotes
Hive data migration (export/import)
Open-E Backup to Attached Tape Drive
Ad

Similar to Open-E DSS V7 Remote Snapshot Control with CLI/API (20)

PDF
Mastering Microservices with Kong (DevoxxUK 2019)
PDF
Creating Sentiment Line Chart with Watson
PPTX
Simplifying and accelerating converged media with Open Visual Cloud
PDF
Remote Config REST API and Versioning
PDF
Optimizing Your CI Pipelines
PPTX
Python from zero to hero (Twitter Explorer)
PDF
Usage Note of SWIG for PHP
PDF
Maximize the power of OSGi in AEM
PDF
OSMC 2021 | Monitoring @ G&D
PPTX
New Microsoft PowerPoint Presentation (2).pptx
PDF
IBM Cloud University: Build, Deploy and Scale Node.js Microservices
DOCX
CodeShip
PDF
Fastlane - Automation and Continuous Delivery for iOS Apps
PDF
Setting up your virtual infrastructure using fi-lab cloud
PDF
Advanced Eclipse Workshop (held at IPC2010 -spring edition-)
PPTX
Compliance Automation with Inspec Part 2
PDF
[apidays LIVE HONK KONG] - OAS to Managed API in Seconds
PPT
Setting up the hyperledger composer in ubuntu
PDF
Structure your Play application with the cake pattern (and test it)
PDF
Automate Your Automation | DrupalCon Vienna
Mastering Microservices with Kong (DevoxxUK 2019)
Creating Sentiment Line Chart with Watson
Simplifying and accelerating converged media with Open Visual Cloud
Remote Config REST API and Versioning
Optimizing Your CI Pipelines
Python from zero to hero (Twitter Explorer)
Usage Note of SWIG for PHP
Maximize the power of OSGi in AEM
OSMC 2021 | Monitoring @ G&D
New Microsoft PowerPoint Presentation (2).pptx
IBM Cloud University: Build, Deploy and Scale Node.js Microservices
CodeShip
Fastlane - Automation and Continuous Delivery for iOS Apps
Setting up your virtual infrastructure using fi-lab cloud
Advanced Eclipse Workshop (held at IPC2010 -spring edition-)
Compliance Automation with Inspec Part 2
[apidays LIVE HONK KONG] - OAS to Managed API in Seconds
Setting up the hyperledger composer in ubuntu
Structure your Play application with the cake pattern (and test it)
Automate Your Automation | DrupalCon Vienna
Ad

More from open-e (11)

PDF
Open-E DSS V6 MPIO with ESXi 4.x
PDF
How to Connect to a DSS V6 iSCSI Target Volume from a Microsoft Windows
PPT
Description of Open-E Snapshot
PPT
Step-by-Step Guide to NAS (NFS) Failover over a LAN (with unicast) Supported ...
PPT
Open-E DSS V6 How to Setup iSCSI Failover with XenServer
PPT
Open-E DSS V6 Synchronous Volume Replication with Failover over a LAN with Un...
PPT
Open-E DSS V6 Synchronous Volume Replication With Failover over a LAN with Br...
PPT
Open-E DSS Synchronous Volume Replication over a WAN
PPT
Open-E Backup to Attached Tape Library
PDF
Open-E Backup to iSCSI Target Volume over a LAN
PDF
Backup of Data Residing on DSS V6 with Backup Exec
Open-E DSS V6 MPIO with ESXi 4.x
How to Connect to a DSS V6 iSCSI Target Volume from a Microsoft Windows
Description of Open-E Snapshot
Step-by-Step Guide to NAS (NFS) Failover over a LAN (with unicast) Supported ...
Open-E DSS V6 How to Setup iSCSI Failover with XenServer
Open-E DSS V6 Synchronous Volume Replication with Failover over a LAN with Un...
Open-E DSS V6 Synchronous Volume Replication With Failover over a LAN with Br...
Open-E DSS Synchronous Volume Replication over a WAN
Open-E Backup to Attached Tape Library
Open-E Backup to iSCSI Target Volume over a LAN
Backup of Data Residing on DSS V6 with Backup Exec

Recently uploaded (20)

PPTX
How to Convert Tickets Into Sales Opportunity in Odoo 18
PPTX
Report in SIP_Distance_Learning_Technology_Impact.pptx
PPTX
Information-Technology-in-Human-Society.pptx
PPTX
Blending method and technology for hydrogen.pptx
PPTX
From XAI to XEE through Influence and Provenance.Controlling model fairness o...
PDF
Gestión Unificada de los Riegos Externos
PDF
CEH Module 2 Footprinting CEH V13, concepts
PPTX
Rise of the Digital Control Grid Zeee Media and Hope and Tivon FTWProject.com
PDF
State of AI in Business 2025 - MIT NANDA
PDF
Technical Debt in the AI Coding Era - By Antonio Bianco
PDF
Fitaura: AI & Machine Learning Powered Fitness Tracker
PDF
NewMind AI Journal Monthly Chronicles - August 2025
PPTX
Strategic Picks — Prioritising the Right Agentic Use Cases [2/6]
PDF
The AI Revolution in Customer Service - 2025
PPTX
AQUEEL MUSHTAQUE FAKIH COMPUTER CENTER .
PDF
Altius execution marketplace concept.pdf
PPTX
CRM(Customer Relationship Managmnet) Presentation
PDF
Ebook - The Future of AI A Comprehensive Guide.pdf
PDF
Ericsson 5G Feature,KPIs Analysis_ Overview, Dependencies & Recommendations (...
PPTX
Presentation - Principles of Instructional Design.pptx
How to Convert Tickets Into Sales Opportunity in Odoo 18
Report in SIP_Distance_Learning_Technology_Impact.pptx
Information-Technology-in-Human-Society.pptx
Blending method and technology for hydrogen.pptx
From XAI to XEE through Influence and Provenance.Controlling model fairness o...
Gestión Unificada de los Riegos Externos
CEH Module 2 Footprinting CEH V13, concepts
Rise of the Digital Control Grid Zeee Media and Hope and Tivon FTWProject.com
State of AI in Business 2025 - MIT NANDA
Technical Debt in the AI Coding Era - By Antonio Bianco
Fitaura: AI & Machine Learning Powered Fitness Tracker
NewMind AI Journal Monthly Chronicles - August 2025
Strategic Picks — Prioritising the Right Agentic Use Cases [2/6]
The AI Revolution in Customer Service - 2025
AQUEEL MUSHTAQUE FAKIH COMPUTER CENTER .
Altius execution marketplace concept.pdf
CRM(Customer Relationship Managmnet) Presentation
Ebook - The Future of AI A Comprehensive Guide.pdf
Ericsson 5G Feature,KPIs Analysis_ Overview, Dependencies & Recommendations (...
Presentation - Principles of Instructional Design.pptx

Open-E DSS V7 Remote Snapshot Control with CLI/API

  • 1. Step-by-Step Guide to Remote Snapshot Control with CLI/API Software Version: DSS ver. 7.00 up11 Presentation updated: July 2013 www.open-e.com 1
  • 2. Remote Snapshot Control with CLI/API of DSS V7 TO SET UP REMOTE SNAPSHOT CONTROL WITH CLI/API, PERFORM THE FOLLOWING STEPS: 1. Download PuTTYgen and Plink for Windows 2. Create an iSCSI Logical Volume with Snapshot 3. Configure CLI/API on DSS V7 4. Convert key with PuTTY Key Generator 5. Issue the "snapshot_task" command with "start", "status" and "stop" options www.open-e.com 2
  • 3. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 1. Download PuTTYgen and Plink for Windows Download PuTTYgen and Plink from http://putty.nl/download.html on your PC. www.open-e.com 3
  • 4. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 2. Create iSCSI Logical Volume with Snapshot After logging on the DSS V7, please go to "CONFIGURATION" → Volume manager → Vol. Groups and select the appropriate volume group (vg00) from the list on the left. Use Volume manager to create a new iSCSI volume of the required size. Click apply button to confirm. www.open-e.com 4
  • 5. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 2. Create iSCSI Logical Volume with Snapshot After reloading the page, select "new snapshot" from "Action" dropdown menu. Set size to 10GB and click apply. www.open-e.com 5
  • 6. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 2. Create iSCSI Logical Volume with Snapshot Use Snapshot definition to assign an appropriate snapshot to logical volume (in this example lv0000) and click apply. HINT: For additional details about creating targets for the logical volume and the snapshot volume, please refer to the documents in the How-to Resources section on the web. www.open-e.com 6
  • 7. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 3. Configure CLI/API on DSS V7 In order to enable server remote control, go to "SETUP" → "Administrator settings". In CLI/API Configuration check "Use CLI/API" checkbox. Set the "Password" and click apply button. After reloading page, click on "Show advanced". www.open-e.com 7
  • 8. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 3. Configure CLI/API on DSS V7 Please click on generate and download button. www.open-e.com 8
  • 9. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 3. Configure CLI/API on DSS V7 Next, save the generated key into a local folder, e.g. C:API. www.open-e.com 9
  • 10. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 4. Convert the key with PuTTY Key Generator Please run puttygen.exe and select Conversions → Import Key in the main menu. www.open-e.com 10
  • 11. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 4. Convert the key with PuTTY Key Generator Next, load key from e.g. C:API. www.open-e.com 11
  • 12. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 4. Convert the key with PuTTY Key Generator Then, click on "Save private key" button. www.open-e.com 12
  • 13. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 4. Convert the key with PuTTY Key Generator Next, click on "YES" button. www.open-e.com 13
  • 14. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 4. Convert the key with PuTTY Key Generator Please save new privatekey.ppk on C:API folder. www.open-e.com 14
  • 15. Remote Snapshot Control with CLI/API of DSS V7 Syntax examples for the plink command using the key: plink -i path_to_the_downloaded_key -2 -P 22223 -l api ip_address command • option: -i sets the path to the downloaded key file, • option: -2 sets the version of the SSH protocol used for the connection, • option: -P sets the connection port (default: 22223), • option: -l sets the user (the user must be api), • option: ip_address sets the IP address of the storage server you want to connect to, • option: command; the command consist of the command name and optional parameters and optional object names. NOTE: Plink uses capital "P" and the ssh use small "p" in the command line. HINT: In order to list the full command set, please issue the 'help' command. If you enter a command with missing parameters or missing object name, the system will prompt with full syntax of the command. Once complete command is entered, it will run at once and non- interactive. A user script with API commands must be executed first on a testing system, not on a production system. www.open-e.com 15
  • 16. Remote Snapshot Control with CLI/API of DSS V7 Please run the DOS command prompt box and change directory to the directory where you have saved the key, e.g.: C:API. 5. Issue the "snapshot_task" command with "start", "status" and "stop" options HINT: Entering the command line, please use the tab key for auto-complete of the program and key path or name www.open-e.com Please enter the "snapshot_task" API command with "start" option. 16
  • 17. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 5. Issue the "snapshot_task" command with "start", "status" and "stop" options Please use "STATUS"→ Tasks → Running tasks to check snapshot status. It should be "in use/active". www.open-e.com 17
  • 18. Remote Snapshot Control with CLI/API of DSS V7 You can check the snapshot status with the following API command: "snapshot_task" with option "status". 5. Issue the "snapshot_task" command with "start", "status" and "stop" options HINT: Entering the command line, please use tab key for auto-complete of the program and key path or name. www.open-e.com The API command "snapshot_task status" returns status: "active". 18
  • 19. Remote Snapshot Control with CLI/API of DSS V7 In order to stop the snapshot remotely, please issue the "snapshot_task" command with option "stop". 5. Issue the "snapshot_task" command with "start", "status" and "stop" options HINT: Entering the command line, please use tab key for auto-complete of the program and key path or name. www.open-e.com 19
  • 20. Remote Snapshot Control with CLI/API of DSS V7 Data Server (DSS) IP Address:192.168.0.220 5. Issue the "snapshot_task" command with "start", "status" and "stop" options Now the STATUS → Tasks → Running tasks form show no active snapshot. www.open-e.com 20