D-Link xStack Storage DSN-4000 Series, Cli User'S Manual

Page 1: ...D Link System Inc xStack Storage DSN 1000 2000 3000 4000 5000 series Command Line Interface User s Guide Version 1 5...

Page 2: ...es for D Link Systems products and services are set forth in the express warranty statements accompanying such products and services Nothing herein should be construed as constituting an additional wa...

Page 3: ...version 2 5 0 and redundant controllers January 2009 Version 1 2 minor technical and formatting updates May 2009 Version 1 3 updated for software version 2 6 0 December 2009 Version 1 4 updated for s...

Page 4: ...LI is intended for users who have significant storage management expertise and previous experience using a CLI Improper CLI use can cause undesired results Document Conventions This document uses the...

Page 5: ...cate an optional choice x y braces enclosing items separated by a vertical bar indicate a required choice x y z nested sets of square brackets or braces indicate optional or required choices within op...

Page 6: ...vi Preface...

Page 7: ...ommands 20 3 1 2 Global Action Commands 20 3 1 3 Context Specific Commands 20 3 1 4 Abbreviating Commands 20 3 1 5 Editing Command Lines 21 3 1 6 Concatenating Commands 21 3 1 7 Referencing Root Items...

Page 8: ...64 5 16 iSCSIConnection Properties 65 5 17 Portal Commands and Properties 66 5 18 Initiator Commands and Properties 67 5 19 AdvancedSettings Commands and Properties 68 5 20 SystemPolicy Properties 69...

Page 9: ...to Install the Program Screen 12 Figure 2 10 Progress Bar 13 Figure 2 11 InstallShield Wizard Complete Screen 13 Figure 2 12 Run Dialog Box 15 Figure 2 13 Example of Using the g u and p Switches 16 F...

Page 10: ...able 5 18 Task Commands 59 Table 5 19 Task Properties 59 Table 5 20 iSCSI Commands 60 Table 5 21 iSCSI Properties 60 Table 5 22 iSCSITarget Commands 61 Table 5 23 iSCSITarget Properties 61 Table 5 24...

Page 11: ...s that want to perform multiple tasks CLI users can create a sequence of commands that are connected together to achieve a very flexible range of results By comparison there is no simple way to connec...

Page 12: ...e you interact with the root context There is one instance of the root context on an D Link storage array In this guide the root context is referred to as System Every context has a unique ID When you...

Page 13: ...how controller a ID A Status OK IsActive true SlotNumber 0 SerialNumber 00001 DriveSlots 12 NumFrontPorts 8 DisplayName Blade A SoftwareVersion 2 5 1 21 IsAlternateSoftwareVersionPresent true Alternat...

Page 14: ...that return Contexts such as createVolume and addInitiator In Figure 1 1 the arrows represent command and property based navigation Single arrows show a link from one starting context to one resultin...

Page 15: ...Command Line Interface User s Guide 5 For more information about these global action commands see Chapter 4 Figure 1 1 Hierarchy of the System Context...

Page 16: ...xt Reconfigure on Volume 1 6 Enumerators Enumerators are a data type much like Number String Boolean and Date Time Enumerators have a discrete list of possible values that can be used in a property or...

Page 17: ...hapter describes how to install the CLI The topics covered in this chapter are Section 2 1 Supported Operating Systems page 8 Section 2 2 Installing the CLI page 8 Section 2 3 Starting the CLI page 14...

Page 18: ...soft Windows Vista Business and above 2 2 Installing the CLI To install the CLI use the following procedure 1 Start your Web browser In the browser address field enter the IP address of the management...

Page 19: ...s Guide 9 Figure 2 2 File Download Security Warning Message 3 Click Run to run the installer 4 If the security warning appears in Figure 2 3 click Run A Welcome page appears see Figure 2 4 Figure 2 3...

Page 20: ...se Agreement appears see Figure 2 5 Figure 2 5 License Agreement 6 Read the License Agreement then click I accept the terms in the license agreement and click Next You must accept the terms of the lic...

Page 21: ...greement click Print Figure 2 6 Destination Folder Screen 7 Either accept the default destination folder shown or click the Change button and specify a different installation location 8 Click Next You...

Page 22: ...indows VDS Provider and the CLI and displays the screen in Figure 2 9 If you only want to install the CLI select Custom and make the appropriate selections in the screens that appear see Figure 2 8 th...

Page 23: ...r shows the progress of the installation see Figure 2 10 As part of this process a shortcut is placed on your Windows desktop for starting the CLI Figure 2 10 Progress Bar 11 When the installation is...

Page 24: ...shortcut was automatically placed on your desktop To start the CLI using the shortcut use the following procedure 1 Double click the following shortcut on your Windows desktop A HOSTNAME IP address pr...

Page 25: ...or navigate to and issue commands from subcontexts see section 1 1 2 3 2 Using the Run Command to Start the CLI The following procedure describes how to start the CLI using the Windows Run command Wi...

Page 26: ...re 2 13 If u is omitted the environment variable ISA_USERNAME is used If p is omitted the ISA_PASSWORD environment variable is used If these environment variables are not defined you are prompted for...

Page 27: ...2 16 Specify the I switch to enable real time indications while the CLI is running This will allow the CLI to provide asynchronous reporting of changed services and may have performance impacts for h...

Page 28: ...ype the Exit command from the CLI session and press Enter to terminate the CLI program The Exit command is a global action command and can be issued from any context 2 5 Removing the CLI To remove the...

Page 29: ...LI This chapter describes how to use the CLI The topics covered in this chapter are Section 3 1 General Guidelines page 20 Section 3 2 Specifying Operating Modes page 22 Section 3 3 Command Line Synta...

Page 30: ...ic commands can be used within the current context only Context specific commands are prefaced by the global action command Do Show or Set The following example uses the global command Show and the co...

Page 31: ...ess to the volume named mynewvol volumeList Volumes mynewvol target grantInitiatorAccess All Example 4 This command line is similar to the one above However in this example quotation marks are added t...

Page 32: ...or 3 2 Specifying Operating Modes The CLI provides the following operating modes Output mode see section 3 2 1 Indication mode see section 3 2 2 Stream mode see section 3 2 3 Completion code see secti...

Page 33: ...e when the Show command at the root system context is issued If you change to another output mode type the following command to return to this output mode Mode outputMode Normal Figure 3 2 Example of...

Page 34: ...tput mode type the following command Mode outputMode FormattedXML Figure 3 4 Example of Formatted XML Output Excerpt Shown 3 2 2 Indication Mode Enabling indication mode displays messages of changes m...

Page 35: ...rror messages will be directed to the screen 3 2 4 Completion Code Mode Completion code mode determines whether the CLI returns a text code and text description each time it executes or tries to execu...

Page 36: ...to the IP address 192 168 59 25 Mode EchoCommandMode Enabled typed by user Mode EchoCommandMode Enabled returned by CLI By default echo command mode is disabled To enable it type Mode echoCommand Ena...

Page 37: ...ults to Show Member Member is a context member name such as a property or command Examples include Name on Volume and CreateVolume on the root Arguments Arguments are extensions that provide extra inf...

Page 38: ...ssion options Push Saves the current context on a LIFO stack and changes context Pop Returns to the last pushed context Select Changes context Show Shows a property in the current context Set Sets a p...

Page 39: ...ot_bound Split Failed show Controllers Gets a vector of all controllers in the system Returns controllers Controller list show DiskList Gets the DiskList service Returns diskList DiskList object show...

Page 40: ...tor Initiator object 3 4 2 Command Help Typing help followed by a global or context specific command displays help information about the command The following example displays help for the global comm...

Page 41: ...n preceding the first curly bracket to be interpreted as just a simple dollar sign precede it with the backslash escape character Example 1 The following example shows how variable substitution might...

Page 42: ...32 Chapter 3 Using the CLI This Page Left Intentionally Blank...

Page 43: ...hapter 4 Global Action Commands This chapter describes the global action commands in the CLI The topics covered in this chapter are Section 4 1 List of Global Action Commands page 34 Section 4 2 Descr...

Page 44: ...and in the current context 4 2 Echo Echoes command lines to Standard Out STDOUT 4 2 2 Execute Executes a CLI script file 4 2 3 Exit Ends the current CLI session 4 2 4 Help Displays all of the global a...

Page 45: ...ring SizeinBytes CompositionName Disks StripeWidth StripeDepth Do getMaxVolumeSize CompositionName Disks StripeWidth StripeDepth Do getMaxVolumeStripeWidth CompositionName Disks StripeWidth StripeDept...

Page 46: ...you will be performing repetitive operations on several systems just enter the commands into a text file and then execute the text file each time you want to perform those operations The text file ex...

Page 47: ...context specific commands supported by the CLI If a global action or context specific command follows Help only help for the command is displayed For more information see section 3 4 Syntax Help Help...

Page 48: ...m the CLI as human readable XML or formatted XML Indication mode displays messages when changes made to the system as a result of commands executed by you and other CLI users Stream mode configures th...

Page 49: ...bled Disables indication mode Mode streamMode Mixed_STDOUT_Only Enables stream mode directing all output to STDOUT Mode streamMode Mixed_STDOUT_STDERR Disables stream mode directing error messages to...

Page 50: ...y if you previously used a Push command or to the root level if you previously used a Select command If you are at the root level issuing this command displays the error message Content Stack empty He...

Page 51: ...a CLI script has this command and the number of arguments provided does not provide at least the number of required arguments specified with RequireArgs the script is terminated Syntax requireArgs in...

Page 52: ...context of machine 192 168 59 25 the command line jumps directly to the context Controller Then a show command displays the properties of the Controller context 192 168 59 25 Select Controller a Contr...

Page 53: ...with an external text file containing command line parameters and arguments It is particularly useful if you will be performing repetitive operations on several systems where argument shifting is req...

Page 54: ...UTHENTICATION SecondaryAuthenticationMethod CHAP MaxReceiveDataSegmentLength 32768 PrimaryHeaderDigestMethod NO_DIGEST PrimaryDataDigestMethod NO_DIGEST SecondaryHeaderDigestMethod CRC32C SecondaryDat...

Page 55: ...ommand where DOS command is the name of the DOS command you want performed Examples System dir c Displays the results of the DOS command in this example the contents of the root directory on the C dri...

Page 56: ...46 Chapter 4 Global Action Commands This Page Left Intentionally Blank...

Page 57: ...rties page 57 Section 5 10 Extent Properties page 57 Section 5 11 TaskList Property page 58 Section 5 12 Task Commands and Properties page 59 Section 5 13 iSCSI Commands and Properties page 59 Section...

Page 58: ...lobal action commands that can be used with the command or property and the return parameter For example in Table 5 1 AddInitiator can be used with the global action commands Do Push and Select and th...

Page 59: ...ts you access the External Connections Manager Show Push Select Context Identity Returns the Product Short Name identity Show Value ID The IP Address of the Management Port Show Value iSCSI Lets you a...

Page 60: ...ntext ControllerRestart Restarts the controller Do No Return Value ControllerShutdown Shuts down the controller Do No Return Value Table 5 4 Controller Properties Property Description Associated Globa...

Page 61: ...Show Show ID Push ID Select ID ContextList ManagementPort Lets you access the service management port Show Push Select Context MpuSwVersion Returns the software version that is running in the controll...

Page 62: ...In Table 5 5 for example RemoveFromLAG is used with the global action command Do Table 5 5 PhysicalPort Command Command Description Associated Global Action Commands Return Parameter Enable Enables t...

Page 63: ...Table 5 8 PoolList Properties Property Description Associated Global Action Commands Return Parameter GlobalAvailablePool Lets you access the available pool of drives Show Push Select Context GlobalS...

Page 64: ...e ATA version Show Value DriveNumber Returns the drive number Show Value DriveType Returns the type of drive Show Value EnclosureNumber Returns the enclosure the disk is in Show Value Extents Lets you...

Page 65: ...ommands in the Volume context and Table 5 14 provides an alphabetical list of the properties in the Volume context Both tables include a description of the command or property the global action comman...

Page 66: ...stripe depth Show Value StripeWidth Shows the stripe width Show Value Target Lets you access the associated iSCSI target Show Push Select Context Tasks Lets you access all volume tasks for an array S...

Page 67: ...5 16 provides an alphabetical list of the properties in the Extent context a description of the property and the global action commands that can be used with the command or property and the return pa...

Page 68: ...kList context the global action commands that can be used with the property and the return parameter In the table below for example Tasks is used with the global action commands Show Push and Select T...

Page 69: ...Cancel Cancels a task Do No Return Value Delete Deletes a task Do No Return Value Modify Modifies a task Do No Return Value Resume Resumes a suspended task Do No Return Value Suspend Suspends the task...

Page 70: ...lect Table 5 20 iSCSI Commands Command Description Associated Global Action Commands Return Parameter CreateLAG Creates a LAG Do Push Select Context CreateStaticRoute Creates a static route entry Do N...

Page 71: ...Value RevokeInitiatorAccess Revokes initiator access to this target Do No Return Value Table 5 23 iSCSITarget Properties Property Description Associated Global Action Commands Return Parameter DataPD...

Page 72: ...aximum receive data segment length Show Value Sets the maximum receive data segment length Set Value MaxUnsolicitedFirstDataBurstLength Returns the maximum unsolicited first data burst length Show Val...

Page 73: ...the secondary data digest method Set Value SecondaryHeaderDigestMethod Returns the secondary header digest method Show Value Sets the secondary header digest method Set Value Secret Returns a secret S...

Page 74: ...data PDU in order Show Value DataSequenceInOrder Returns the data sequence in order Show Value DefaultTimeToRetain Returns the default time to retain Show Value DefaultTimeToWait Returns the default...

Page 75: ...ed Returns the authentication method used Show Value ConnectionID Returns the connection ID Show Value DataDigestMethod Returns the data digest method Show Value HeaderDigestMethod Returns the header...

Page 76: ...d Global Action Commands Return Parameter Delete Deletes the portal Do No Return Value PingRemoteIPAddress Pings another IP address Do Value Table 5 27 Portal Properties Property Description Associate...

Page 77: ...action command Do Table 5 28 Initiator Command Command Description Associated Global Action Commands Return Parameter Delete Deletes the Initiator entry in the storage system Do No Return Value Table...

Page 78: ...lt settings Paramter Boolean to include or exclude the Management Port IP Address as one of the parameters to be reset to factory defaults Do No Return Value RestoreConfiguration Restores the system c...

Page 79: ...indow Scale value Set Value UserList Lets you access the user list Show Push Select Context DefaultVolumeBlockSizeBytes Sets the default volume blocksize of either 512 bytes or 4096 bytes Set Value Re...

Page 80: ...lServerIPAddress Returns the email server IP address Show Value Sets the email server IP address Set Value EmailServerPortNumber Returns the email port number Show Value Sets the email port number Set...

Page 81: ...nd the global action commands that can be used with the property and the return parameter In Table 5 34 for example InitiatorsActiveCount is used with the global action command Show Table 5 34 SystemS...

Page 82: ...ables the LAG Do No Return Value Enable Enables the LAG Do No Return Value ReplaceLAGandChangeVLAN Changes the VLAN Enabled flag by delete and recreate Do No Return Value Table 5 36 LAG Properties Pro...

Page 83: ...d Description Associated Global Action Commands Return Parameter PingRemoteIPAddress Pings another IP address Do Value Table 5 38 ManagementPort Properties Property Description Associated Global Actio...

Page 84: ...lue DestinationIsGateway Returns the destination is gateway Boolean value for this route entry Show Value DestinationSubnetMask Returns the destination subnet mask for this route entry Show Value Inte...

Page 85: ...es include a description of the command or property the global action commands that can be used with the command or property and the return parameter if any In Table 5 41 for example CreateVolume is u...

Page 86: ...76 Chapter 5 Supported CLI Commands and Properties This Page Left Intentionally Blank...

Page 87: ...ction 6 2 Creating Volumes page 78 Section 6 3 Obtaining the Maximum Size of a Volume page 79 Section 6 4 Obtaining the Maximum Stripe Width of a Volume page 79 Section 6 5 Adding an iSCSI Initiator p...

Page 88: ...that is 30 000 000 bytes 30 MB in size and whose volume composition is mirror 192 168 59 25 Do CreateVolume CAD 30MB mirror 192 168 59 25 CreateVolume CAD 30MB mirror Example 2 The following example...

Page 89: ...Volume The following example displays the maximum size of a volume called Exchange that Has a volume composition of parity Is created on disks 0 1 2 and 3 Has a stripe width of 4 and a stripe depth of...

Page 90: ...ity 6 5 Adding an iSCSI Initiator The following example adds the iSCSI initiator named below as a known iSCSI initiator to the system iSCSI initiators are added from the System context 192 168 59 25 D...

Page 91: ...isplay the status of a controller A In addition to the controller s name ID and status the following information is returned The number of ports on the controller The IP address and status of the cont...

Page 92: ...8 27 Ports 8 Ports LAGs 8 LAGs ManagementPort ManagementPort 192 168 59 25 Status OK BasePool BaseA 2 disks The information shown to the left of the equals sign in the example above are themselves com...

Page 93: ...1215 00c000006 484daa3e3a95a6c1 sessionCount 0 Initiators 0 Initiators Tasks 1 Tasks Name my_volume State Normal DurableName 600121500C000006484DAA3E3A95A6C1 CompositionName Parity NSPOF true Size 10...

Page 94: ...lNumber 0 EnclosureNumber 0 SlotNumber 0 DriveNumber 0 Vendor VendorModel Maxtor 7Y250M0 ATAVersion 7 ActualLinkSpeed 0 SupportedLinkSpeeds 0 SupportedLinkSpeeds SATAQueueingSupport ENABLED SATAQueueD...

Page 95: ...tionsManager 70 Initiator 67 iSCSI 60 iSCSIConnection 65 iSCSISession 64 iSCSITarget 61 LAG 72 ManagementPort 73 NetworkRoute 74 PhysicalPort 52 PoolList 53 Portal 66 ServicePool 75 System 48 SystemPo...

Page 96: ...ms 8 Output mode 23 Formatted XML 24 normal 23 XML 23 P PhysicalPort commands and properties 52 PoolList commands and properties 53 Pop command 40 Portal commands and properties 66 Push command 40 R R...

Page 97: ......