StarWind Resource Library

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Published: June 16, 2017

INTRODUCTION

This guidance will show you how to work with StarWind Virtual SAN using StarWind Swordfish plugin. The paper will walk you through the configuration process of the HA Datastore and describe to you how to communicate with StarWind using Swordfish.

The SNIA Swordfish™ specification helps to provide a unified approach for the management of storage and servers in hyperscale and cloud infrastructure environments. The integration of Swordfish API allows configuring StarWind Virtual SAN resources as storage containers for
virtual machines and provides more efficient management for the architecture simplifying storage provisioning and consumption.

SNIA Swordfish is an extension of the DMTF Redfish specification, so the same easy-to-use RESTful interface, along with JavaScript Object Notation (JSON) and Open Data Protocol (OData), is used to seamlessly manage storage equipment and storage services in addition to servers.

This guide is intended for experienced IT and Storage administrators and professionals who would like to unify management of their infrastructure. It also provides a step-by-step guidance describing how to monitor StarWind Virtual SAN resources.

A full set of up-to-date technical documentation can always be found here, or by pressing the Help button in the StarWind Management Console.

For any technical inquiries, please visit our online community, Frequently Asked Questions page, or use the support form to contact our technical support department.

Before you begin

StarWind has integrated the following Swordfish resources to the provider:

StorageService

Description: a collection of resources that the system can make available to one or more host systems. The collection can contain: block, file, or object storage; local system access points through which the collection is made available; hosts or host access points to which the collection is made available.

StorageSystem

Description: An instance of this resource shall reference the set of ComputerSystem resources that is known in the scope of its use and has a HostingRoles entry with a value of ‘StorageServer’.

StoragePool

Description: A container of data storage capable of providing capacity conforming to one of its supported classes of service. The storage pool does not support IO to its data storage.

Volume

Description: This resource shall be used to represent a volume, virtual disk, logical disk, LUN, or other logical storage for a Redfish implementation.

The table shows resources reference:

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

You should install StarWind Virtual SAN on one of the servers to start working with Swordfish Provider.

Installing StarWind Cluster Service and Swordfish API

1. To install StarWind Cluster Service, launch StarWind Virtual SAN setup and choose components specified on the screenshot below.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

2. Check if StarWind Cluster Service has started properly.

3. To check that Swordfish Provider is running, open the following page in a web browser:
http://localhost:9000/redfish/v1

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Create StarWind Cluster

4. Open PowerShell with administrative rights and run the following cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).CreateCluster(“Swordfish_cluster”, “root”,
“starwind”)
• “Swordfish_cluster”- StarWind Cluster Name (choose preferable name);
• “root”- StarWind default login;
• “starwind” – StarWind default password.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

5. You can find information about the recently created Cluster here:
http://localhost:9000/redfish/v1/StorageServices

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

6. Detailed information about the Cluster can be found by adding “clusterUid” to the previous link: http://localhost:9000/redfish/v1/StorageServices/clusterUid

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

7. Also, you can get information about the cluster using “SwordfishDemoScript.ps1” PowerShell script. You can find it here: http://SwordfishDemoScript.ps1_path. You should execute the script one time to register its functions. “Invoke-RestMethod” is used by the script to get information about the cluster and cluster objects. More detailed information
about the script can be found here:
https://blogs.technet.microsoft.com/hectorl/2016/09/20/5-reasons-why-you-will-enjoyusing-the-new-swordfish-api/

Run $discoveryinfo.StorageServices.’clusterUid Powershell cmdlet to get information about the cluster after SwordfishDemoSctipt.ps1 execution.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Add Storage Node to Cluster

To add a storage node to the Cluster, run the following PowerShell cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).BindStorageNode(“StarWind Node Alias“, “StarWind Node IP“, “3261”, “root”, “starwind”)
• “StarWind Node Alias”- FQDN of the StarWind node;
• “StarWind Node IP”- IP address of the StarWind node;
• “3261”- StarWind Virtual SAN default port;
• “root”- StarWind default login;
• “starwind” – StarWind default password.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

9. You can see that the node was added to the cluster by browsing the following page:
http://localhost:9000/redfish/v1/StorageSystems

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

10. You can find detailed information about the Cluster node by adding “storageNodeUid”:
http://localhost:9000/redfish/v1/StorageSystems/storageNodeUid

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Also, you can use PowerShell to get information about the StorageNode. Run
$discoveryinfo.StorageSystems.’storageNodeUid cmdlet (you should execute
SwodfishDemoScript.ps1 first)

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Create Storage Node Profile

11. Open StarWind Management Console. Click Add Target and create VVols type target.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

To create the Storage Node Profile, run the following PowerShell cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).CreateStorageNodeProfile(“storageNodeUid”, “LoadAll”)

• “storageNodeUid”- storageNode Uid of StarWind Node which you have added in the “Add Storage Node to Cluster” part of the guide.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Create Datastore

12. To create the Datastore, run the following PowerShell cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).CreateDatastore(“DatastoreName”, “Size”, “storageNodeProfileUid”, “4E19F23A-0A84-486C-A516-DF96140C7000”).

• “DatastoreName”- Datastore Name;
• “Size”- Datastore size in MB;
• “storageNodeProfileUid”- Uid StorageNode Profile, which was created in the “Create Storage Node Profile” part of the guide;
• “4E19F23A-0A84-486C-A516-DF96140C7000”- default  apabilityProfileUid.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

13. You can find information about the recently created Datastore on the following page:
http://localhost:9000/redfish/v1/StorageServices/ClusterUid/StoragePools/datastoreUid
• ClusterUid – Cluster Uid, which was created in the “Create StarWind Cluster” part;
• datastoreUid – Datastore Uid, which was created in the “Create Datastore” part.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Also, you can use PowerShell to get information about the Datastore. Run
$discoveryinfo.StorageServices.‘ClusterUid’.StoragePools.datastoreUid’ cmdlet (you should execute SwodfishDemoScript.ps1 first).
• ClusterUid – Cluster Uid, which was created in the “Create StarWind Cluster” part;
• datastoreUid – Datastore Uid, which was created in the “Create Datastore” part

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Create VirtualVolume

14. To create the VirtualVolume, run the following PowerShell cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).CreateVirtualVolume(“VolumeName”, Size, “Config”, “datastoreUid”, “4E19F23A-0A84-486C-A516-DF96140C7000”)

• “VolumeName”- VirtualVolume Name;
• “Size”- VirtualVolume size in Megabytes;
• “Config”- Volume type (currently available types: Config, Data, Swap,  Memory)
• “datastoreUid”- Datastore Uid, which was created in the “Create Datastore” part;
• “4E19F23A-0A84-486C-A516-DF96140C7000”- default capabilityProfileUid.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Information about the recently created VirtualVolume can be found here:
http://localhost:9000/redfish/v1/StorageServices/datastoreUid/Volumes/volumeUid
• datastoreUid – Datastore Uid, which was created in the “Create Datastore” part
• volumeUid – VirtualVolume Uid.

Also, you can use PowerShell to get information about the VirtualVolume. Run
$discoveryinfo.StorageServices.datastoreUid‘.Volumes.volumeUid cmdlet (you should execute SwodfishDemoScript.ps1 first).
• datastoreUid – Datastore Uid, which was created in “Create Datastore” part
• volumeUid – VirtualVolume Uid.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

Delete VirtualVolume

15. To delete the VirtualVolume, run the following PowerShell cmdlet:
([wmiclass]”root\starwind:STARWIND_ClusterService”).DeleteObject(“volumeUid”, “STARWIND_VirtualVolume”)
• volumeUid – VirtualVolume Uid, which was created in the “Create VirtualVolume” part;

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

You can check that VirtualVolume was deleted on the following page:
http://localhost:9000/redfish/v1/StorageServices/datastoreUid/Volumes/
• datastoreUid – Datastore Uid, which was created in the “Create Datastore” part.

StarWind Swordfish Provider How to monitor StarWind using Swordfish Provider

CONCLUSION

By following these instructions, you can monitor StarWind Cluster functionality using Swordfish Provider. This integration now allows you to control and monitor the StarWind storage infrastructure using Swordfish API. With StarWind Provider implemented, storage infrastructure monitoring becomes easier and more flexible.