Professional Documents
Culture Documents
The information set forth in this document is proprietary and confidential information and property of TwinStrata. No part of this document may be photocopied, reproduced, translated into another language or conveyed in any manner to any party other than to whom specifically directed by TwinStrata without the prior written consent of TwinStrata. No party shall remove from CloudArray (the Product) or this publication, or obscure, or alter, any of the trademarks, trade names, logos, patent or copyright notices or markings, nor add any other notices or marking to the Product or this publication, nor allow or permit or assist any other party to do any of the foregoing. The information contained in this document is provided as is without warranty of any kind, is subject to change at any time, from time to time, and without notice, and without any TwinStrata obligation with respect thereto. TwinStrata makes no warranty or representation of any kind, whether express, implied or statutory, whether arising out of any proposal, presentation, quotation or otherwise, including that the Product will work in combination with any third-party network or computing equipment or software, that the operation of the Product will be uninterrupted or error free, or that defects in the Product will be corrected or that the Product will ever be updated. Twin Strata neither assumes nor authorizes any party to assume for it any liability. No warranties for third party software are provided. TwinStrata makes no warranty with respect to defective conditions or non-conformities resulting from Customers misuse, misinstallation, mishandling, neglect, accident, or abuse of the Product, or Customers failure to apply TwinStrata-supplied modifications or corrections. TwinStrata shall not be liable for technical or editorial errors or omissions contained herein. Operation of the Product and its output is premised upon Customers configuring and maintaining in such configuration and in good working order all necessary Customer infrastructure components. Product results are for comparison purposes between differing configurations based upon similar assumptions and therefore reflect only estimates of downtime and data loss. Product results represent average expected cost metrics over multiple years, and therefore as average(s), may not reflect actual result(s) for any particular year or period of years. TO THE FULL EXTENT ALLOWED BY LAW, IN NO EVENT WILL TWINSTRATA OR ITS SUPPLIERS OR LICENSORS OR AGENTS OR THEIR RESPECTIVE OFFICERS, DIRECTORS, EMPLOYEES, CONTRACTORS OR AGENTS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR INDIRECT DAMAGES, INCLUDING BUT NOT LIMITED TO LOSS OF USE, LOSS OF DATA, BUSINESS INTERRUPTION, LOSS OF REVENUE, LOSS OF BUSINESS OR OTHER FINANCIAL LOSS ARISING OUT OF OR IN CONNECTION WITH ANY OF THE PRODUCTS OR OTHER GOODS OR SERVICES FURNISHED TO CUSTOMER BY TWINSTRATA, EVEN IF ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES AND REGARDLESS OF THE THEORY OF LIABILITY. THIS LIMITATION WILL NOT BE AFFECTED EVEN IF ANY REMEDY PROVIDED HEREIN SHALL FAIL OF ITS ESSENTIAL PURPOSE. THE PRODUCT IS NOT FOR RESALE. THE PRODUCT IS NOT DESIGNED, OR INTENDED FOR USE IN ANY MEDICAL, LIFE SAVING OR LIFE SUSTAINING SYSTEMS, TRANSPORTATION SYSTEMS, NUCLEAR SYSTEMS, OR FOR ANY OTHER MISSION CRITICAL APPLICATION IN WHICH THE PERFORMANCE OR FAILURE OF THE TWINSTRATA PRODUCT OR SERVICES COULD CREATE A SITUATION WHERE PERSONAL INJURY OR DEATH MAY OCCUR.
Page 2
Scope of this Document ........................................................................................................................ 4 Whats new in version 2.6 .................................................................................................................... 5 Before Installing CloudArray ............................................................................................................... 6 System Requirements ...................................................................................................................... 6 Installing CloudArray ........................................................................................................................... 7 VMware Platform .............................................................................................................................. 7 XenServer Platform.......................................................................................................................... 11 Microsoft Hyper-V Platform ............................................................................................................ 14 Cloudarray Appliance Platform ....................................................................................................... 16 Configuring CloudArray Appliance ............................................................................................ 16 CloudArray VM Console ..................................................................................................................... 18 Network Configuration .................................................................................................................. 18 Proxy Configuration ....................................................................................................................... 20 Stop/Start CloudArray Service ...................................................................................................... 21 Maintenance.................................................................................................................................... 22 Diagnostics ...................................................................................................................................... 23 Accessing CloudArray Management UI ............................................................................................. 24 Configuring CloudArray Lightning Install ...................................................................................... 25 Configuring CloudArray Custom Mode .......................................................................................... 30 CloudArray Providers .................................................................................................................... 33 CloudArray Caches ......................................................................................................................... 35 CloudArray Volume Policies .......................................................................................................... 39 Host iSCSI configuration ................................................................................................................ 40 CloudArray Volume Creation & Mapping .................................................................................. 46 CloudArray Volume Quick Provisioning .................................................................................... 47 CloudArray Volume Using CloudArray Volumes....................................................................... 49 CloudArray Volume Un-mapping ............................................................................................... 53 CloudArray Volume Deletion ...................................................................................................... 54 CloudArray Volume Snapshots ................................................................................................... 55 CloudArray Volume Expansion................................................................................................... 60 CloudArray Bandwidth throttling Cloud Limit Utility .............................................................. 61 CLI Command Set & Built-in Scripts .................................................................................................. 64 Built-in Scripts: ............................................................................................................................... 64 CLI Commands: ............................................................................................................................... 65 User Management Commands: ................................................................................................. 65 Provider Management Commands: .......................................................................................... 65 Cache Management Commands: ............................................................................................... 66 Pool Management Commands:.................................................................................................. 66 Volume Management Commands: ............................................................................................ 67 Client Management Commands: ............................................................................................... 68 System Management Commands: ............................................................................................. 68 Collecting Support Data ...................................................................................................................... 70 Monitoring Statistics........................................................................................................................... 71 CloudArray Configuration Backup .................................................................................................... 72 Automatic Backup .......................................................................................................................... 72 Manual Backup ............................................................................................................................... 72 CloudArray Configuration Restore .................................................................................................... 74 Backup file location: ....................................................................................................................... 74 Restore Process: ............................................................................................................................. 75 About Screen ....................................................................................................................................... 79
CloudArray Administration Guide Page 3 Document version 2.6
Page 4
Page 5
CloudArray attached Hosts: Supported host Operating Systems Windows: XP, Vista, Win2003, Win2008 and Win7 RedHat: 4.0 and higher SUSE: 10, 11 HPUX: 11.23 (11i) OpenSolaris 2009.06 Mac OS X VMware ESX or ESXi
Web Browsers: Supported Web browsers for managing CloudArray: Mozilla Firefox 3.6, Internet Explorer 8, Google Chrome 10
Network Requirements: Allow Network Access over the following TCP/IP ports: 80 Inbound to CloudArray instance 80 - Outbound to Cloud Provider 443 - Outbound to Cloud Provider (with SSL enabled) 3260 - CloudArray iSCSI target
Page 6
Installing CloudArray
VMware Platform
1. Go to TwinStratas Web Portal at cloudarray.com in order to register and download the CloudArray Virtual Machine. 2. Extract the downloaded .zip file to a location of your choice. NOTE: It is recommended that you extract the file to the machine running the Graphical User Interface for the hypervisor on which CloudArray will be installed as this would minimize the VM import time. 3. Import the VM into your hypervisor NOTE: the VM is configured for 2 networks but only 1 is required For VMware ESX or ESXi: a. Open the VSphere client and log in using your credentials
Page 7
b. Once the client opens, click on File, then Import OVF template
c. Browse to the folder where you had extracted the contents of downloaded CloudArray zip file and choose the .ovf file. Then click next
Page 8
e. Provide a name for the Virtual Machine or you may leave it unchanged
f. Review the summary screen and click Finish to begin the importing process
g. A progress bar will indicate import status h. A success message will be displayed upon completion
5. On the host which you have designated for CloudArray management; install the following: Adobe AIR from http://get.adobe.com/air/ CloudArray Control (you should have received this from TwinStrata) NOTE: You do not have to change any default options while installing CloudArray Control.
6. Please skip to the section named CloudArray VM Console to configure the VM.
Page 10
XenServer Platform
1. Go to TwinStratas Web Portal at cloudarray.com in order to register and download the CloudArray Virtual Machine. 2. Extract the downloaded .zip file to a location of your choice. NOTE: It is recommended that you extract the file to the machine running the Graphical User Interface for the hypervisor on which CloudArray will be installed as this would minimize the VM import time. 3. Import the VM into your hypervisor. NOTE: the VM is configured for 2 networks but only 1 is required 4. Open XenCenter and log in. 5. Click on File and then Import VM. The following screen will be displayed
6. Leave import type checked as Exported VM and click on Browse to point to the location of the extracted VM. Then click Next. 7. Choose a Xen server on which to deploy this VM and click Next
CloudArray Administration Guide Page 11 Document version 2.6
Page 12
9. Change the virtual network interface if needed and click Next. Now click Finish for the import to begin. 10. XenCenter will show the import status of the VM towards the bottom of the screen. 11. Once the VM has been imported, start the VM if not already started. 12. On the host which you have designated for CloudArray management; install the following: Adobe AIR from http://get.adobe.com/air/ CloudArray Control (you should have received this from TwinStrata) NOTE: You do not have to change any default options while installing CloudArray Control.
13. Please skip to the section named CloudArray VM Console to configure the VM.
Page 13
Page 14
7. Fill the following fields: Location: point to the root folder where you had extracted the VM files. Import Settings: Select Copy Virtual Machine. Duplicate all files: Check this box if you plan to deploy this VM to multiple Hypervisors 8. Then click Import. 9. The import process will be begin and might take some time to complete. A status bar will indicate the progress.
10. Once the VM is imported, please power it up. 14. On the host which you have designated for CloudArray management; install the following: Adobe AIR from http://get.adobe.com/air/ CloudArray Control (you should have received this from TwinStrata) NOTE: You do not have to change any default options while installing CloudArray Control.
11. Please skip to the section named CloudArray VM Console to configure the VM.
Page 15
3. Choose Sign in and sign on using the following credentials: Username: admin Password: password NOTE: Upon first login, you will be prompted to change the password. 4. From the CloudArray console choose Network Configuration
Change the Hostname as desired Configure the DNS Server Configure the Default Gateway Enter eth0 or eth1 for Gateway Device NOTE: In Microsoft Hyper-v the interface names are seth0 or seth1 Configure device eth0 by defining an IP address & Subnet Mask Choose Save Choose Save again from the main menu You will see Restarting Network popup. Please be patient as this operation can sometimes take a few minutes to complete
NOTE: If you changed the Hostname, you will be prompted to reboot for the changes to take effect. 6. Once CloudArray reboots it will automatically start the required services 7. Please skip to the section named Proxy Configuration to continue setting up the Appliance
Page 17
CloudArray VM Console
CloudArray VM console allows for setting network configuration, managing CloudArray service, Restart of the VM and diagnostic tests. Here is the complete list of the features located within the VM Console. Each of the following sub-section covers them in detail.
Network Configuration
This section contains menu items for setting the network related information for CloudArray
Page 18
Menu Items
Change the Hostname as desired Configure the DNS Server Configure the Default Gateway Enter eth0 or eth1 for Gateway Device NOTE: In Microsoft Hyper-v the interface names are seth0 or seth1 Configure device eth0 by defining an IP address & Subnet Mask Choose Save Choose Save again from the main menu You will see Restarting Network popup. Please be patient as this operation can sometimes take a few minutes to complete
NOTE: If you changed the Hostname, you will be prompted to reboot for the changes to take effect.
Page 19
Proxy Configuration
This section contains menu items for setting the proxy related information for CloudArray
Menu Items 1. Enable Proxy Support: Enable or disable proxy support 2. Proxy Server: IP address Or DNS name of your proxy server 3. Port Number: Port number that your proxy server uses
Page 20
NOTE: If the CloudArray service is started, the menu item displays, Stop CloudArray Service If the CloudArray service is stopped, the menu item displays, Start CloudArray Service 1. You can stop the CloudArray service by choosing: Stop CloudArray Service 2. You can start the CloudArray service by choosing: Start CloudArray Service
Page 21
Maintenance
This section contains CloudArray maintenance related menu items
Menu Items 1. 2. 3. 4. Reset Password: This allows you to rest your VM Console password Reboot VM: This allows you to reboot the CloudArray VM Shutdown VM: This allows you to shutdown the CloudArray VM Restore CloudArray: This allows you to restore CloudArray metadata from a backup. NOTE: Please see CloudArray Backup & Restore Guide for details
Page 22
Diagnostics
This section contains CloudArray diagnostics related menu items
Menu Items 1. Ping Test: This allows you to run a ping test in order to verify network connectivity
Page 23
Page 24
to continue.
Page 25
3. Enter your license information and provide an administrator login and password to use with your new CloudArray Control
CloudArray License Email This is the email address that you registered with on cloudarray.com Password License This is password you chose on cloudarray.com This is the license tag generated for you. To see your license tag, log into your account on http://www.cloudarray.com and click My Licenses. The tag is displayed towards the bottom of the page, under the field name: License Tag
CloudArray administrator login Name This is the administrator account name you will be creating for CloudArray Password This is password you want to set for the administrator account
Page 26
5. On the remote storage credentials screen you can choose to enable compression/deduplication and encryption. These settings are enabled by default.
6. You can also define your remote storage credentials here. Select the provider you wish to connect to and enter the information required
7. Click
Page 27
8. The following success screen will be displayed. Please read the screen and see if using CloudArray Control Console for further steps is a better option for you, if not please click to continue to perform automatic volume allocation
9. Now you can define the size of the volume and optionally choose it to auto map to the first iSCSI host that logs in. Click Provision to continue
Page 28
11. Please refer to the section named Host iSCSI Configuration to configure a host to communicate with CloudArray. 12. Once a host logs into CloudArray successfully, the volume you created in step 9 will be automatically mapped to the host. Use standard volume management tools on the host in order to rescan for the disk. 13. You can now format this disk and begin to use it for IO.
Page 29
2. Now enter your license information (see field explanation on next page)
Page 30
This is the email address that you registered with on cloudarray.com This is password you chose on cloudarray.com This is the license tag that got generated for you. To verify you may log into your account on cloudarray.com and click on My Licenses. The tag is displayed towards the bottom of the page, under the field name: License Tag
3. Click Register to continue 4. Read and accept the End User License Agreement 5. Now create an administrator login and password on the following screen and click Create to continue
Page 31
7. The next step will be to connect to a remote storage provider. Please see the next section labeled CloudArray Providers for details
Page 32
CloudArray Providers
1. In order to connect to the remote storage provider, please click the Configure button
Page 33
Please fill in following: Name - name for the provider Encryption enabled/disabled Compression/Deduplication enabled/disabled Provider From the dropdown list choose a provider type and enter the required information in order to connect to the provider
4. Click Create when done to continue. CloudArray will now try attaching the provider chosen using the credentials provided and a success will be indicated by the provider showing up in the Providers list NOTE: CloudArray supports using multiple providers within the same CloudArray instance. You can create multiple providers by repeating the above steps
Page 34
CloudArray Caches
IMPORTANT: CloudArray ships with a 25GB partial cache which is formatted automatically. The CloudArray Appliance also ships with addition cache built-in, however this cache capacity must be configured by the following the steps in below before it can be used Additional cache volumes can be added as needed by first adding a volume to the CloudArray VM from the hypervisor. Once a volume has been added, do the following in order to use the new volume as a CloudArray Cache 1. Click on Configure from the main screen and then click Cache
NOTE: Under the Caches tab you will see Cache 0 already present. This is the 25GB partial cache that was mentioned earlier. Under the Devices tab you will see an entry named Pool_builtin, this is the physical device behind the 25GB cache.
Page 35
2. In order to detect and use a second volume for CloudArray Cache click on Rescan under the Devices tab. This operation kicks off a background script which probes for new disks on the CloudArray VM and if found, creates a cache provider on the disk. Once the command completes, the results will be displayed in a pop up window
The new cache device will now be displayed in the list of devices as Pool_1. Click on the device and make a note of the value for Available
Page 36
3. Now click Caches tab and then click the newly discovered cache device
4. The following screen will be displayed (see field options on next page)
Page 37
In here specify: Name: name of the cache Cache page size: The default value is 1MB which is designed to provide best performance in most use cases. You can optionally change this value by using the dropdown menu Create volume: Only check this option if you are planning on using this cache is a partial cache. Enter a nondecimal number equal to or less than the one you got from step 2 above Cache Device: choose the new cache device (from the dropdown) that just got created by the rescan (Ex: Pool_1) And click create 5. The new Cache will now be created and listed under the Caches section
Page 38
Fill in the following fields Name: name of the policy Cache: choose a cache to associate with the policy Create Dedicated: only enable this option if you plan to use the policy to create fully cached volumes Provider: choose the cloud provider Then click create
Page 39
Page 40
3. Input the IP Address of the VM instance running CloudArray. Leave the port as default (3260) and click OK
4. Now click Targets. The iSCSI target that you had added in the previous step should now be listed in here as Inactive
5. Click Log on and the following screen will be displayed. Check the option for Automatically restore this connection and click OK
Page 41
7. Host-side iSCSI configuration is now complete 8. The host will now appear in CloudArray Control in Clients and Volumes, under the clients tab
Page 42
4. Once the package has been downloaded and installed, start the iSCSI daemon by typing: $ service iscsid start 5. Now you can use the iscsiadm utility to discover and login into CloudArray, by typing: $ iscsiadm -m discovery -t sendtargets -p <IP address of CloudArray>:3260 6. Your CentOS host should now be listed in CloudArray Control under Clients. 7. You may now provision a volume to this host using CloudArray Control. 8. Once a volume has been provisioned, you may rescan for the volume by typing: $ service iscsi restart 9. You may now run: $ fdisk l This output should list a new volume on which you can now a. Create a partition: using fdisk command b. Format: using mkfs command c. Mount: using the mount command
Page 43
HPUX
Installation: 1. Log in to the HPUX with root privilege. 2. Download the HP-UX iSCSI initiator from the following Web site: http://h20293.www2.hp.com/portal/swdepot/displayProductInfo.do?productNumber=T 1452A 3. After you have downloaded the iSCSI-00_B.11.31.01_HP-UX_B.11.31_IA+PA.depot file, use the mv command to move it to the /tmp directory on your system. 4. On a stand-alone system, run the swinstall command to install the product. # swinstall -x autoreboot=true -s /tmp/iSCSI-00_B.11.31.01_HP-UX_B.11.31_IA+PA.depot iSCSI-00
Configuration: 5. Add the path for the iscsiutil executable program and other iSCSI executable programs to the root path. # PATH=$PATH:/opt/iscsi/bin Note: Add the previous string to the /.profile file to avoid manually updating the PATH environment variable each time. 6. Add a discovery target with the iscsiutil -a -l <IP> command. # iscsiutil -a -I <IP address of CloudArray> Note: HP-UX iSCSI software initiator does not support IPv6 addresses. Do not configure IPv6 addresses as a target IP 7. The HPUX host should now be visible in CloudArray Control 8. You may now provision a volume to this host using CloudArray Control 9. Check the disk information. diskinfo -v <disk>
Page 44
SUSE
1. Login to the SUSE host with root privilege 2. To install iSCSI initiator type the following command $ zypper install open-iscsi 3. $ rcopen-iscsi start 4. $ iscsiadm -m discovery -t sendtargets -p <IP address of CloudArray> 5. $ iscsiadm -m node -t iqn.2001-05.com.doe:test -p <IP address of CloudArray:3260> -login 6. The SUSE host should now appear under clients in CloudArray Control 7. You may now provision a volume to this host using CloudArray Control 8. Run the following command to rescan for the volume(s) mapped rcopen-iscsi restart
Page 45
2. Fill in the following fields Create volume name: name of the volume. Ex: Volume1 Capacity: enter numerical value and choose the unit. Ex: 5, unit GB Policy: from the dropdown, choose the CloudArray policy. Ex: Partially Cached Map to Client: check the box and from the dropdown choose the iSCSI client to which this volume will be mapped 3. Then click Provision. The volume will now be created and mapped to the host you selected
Page 46
Page 47
2. From the left pane choose a previously created policy 3. Fill out fields on the right pane for Create volume name Capacity Map to Client
Page 48
2. Right click on Disk Management and choose Disk Rescan. Windows will now probe for new volumes and should detect a new volume. For Ex:
Page 49
Initializing the disk: 1. The disk status should change from Offline to Not Initialized. Right click again in the same area as before and this time choose Initialize Disk
2. Choose the disk to be initialized. For the partition style leave the default value of MBR and click OK
Page 50
Formatting the disk: 1. Right click on the Unallocated label and choose New Simple Volume
2. Windows will display the New Simple Volume Wizard. Click next twice and on the Assign Drive Letter or Path screen choose the drive letter from the drop down box and click Next.
3. In the Format Partition screen choose the File System type. Ensure that Perform a Quick Format option is checked and click Next. Then click Finish
Page 51
4. Windows will now begin to format this volume and the following will be displayed once the process completes.
This volume should now be listed under My Computer as the Z: drive. You can now begin to use this volume for host IO
Page 52
4. The volume will now be un-mapped and will disappear from the host upon rescanning with the hosts volume management utility
Page 53
4. The volume and resident data will now be deleted from CloudArray and the cloud provider permanently
Page 54
Page 55
Exposing a Snapshot: 1. From the Snapshots tab, choose the snapshot and then click the button to expose the snapshot. Optionally you may choose an alternate cache for the snapshot
Page 56
Mapping a Snapshot: 1. From the Mapping tab, choose d. Client: to which the snapshot will be mapped e. Volume: the snapshot volume to be mapped Then click button to map the snapshot
2. The snapshot volume will now be listed under the section, volumes mapped here 3. The volume could now be accessed from the client by rescanning for it using the hosts volume management utility
Page 57
Un-exposing a Snapshot: IMPORTANT: Volume(s) should always be un-mapped from the client before un-exposing. Please refer to section CloudArray Volume Un-mapping of this document for details on unmapping a volume 1. Once the volume has been un-mapped from its respective client, click on the Snapshots tab and choose the snapshot under Exposed Snapshots 2. Click the button to un-expose the snapshot
Page 58
Deleting a Snapshot: 1. From the Snapshots tab, choose the snapshot from section Snapshots 2. Click the button to delete the snapshot
Page 59
Usage Syntax: expand_volume --name <volume name> --size <numerical value> --units <GB, MB, Blocks> 2. Now type the command in the window labeled CLI Command and click go
Page 60
2. Then choose the utility from the menu and in the parameters field, input the switches required for your specific case and click Go.
Page 61
Switches
Switch Name -help -show Purpose Displays usage (this) Comma-separated list to display the current schedule, limit(s), and/or interfaces. 'sched'=bandwidth schedule 'limits'=bandwidth limits 'if'=ethernet interfaces -limit -nolimit -sched Bandwidth limit in megabits per second (minimum 2.00) Removes bandwidth limits (same as -limit 0) Bandwidth limit scheduling. 'add' adds the specified schedule to the existing schedule. 'del' deletes the specified schedule from the existing schedule. 'set' replaces the existing schedule for the days specified. -high -low -day High bandwidth for the requested schedule at the specified time Low bandwidth for the requested schedule at the specified time (optional) Comma-separated list of days for which to apply the requested schedule where: 'M'=Monday 'T'=Tuesday 'W'=Wednesday 'Th'=Thursday 'F'=Friday 'Sa'=Saturday 'S'=Sunday Note: Days are case sensitive. Use commas only; do not include spaces between the days.
Page 62
Usage Examples
Example: cloud_limit -limit 10 Sets a cloud transmission limit of 10Mb/s. Example: cloud_limit -sched add -high 10,13:30 -low 5.5,06:00 -day M,W,Th,Sa,S Creates and adds a schedule for high bandwidth of 10 Mb/s at 1:30pm, low bandwidth of 5.5 Mb/s at 6:00am on Mondays, Wednesdays, Thursdays, Saturdays, and Sundays.
Example: cloud_limit -sched add -high 15,15:00 -low 5.5,14:00 -day M Creates and adds a schedule for Monday only with a high bandwidth of 15 Mb/s at 3:00pm and low bandwidth of 5.5Mb/s at 2:00pm. Combined with the above example's schedule, Mondays would have a limit 5.5 Mb/s from 6:00am until 1:30pm, 10Mb/s from 1:30pm until 2:00pm, 5.5Mb/s from 2:00pm until 3:00pm, and 15 Mb/s until 6:00am Tuesday. Example: cloud_limit -sched del -day M,Th Deletes all bandwidth scheduling for Mondays and Thursdays Example: cloud_limit -sched del -high 10:13:30 Deletes bandwidth scheduling with a limit of 10 Mb/s set for 1:30pm on all days. Example: cloud_limit -sched set -high 10:13:30 -day M,W Erases all scheduling for Mondays and Wednesdays setting a new schedule to limit bandwidth to 10 Mb/s starting at 1:30pm. Example: cloud_limit -limit 10 -show if,limit,sched -sched set -high 5,13:00 -day M Sets the bandwidth limit, displays the interfaces, limits, and schedule and also creates a new schedule.
Page 63
Built-in Scripts:
1. 2. 3. 4. 5. 6. cache_usage: Reports the CloudArray cache usage data cloud_limit: Limits outbound cloud bandwidth utilization to the cloud list_users: Lists the users who have created an account in CloudArray Control rescan: Scans for new cache devices update_license: Checks for updated license versions: Lists the version of CloudArray
Page 64
CLI Commands:
User Management Commands: Command: new_user --name name --password password Explanation: create a new user account with name and cleartext password by the caller Command: check_user --name name --password password Explanation: check the validity of a user name/password combination Command: change_password --name name --old old --new new [--force true|false] Explanation: change the user password. If the old password is not provided, the force flag must be set to true Command: remove_user --name name Explanation: remove an existing named user account
Provider Management Commands: Command: new_provider --pool pool --name name [options] Explanation: create a new provider of specified type in named pool. Current types and options are: s3 --key key --secret secret [--node node] [--secure true|false] [--port port] [-location location] [--bucket bucket] atmos --token token --secret secret [--node node] [--secure true|false] [--port port] synaptic --user userID --application applicationID --secret secret [--node node] [--secure true|false] [--port port] eucalyptus --key key --secret secret --node node [--secure true|false] [--port port] block --path path change_secret --target provider|volume --name name --from oldsecret --to newsecret change the secret of either a provider or a volume. Note that changing a providers secret currently does nothing to any volumes that were created using this providers policy description. This could change. Command: remove_provider --pool pool --name name Explanation: remove a provider from the cloudarray. This action does not affect any volumes that were created using this providers policy description provider_info --pool pool --name provider provide an xml description of the provider that was created and its current status, e.g. up/down
Page 65
Command: set_encryption --pool pool --provider provider -value true|false [-keypair keypair] Explanation: set the encryption for a given provider in a given pool to be on or off. If a keypair is not specified, generate and use a new one Command: set_compression --pool pool --provider provider -value true|false [-level 0|1|2|3|4|5|6|7|8|9] Explanation: set compression for a given provider in a given pool to be on or off Command: list_providers --pool pool Explanation: list the providers that are available within the specified pool
Cache Management Commands: Command: new_cache --name name --pool pool [--page_size pageSize] [--block_size block_size] Explanation: add a new cache policy to the system using the named pool. Optionally set page and block size Command: add_cache_volume --name name --cache cache --size size [--units blocks|MB|GB] [pool pool] Explanation: create a new volume based on the policies described in the cache. Defaults to GB as the size units. Optionally draws capacity from an alternate specified pool. Command: remove_cache_volume --cache cache --volume volume Explanation: remove a volume from a cache Command: remove_cache --cache cache Explanation: remove a cache policy Command: list_caches [--raw] Explanation: List caches configured on the system. Command: flush_volume --name name Explanation: force a flush on the named volume. This operation will remain pending until the flush completes. Command: cache_status --name name Explanation: lists the status of the given cache
Pool Management Commands: Command: new_pool --name name [--cache true|false] Explanation: Add a new pool to the system with the specified name. May have the attribute of being a pool for caches.
CloudArray Administration Guide Page 66 Document version 2.6
Command: remove_pool --name name Explanation: Removes a pool from the system. Does not remove any volumes created using this pool as a prototype Command: list_pools [--raw] Explanation: List pools configured on the system.
Volume Management Commands: Command: list_volumes [--raw] Explanation: List volumes configured on the system. Command: new_policy --name name --pool pool --cache cache [--dedicated true|false] Explanation: create a new volume policy as named, drawing capacity from the specified pool and cache, optionally dedicated Command: remove_policy --name Explanation: remove the named volume policy. Removing the policy does not affect any existing volumes Command: new_volume --name name --policy policy --size size [--units blocks|MB|GB] Explanation: create a new volume based on the policies described in the pool. Defaults to GB as the size units. Command: rename_volume --old name --new name Explanation: changes the external name from old to new. The external name is the name that will be used by the UI. Command: remove_volume --name name Explanation: remove the named volume from the system. Will also remove any mappings and/or snapshots based on this volume. Command: lock_volume --name name Explanation: prevent any IO from being processed by this volume Command: unlock_volume --name name Explanation: allow IO processing on this volume Command: new_snapshot --volume name --when now|flush|after_next Explanation: creates a snapshot of the named volume at the specified event: either now, which will be consistent with the previous but not the current flush, flush, which will be consistent with the current flush, if active, or after_next, which will always wait for the next flush to complete before snapping. Command: expose_snapshot --volume name --snapshot name [--cache cache]
Page 67
Explanation: creates a read/write volume based on the named snapshot which draws its local storage from the specified cache. It does not map the volume to any clients Command: hide_snapshot --volume name --snapshot name Explanation: removes the specified snapshot volume from the system. It does not remove the snapshot data Command: remove_snapshot --volume name --snapshot name Explanation: removes the specified snapshot data from the system. Any volumes exposed by this snapshot will also be removed Client Management Commands: Command: list_clients [--raw] Explanation: List clients configured on the system. Command: new_client --name name [--iqn name] Explanation: Adds a new named client to the system. If the iqn is specified, it will use that iqn as the identifier. If the iqn is not specified, it will attempt to match the specified name with the final characters of the iqns of incoming clients. Note that clients are automatically added in the discovery phase, so this command is an optional part of the process. It can be used to map volumes to a client before the client is attached. Command: rename_client --old name --new name Explanation: change the external name of the client, which is the name that will be used by the UI Command: map_volume --volume name --client name [--option readonly|readwrite] Explanation: exposes the volume to the client, optionally as a read-only disk. If the mapping already exists, permissions can be modified Command: unmap_volume --volume name --client name Explanation: removes the volume from the client. Does not check for IO in progress before removal Command: remove_client --name name Explanation: Removes a named client from the system
System Management Commands: Command: terminate Explanation: cease operations Command: list_version Explanation: report version and system information
CloudArray Administration Guide Page 68 Document version 2.6
Command: set_logging --level 0|1|2|3|4|5|6|7|8|9 Explanation: set the logging output to the specified level Command: set_license --owner owner --password password --license license [--user user -password password] Explanation: set the license for a cloudarray system. The owner, password, and license fields are passed on to the server to retrieve the actual license information. If a valid license key is not set on the system, then the user and password fields are not required, but if the current system is licensed, a valid local user and password is necessary in order to change the license information. Command: list_stats Explanation: list the current system io statistics. Command: reset_log Explanation: reset the system log files to empty. Command: license_info Explanation: retrieve the current license status, including any restrictions and expirations Command: set_tag --type volume|client|pool|provider --name name --tag tag Explanation: set a tag on a named volume, client, pool, or provider Command: clear_tag --type volume|client|pool|provider --name name --tag tag Explanation: clear a tag on a named volume, client, pool, or provider Command: get_key --name name [--passphrase passphrase] Explanation: return a pkcs12 envelope containing the named key pair, optionally encrypted using the passphrase Command: add_key --key key [--passphrase passphrase] Explanation: takes a pkcs12 envelope containing a named key pair, optionally encrypted using the passphrase, and stores it as a tempest key pair Command: list_security [--raw] Explanation: list the keys that are currently installed
Page 69
2. Then click on Support. CloudArray will collect all support related files and create a resulting .tar file. You will be prompted to save the file at a location of your choice. To request assistance, email this file to TwinStrata support at (support@twinstrata.com)
Page 70
Monitoring Statistics
CloudArray allows the user to view IO statistics for CloudArray Volumes and Caches 1. From the home screen choose Status
2. Choose either a volume or a cache and its corresponding statistics will be displayed
Page 71
Automatic Backup
CloudArray metadata is now automatically and securely backed up to the CloudArray portal. The backup occurs once an hour has elapsed since the last configuration change. In the event of a disaster, users simply log into the CloudArray portal with their unique credentials and have immediate access to their metadata. Using this metadata, users can then instantly restore access to their data on a new appliance.
Manual Backup
If you wish you can also take manual backups of your CloudArray metadata and save them locally to a location of your choice by following the procedure below 1. To get started, click on administer on the home screen
Page 72
2. Now click the backup button in order to start the backup process
3. Once the backup is complete, you will be prompted to save the backup file to a location of your choice
Page 73
Manual Backups: If you wish to restore a configuration using a backup file which was created using Manual backup, you can just the file that you saved locally.
Page 74
Restore Process:
1. Import a new CloudArray image to the hypervisor. In this document we will refer to the new VM as CA2
IMPORTANT: If the original CloudArray configuration had additional cache disks, the new
CloudArray server MUST have an identical cache disk configuration. (i.e if CA1 had a 20GB additional disk, then CA2 must also have a 20GB additional disk provisioned to it before a restore can be executed) 2. Power up your CloudArray image (CA2) 3. Modify the new CloudArray Host name and IP address (if static) NOTE: Please refer to the CloudArray Administrator Guide for instruction on how to setup networking 4. Connect to CA2 using a supported web browser 5. Enter your CloudArray license into CA2 If you do not remember your license, you can find it on the CloudArray Portal: cloudarray.com Sign in using your email address and the password you created when you created your account:
Page 75
The CloudArray License Tag will be available at the bottom of the My Licenses page of the portal. The License Tag is mandatory for any new CloudArray instance
6. CloudArray Control will present the End User License Agreement. Please read and click accept the agreement to continue 7. Add a temporary user account to CloudArray. NOTE: This user will be overwritten during the restore process
Page 76
Page 77
10. You will be notified that Restoring your configuration will restart CloudArray. You will be logged out and all volumes will temporarily lose connectivity. Continue? Click yes to continue
11. Navigate to the backup file, select the file, and then click Open 12. Upon completion, the CloudArray Control will automatically log out 13. Wait a few minutes and try logging back into CloudArray Control and using the original login credentials from CA1. NOTE: If login fails, wait a few more minutes as the restore might still be in progress and try again 14. The CloudArray instance will now mirror the configuration of the original CloudArray instance at the time of the backup 15. The restore is now complete
Page 78
About Screen
The about screen lists the following info Version of CloudArray Control Version of Web Services Version of CloudArray Licensed to License name Expiration Capacity
This screen can be accessed by clicking the About button located in the top left corner of CloudArray Control
Page 79