IBM Spectrum Control Base Edition

IBM Spectrum Control Base Edition
Version 3.0.2
User Guide
IBM
SC27-5999-17
Note
Before using this document and the product it supports, read the information in “Notices” on page 181.
Edition notice
Publication number: SC27-5999-17. This publication applies to version 3.0.2 of IBM Spectrum Control Base and to all
subsequent releases and modifications until otherwise indicated in a newer publication.
© Copyright IBM Corporation 2013, 2016.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Who should use this guide . . . .
Conventions used in this guide . .
Related information and publications
Getting information, help, and service
IBM Publications Center . . . . .
Sending or posting your comments .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
xiii
xiii
xiii
xiv
xiv
xiv
Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Included cloud interfaces . . . . . . . . . . . . . . . . . .
IBM Storage Provider for VMware VASA . . . . . . . . . . . .
IBM Storage Enhancements for VMware vSphere Web Client . . . . .
IBM Storage Plug-in for VMware vRealize Orchestrator . . . . . . .
IBM Storage Management Pack for VMware vRealize Operations Manager
Concept diagram . . . . . . . . . . . . . . . . . . . . .
Virtual volumes . . . . . . . . . . . . . . . . . . . . .
Storage Policy Based Management (SPBM) . . . . . . . . . . . .
Storage space and service management . . . . . . . . . . . . .
Management options . . . . . . . . . . . . . . . . . . .
Graphical user interface (GUI) . . . . . . . . . . . . . . .
Command-line interface (CLI) . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1
1
2
2
3
3
5
6
7
9
9
9
Chapter 2. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Compatibility and requirements . . . . . . . . .
Downloading IBM Spectrum Control Base Edition software
Performing first-time installation . . . . . . . . .
Upgrading an existing installation . . . . . . . . .
Uninstalling the Spectrum Control Base Edition software .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
11
11
12
14
18
Chapter 3. Operation and management . . . . . . . . . . . . . . . . . . . . . . 21
Required and optional initial tasks. . . . . . . . . .
Configuring LDAP-based directory user access . . . . .
Logging in. . . . . . . . . . . . . . . . . .
Spectrum Control Base GUI . . . . . . . . . . . .
Running initial setup . . . . . . . . . . . . . .
Managing high-availability groups. . . . . . . . . .
Defining a high-availability group . . . . . . . . .
Managing server certificates . . . . . . . . . . . .
Managing Spectrum Control Base users . . . . . . . .
Adding a new user . . . . . . . . . . . . . .
Changing the password of a Spectrum Control Base user .
Deleting a user . . . . . . . . . . . . . . .
Managing storage systems . . . . . . . . . . . .
Entering the storage system credentials . . . . . . .
Adding a storage system . . . . . . . . . . . .
GUI – Working with storage system views . . . . . .
Modifying the IP address or hostname of a storage system
Removing a storage system . . . . . . . . . . .
Managing and monitoring VASA access . . . . . . . .
Setting the VASA credentials. . . . . . . . . . .
© Copyright IBM Corp. 2013, 2016
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
21
23
29
30
33
36
37
39
41
42
43
44
44
45
47
49
51
52
53
53
iii
Managing VASA trusted certificates . . . . . . . .
Managing storage spaces and services . . . . . . . .
Adding a storage space . . . . . . . . . . . .
Removing a storage space . . . . . . . . . . .
Adding a storage service . . . . . . . . . . . .
Removing a storage service . . . . . . . . . . .
Defining and attaching storage resources . . . . . .
Resizing storage resources . . . . . . . . . . .
Modifying storage resource attachments . . . . . . .
Managing integration with vSphere Web Client . . . . .
Adding a vCenter server . . . . . . . . . . . .
Updating the credentials of a vCenter server . . . . .
Removing a vCenter server . . . . . . . . . . .
Delegating storage services to a vCenter server . . . .
Canceling service delegation to a vCenter server . . . .
Managing integration with vRealize Orchestrator . . . . .
Downloading and installing the plug-in package for vRO .
Delegating storage services to the vRO server . . . . .
Canceling service delegation to a vRO server . . . . .
Regenerating the vRO token . . . . . . . . . . .
Managing integration with vRealize Operations Manager . .
Downloading the vROps management package . . . .
Deploying the management package on vROps . . . .
Connecting the vROps server to Spectrum Control Base .
Controlling storage system monitoring on the vROps server
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
54
54
56
57
57
60
60
64
65
66
66
68
69
69
71
71
72
75
76
76
77
78
79
80
81
Chapter 4. Using the IBM Storage Provider for VMware VASA . . . . . . . . . . . . 83
Registering Spectrum Control Base as a storage provider on vCenter server .
.
.
.
.
.
.
.
.
.
.
.
.
. 83
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client . . . 87
Required vSphere privileges . . . . . . . . .
Viewing the IBM storage object information . . .
Creating and mapping a new storage volume (LUN)
Extending a volume . . . . . . . . . . .
Renaming a volume . . . . . . . . . . .
Setting multipath policy enforcement for a volume .
Unmapping a volume from one or more hosts . .
Deleting an unused volume . . . . . . . .
Displaying the virtual volume information . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 87
. 89
. 94
. 99
. 101
. 102
. 103
. 104
. 105
Chapter 6. Using the IBM Storage Plug-in for VMware vRealize Orchestrator . . . . . 109
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations
Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Overview dashboard . . . . . . . . . .
Using the alert widget . . . . . . . .
Performance dashboard . . . . . . . . .
Performance metrics . . . . . . . . .
Top 10 dashboard . . . . . . . . . . .
Displaying the overview of IBM storage objects .
Defining thresholds and alerts for storage objects
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
115
117
118
120
126
127
128
Chapter 8. Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Checking and controlling the Spectrum Control
Checking and modifying the configuration files
Adjusting system update interval. . . .
Configuring alarm reporting . . . . .
Configuring metrics scope . . . . . .
Enabling SSL verification . . . . . .
iv
IBM Spectrum Control Base Edition
Base
. .
. .
. .
. .
. .
service
. . .
. . .
. . .
. . .
. . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
133
134
134
135
135
136
Changing the Spectrum Control Base communication port .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 136
Chapter 9. Management from the command-line interface . . . . . . . . . . . . . 137
CLI
CLI
CLI
CLI
CLI
CLI
CLI
CLI
– Switching to 'IBMSC' user mode . . . . . . . . . . .
– Managing Spectrum Control Base users . . . . . . . .
– Managing server certificates . . . . . . . . . . . .
– Adding or removing storage system credentials . . . . . .
– Managing storage systems . . . . . . . . . . . . .
– Setting the VASA credentials . . . . . . . . . . . .
– Managing integration with vRealize Operations Manager . .
– Backing up or restoring a Spectrum Control Base configuration
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
137
138
139
141
143
145
146
150
Chapter 10. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Checking the log files . . . . . . . . . . . . . . .
Checking the format of directory-based storage system credentials
Configuring event forwarding . . . . . . . . . . . . .
Deleting virtual volumes and group pools via XCLI . . . . .
Self-assist options for IBM Spectrum Control Base Edition . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
153
155
156
156
157
Chapter 11. Best practices . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Handling datastores . . . . . . . . . . . . . . . . . . . . . . . .
Handling ESXi hosts that use XIV volumes . . . . . . . . . . . . . . . .
Distributing volumes evenly on DS8000 systems . . . . . . . . . . . . . .
Setting the multipath policy for DS8000 and Storwize Family systems . . . . . . .
Working with multiple storage systems. . . . . . . . . . . . . . . . . .
Upgrading or installing Spectrum Control Base with vSphere failover . . . . . . .
Creating a VVol-enabled service . . . . . . . . . . . . . . . . . . . .
Creating a VVol-enabled service on XIV storage systems . . . . . . . . . . .
Creating a VVol-enabled service on storage systems that run IBM Spectrum Virtualize .
Configuring an LDAP user for a managed domain . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
159
159
159
159
160
160
161
162
163
164
Chapter 12. RESTful API. . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
RESTful API protocol. . .
Query request and response
Create request and response
Delete request and response
Update request and response
Action request and response
Storage system operations .
Module operations . . .
Disk operations. . . . .
Interface operations . . .
Port operations . . . . .
Emergency shutdown . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
171
172
172
173
173
174
174
175
176
177
178
179
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Trademarks .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 182
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Contents
v
vi
IBM Spectrum Control Base Edition
Figures
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
Integration of IBM storage systems with a VMware environment . . . . . . . . . .
Using virtual volumes with IBM Spectrum Control Base Edition . . . . . . . . . .
Storage Policy Based Management (SPBM) concept. . . . . . . . . . . . . . .
Storage elements without VVol utilization . . . . . . . . . . . . . . . . . .
Storage elements with VVol utilization . . . . . . . . . . . . . . . . . . .
Spectrum Control Base version number . . . . . . . . . . . . . . . . . .
Spectrum Control Base login screen in a standard web browser . . . . . . . . . .
Spaces/Storage Services and Storage Systems panes . . . . . . . . . . . . . .
Interfaces and Spaces/Services panes . . . . . . . . . . . . . . . . . . .
Storage Systems and Monitoring panes . . . . . . . . . . . . . . . . . .
Initial setup wizard, defining HA group . . . . . . . . . . . . . . . . . .
Initial setup wizard, defining SSL certificate. . . . . . . . . . . . . . . . .
Initial setup wizard, defining storage system credentials . . . . . . . . . . . .
High-availability group concept . . . . . . . . . . . . . . . . . . . . .
General Settings option on the Settings menu . . . . . . . . . . . . . . . .
General Settings dialog box . . . . . . . . . . . . . . . . . . . . . .
Connection security warning in the Mozilla FireFox web browser . . . . . . . . .
Generate option on Server Certificate dialog box . . . . . . . . . . . . . . .
Upload files option on Server Certificate dialog box . . . . . . . . . . . . . .
Users option in the Setting menu . . . . . . . . . . . . . . . . . . . .
Add option in the Users dialog box . . . . . . . . . . . . . . . . . . .
Edit button in user account row. . . . . . . . . . . . . . . . . . . . .
Storage Systems pane . . . . . . . . . . . . . . . . . . . . . . . .
Settings button . . . . . . . . . . . . . . . . . . . . . . . . . .
Current storage system username (for all storage systems) . . . . . . . . . . . .
Add button . . . . . . . . . . . . . . . . . . . . . . . . . . .
Add New IBM Storage System dialog box . . . . . . . . . . . . . . . . .
Storage Systems pane, bar view . . . . . . . . . . . . . . . . . . . . .
Storage Systems pane, table view . . . . . . . . . . . . . . . . . . . .
Storage Systems pane with storage elements arranged according to descending space usage
Storage Systems pane with highlighted search string results . . . . . . . . . . .
Advanced filtering tool . . . . . . . . . . . . . . . . . . . . . . .
Storage Systems pane with storage elements filtered according to disk size . . . . . .
Array Settings dialog box . . . . . . . . . . . . . . . . . . . . . . .
VASA Credentials dialog box. . . . . . . . . . . . . . . . . . . . . .
Registered VASA servers (vCenter servers that employ VASA services). . . . . . . .
Spaces/Storage Services pane . . . . . . . . . . . . . . . . . . . . .
New Space dialog box . . . . . . . . . . . . . . . . . . . . . . . .
List of storage spaces . . . . . . . . . . . . . . . . . . . . . . . .
New Storage Service dialog box. . . . . . . . . . . . . . . . . . . . .
Add New Resource dialog box . . . . . . . . . . . . . . . . . . . . .
Storage Resources table . . . . . . . . . . . . . . . . . . . . . . .
Service Storage Resources table . . . . . . . . . . . . . . . . . . . . .
Resource Settings dialog box . . . . . . . . . . . . . . . . . . . . . .
Manage Resources dialog box . . . . . . . . . . . . . . . . . . . . .
Add vCenter Server for vWC dialog box . . . . . . . . . . . . . . . . . .
Interfaces pane . . . . . . . . . . . . . . . . . . . . . . . . . .
vCenter Server Settings dialog box . . . . . . . . . . . . . . . . . . . .
vCenter server with delegated service. . . . . . . . . . . . . . . . . . .
vRO server on the Interfaces pane . . . . . . . . . . . . . . . . . . . .
Download plug-in package button . . . . . . . . . . . . . . . . . . .
Current vRO Token . . . . . . . . . . . . . . . . . . . . . . . . .
Successful installation of IBM Storage plug-in for vRO . . . . . . . . . . . . .
Restarting vRO Server service . . . . . . . . . . . . . . . . . . . . .
Start Workflow: Set Server and Token dialog box . . . . . . . . . . . . . . .
© Copyright IBM Corp. 2013, 2016
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 4
. 6
. 7
. 8
. 9
. 17
. 30
. 31
. 31
. 32
. 34
. 35
. 36
. 37
. 37
. 38
. 39
. 40
. 41
. 42
. 43
. 44
. 45
. 46
. 46
. 47
. 48
. 48
. 49
. 50
. 50
. 51
. 51
. 52
. 53
. 54
. 55
. 56
. 57
. 58
. 61
. 63
. 64
. 65
. 66
. 67
. 68
. 69
. 70
. 72
. 73
. 73
. 74
. 74
. 75
vii
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
100.
101.
102.
103.
104.
105.
106.
107.
108.
109.
110.
111.
112.
113.
114.
115.
116.
viii
vRO server with delegated services . . . . . . . . . . . . . . . .
Monitoring pane . . . . . . . . . . . . . . . . . . . . . . .
Download PAK File button . . . . . . . . . . . . . . . . . . .
Deploying the management package on the vROps . . . . . . . . . . .
Adding the vROps server to Spectrum Control Base . . . . . . . . . . .
Storage system monitored by the vROps server . . . . . . . . . . . .
vSphere Web Client – Storage Providers list . . . . . . . . . . . . . .
New Storage Provider dialog box for VASA 2.0 . . . . . . . . . . . .
vCenter certificate thumbprint dialog box . . . . . . . . . . . . . .
Storage Providers list displaying Spectrum Control Base . . . . . . . . .
VMware vSphere Web Client – Create Role dialog box . . . . . . . . . .
IBM Storage categories in vSphere Web Client . . . . . . . . . . . . .
IBM Storage Service information . . . . . . . . . . . . . . . . .
IBM Storage Space information . . . . . . . . . . . . . . . . . .
IBM Storage Volume information . . . . . . . . . . . . . . . . .
IBM Storage VVol information . . . . . . . . . . . . . . . . . .
IBM Storage Service summary . . . . . . . . . . . . . . . . . .
IBM Storage Space summary . . . . . . . . . . . . . . . . . . .
IBM Storage Volume summary . . . . . . . . . . . . . . . . . .
IBM Storage VVol summary . . . . . . . . . . . . . . . . . . .
IBM storage service view – Clicking Create New Volume . . . . . . . . .
Top Level Objects view – Clicking Create a new IBM Storage volume . . . . .
Create New Volume wizard (XIV example) . . . . . . . . . . . . . .
Creating multiple volumes . . . . . . . . . . . . . . . . . . .
Selecting storage service . . . . . . . . . . . . . . . . . . . .
Advanced Host Mapping dialog box . . . . . . . . . . . . . . . .
Selecting LUN . . . . . . . . . . . . . . . . . . . . . . .
Clicking Extend on the pop-up menu . . . . . . . . . . . . . . .
Extend Volume dialog box . . . . . . . . . . . . . . . . . . .
Rename volume option . . . . . . . . . . . . . . . . . . . .
Rename Volume dialog box . . . . . . . . . . . . . . . . . . .
Set Multipath Policy Enforcement option . . . . . . . . . . . . . .
Change Multipath Policy Enforcement dialog box . . . . . . . . . . .
Unmap volume . . . . . . . . . . . . . . . . . . . . . . .
Delete volume . . . . . . . . . . . . . . . . . . . . . . .
VVol Summary tab. . . . . . . . . . . . . . . . . . . . . .
VVol Related Objects tab . . . . . . . . . . . . . . . . . . . .
vRealize Orchestrator – available workflows – General tab . . . . . . . .
vRealize Orchestrator – available objects . . . . . . . . . . . . . .
vROps GUI – IBM STORAGE option . . . . . . . . . . . . . . . .
IBM Spectrum Accelerate Storage Systems pane . . . . . . . . . . . .
IBM Spectrum Accelerate volume health status . . . . . . . . . . . .
Alert widget . . . . . . . . . . . . . . . . . . . . . . . .
Virtual Machines and XIV and vCenter Relations panes . . . . . . . . .
HEALTH TREE pane . . . . . . . . . . . . . . . . . . . . .
METRIC SELECTOR and METRIC GRAPH panes of the Performance dashboard .
IBM XIV Top 10 dashboards . . . . . . . . . . . . . . . . . .
Overview of an IBM FlashSystem A9000 flash canister . . . . . . . . . .
Add Symptom Definition dialog box. . . . . . . . . . . . . . . .
Adding name and description for alert definition . . . . . . . . . . .
Selecting base object type for alert definition . . . . . . . . . . . . .
Selecting impact for alert definition . . . . . . . . . . . . . . . .
Adding symptom for alert definition. . . . . . . . . . . . . . . .
Editing default monitoring policy . . . . . . . . . . . . . . . . .
Enabling KPI for a storage object metrics . . . . . . . . . . . . . .
Connection security warning in the Mozilla FireFox web browser . . . . . .
Controller GUI – Collect Log option . . . . . . . . . . . . . . . .
XIV role mapping attributes for directory (LDAP) users . . . . . . . . .
General tab, LDAP dialog box . . . . . . . . . . . . . . . . . .
User Credentials tab, LDAP dialog box . . . . . . . . . . . . . . .
Role Mapping tab, LDAP dialog box . . . . . . . . . . . . . . . .
IBM Spectrum Control Base Edition
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 76
. 78
. 79
. 80
. 81
. 82
. 84
. 84
. 85
. 85
. 88
. 89
. 90
. 90
. 91
. 91
. 92
. 92
. 93
. 94
. 95
. 95
. 96
. 97
. 97
. 98
. 99
. . . . . . . . . 100
. . . . . . . . . 100
. . . . . . . . . 101
. . . . . . . . . 101
. . . . . . . . . 102
. . . . . . . . . 103
. . . . . . . . . 104
. . . . . . . . . 105
. . . . . . . . . 106
. . . . . . . . . 106
. . . . . . . . . 110
. . . . . . . . . 111
. . . . . . . . . 114
. . . . . . . . . 116
. . . . . . . . . 117
. . . . . . . . . 118
. . . . . . . . . 119
. . . . . . . . . 119
. . . . . . . . . 120
. . . . . . . . . 127
. . . . . . . . . 128
. . . . . . . . . 129
. . . . . . . . . 129
. . . . . . . . . 130
. . . . . . . . . 130
. . . . . . . . . 131
. . . . . . . . . 132
. . . . . . . . . 132
. . . . . . . . . 140
. . . . . . . . . 154
. . . . . . . . . 155
. . . . . . . . . 165
. . . . . . . . . 166
. . . . . . . . . 166
117. Group configuration on Active Directory server .
118. User configuration on Active Directory server. .
119. Storage Credentials dialog box . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Figures
. 167
. 168
. 169
ix
x
IBM Spectrum Control Base Edition
Tables
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
Required tasks in sequential order . . . . . .
Optional tasks . . . . . . . . . . . .
Arguments for sc_ldap. . . . . . . . . .
ldap.ini configuration parameters . . . . . .
Spectrum Control Base GUI elements . . . . .
Service parameters . . . . . . . . . . .
Storage resource parameters . . . . . . . .
Required vSphere privileges . . . . . . . .
IBM storage objects and events in vRO . . . .
IBM Storage Icons in vROps . . . . . . .
Capacity metrics . . . . . . . . . . .
Health metrics . . . . . . . . . . . .
Counter metrics. . . . . . . . . . . .
Performance metrics . . . . . . . . . .
Configuration files . . . . . . . . . . .
Arguments for sc_users . . . . . . . . .
User-related arguments for sc_setting . . . .
Arguments for sc_ssl. . . . . . . . . .
Arguments for sc_storage_credentials. . . .
Arguments for sc_storage_array . . . . . .
Storage resource-related arguments for sc_setting
Arguments for sc_vasa_admin . . . . . . .
Arguments for sc_vrops_server . . . . . .
Arguments for sc_vrops_adapter . . . . . .
Arguments for sc_configuration . . . . . .
© Copyright IBM Corp. 2013, 2016
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 21
. 22
. 25
. 28
. 32
. 59
. 61
. 87
. 109
. 114
. 121
. 121
. 122
. 123
. 134
. 138
. 139
. 140
. 142
. 144
. 145
. 146
. 147
. 149
. 151
xi
xii
IBM Spectrum Control Base Edition
About this guide
This guide describes how to install, configure, and use IBM® Spectrum Control
Base Edition and its solution components.
Who should use this guide
This guide is intended for system administrators who are familiar with the
VMware vCenter and vSphere environments, and with the specific IBM storage
system that is in use.
Conventions used in this guide
These notices are used in this guide to highlight key information.
Note: These notices provide important tips, guidance, or advice.
Important: These notices provide information or advice that might help you avoid
inconvenient or difficult situations.
Attention: These notices indicate possible damage to programs, devices, or data.
An attention notice appears before the instruction or situation in which damage
can occur.
Related information and publications
You can find additional information and publications related to IBM Spectrum
Control Base on the following information sources.
v IBM Knowledge Center (ibm.com/support/knowledgecenter)
v IBM DS8000® on IBM Knowledge Center (ibm.com/support/knowledgecenter/
STUVMB)
v IBM DS8800 on IBM Knowledge Center (ibm.com/support/knowledgecenter/
STXN8P)
v IBM DS8870 on IBM Knowledge Center (ibm.com/support/knowledgecenter/
ST8NCA)
v IBM FlashSystem 900 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STKMQB)
v IBM SAN Volume Controller on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STPVGU)
v IBM Storwize® V3500 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STLM6B)
v IBM Storwize V3700 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STLM5A)
v IBM Storwize V5000 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STHGUJ)
v IBM Storwize V7000 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/ST3FR7)
© Copyright IBM Corp. 2013, 2016
xiii
v IBM Storwize V7000 Unified on IBM Knowledge Center (ibm.com/support/
knowledgecenter/ST5Q4U)
v IBM XIV® Storage System on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STJTAG)
v IBM Spectrum Accelerate on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STZSWD)
v IBM FlashSystem® A9000 on IBM Knowledge Center (ibm.com/support/
knowledgecenter/STJKMM)
v VMware Documentation (vmware.com/support/pubs)
v VMware Product Support (vmware.com/support)
v VMware Knowledge Base (kb.vmware.com)
Getting information, help, and service
If you need help, service, technical assistance, or want more information about IBM
products, you can find various sources to assist you. You can view the following
websites to get information about IBM products and services and to find the latest
technical information and support.
v IBM website (ibm.com®)
v IBM Support Portal website (www.ibm.com/storage/support)
v IBM Directory of Worldwide Contacts website (www.ibm.com/planetwide)
Use the Directory of Worldwide Contacts to find the appropriate phone number for
initiating voice call support. Voice calls arrive to Level 1 or Front Line Support.
Note: When contacting IBM Support, specify the storage system you are
managing, using Spectrum Control Base.
IBM Publications Center
The IBM Publications Center is a worldwide central repository for IBM product
publications and marketing material.
The IBM Publications Center website (ibm.com/shop/publications/order) offers
customized search functions to help you find the publications that you need. You
can view or download publications at no charge.
Sending or posting your comments
Your feedback is important in helping to provide the most accurate and highest
quality information.
Procedure
To submit any comments about this guide:
v Go to IBM Spectrum Control Base Edition on IBM Knowledge Center
(ibm.com/support/knowledgecenter/STWMS9), drill down to the relevant page,
and then click the Feedback link that is located at the bottom of the page.
xiv
IBM Spectrum Control Base Edition
The feedback form is displayed and you can use it to enter and submit your
comments privately.
v You can post a public comment on the Knowledge Center page that you are
viewing, by clicking Add Comment. For this option, you must first log in to
IBM Knowledge Center with your IBM ID.
v You can send your comments by email to starpubs@us.ibm.com. Be sure to
include the following information:
– Exact publication title and product version
– Publication form number (for example: SC01-0001-01)
– Page, table, or illustration numbers that you are commenting on
– A detailed description of any information that should be changed
Note: When you send information to IBM, you grant IBM a nonexclusive right
to use or distribute the information in any way it believes appropriate without
incurring any obligation to you.
About this guide
xv
xvi
IBM Spectrum Control Base Edition
Chapter 1. Introduction
IBM Spectrum Control Base Edition is a centralized cloud integration system that
consolidates a range of IBM storage provisioning, virtualization, cloud, automation,
and monitoring solutions through a unified server platform.
IBM Spectrum Control Base Edition provides a single-server backend location and
enables centralized management of IBM storage resources for different
virtualization and cloud platforms, including:
v VMware vCenter Server
v VMware vSphere Web Client (vWC)
v VMware vSphere APIs for Storage Awareness (VASA)
v VMware vRealize Operations Manager (vROps)
v VMware vRealize Orchestrator (vRO)
Through its user credential, storage system, storage space and service management
options, IBM Spectrum Control facilitates the integration of IBM storage system
resources with the supported virtualization and cloud platforms, while providing
the foundation for integration with future IBM systems and Independent Software
Vendor (ISV) solutions.
IBM Spectrum Control Base Edition can be managed through a standard web
browser and a graphical user interface (GUI), or through terminal and a
command-line interface (CLI).
Included cloud interfaces
The following cloud interfaces are included in the IBM Spectrum Control Base
Edition software package:
v IBM Storage Provider for VMware VASA
v IBM Storage Enhancements for VMware vSphere Web Client
v IBM Storage Plug-in for VMware vRealize Orchestrator
v IBM Storage Management Pack for VMware vRealize Operations Manager
IBM Storage Provider for VMware VASA
The IBM Storage Provider for VMware VASA improves the ability to monitor and
automate storage-related operations on VMware platforms.
From its Spectrum Control Base host, the IBM Storage Provider for VMware VASA
provides a standard interface for any connected VMware vCenter server using the
VMware vSphere APIs for Storage Awareness (VASA). It delivers information
about IBM storage topology, capabilities, and state, together with storage events
and alerts to vCenter server in real time. The storage capabilities are presented as a
combination of space and service, facilitating in provisioning volumes based on a
predefined set of storage capacities, as detailed in “Storage space and service
management” on page 7.
To visualize how this cloud interface is integrated in a virtualized environment, see
“Concept diagram” on page 3.
© Copyright IBM Corp. 2013, 2016
1
IBM Storage Enhancements for VMware vSphere Web Client
The IBM Storage Enhancements for VMware vSphere Web Client integrate into the
VMware vSphere Web Client platform and enable VMware administrators to
independently and centrally manage their storage resources on IBM storage
systems.
Depending on the IBM storage system in use, VMware administrators can
self-provision volumes (LUNs) in selected storage services that were predefined by
the storage administrators. The volumes are mapped to ESXi hosts, clusters, or
datacenters as logical drives that can be used for storing VMware datastores
(virtual machine data containers). See “Storage Policy Based Management (SPBM)”
on page 6 and “Storage space and service management” on page 7.
As opposed to the IBM Storage Management Console for VMware vCenter, which
is individually installed on each vCenter server, the IBM Storage Enhancements for
vSphere Web Client are installed only on the vSphere Web Client Server, allowing
multiple vCenter servers to utilize IBM storage resources. In addition, procedures
for attaching and detaching storage resources to the services are performed on the
Spectrum Control Base side, rather than on the vSphere Web Client side.
The IBM Storage Enhancements for VMware vSphere Web Client are automatically
deployed and enabled for each and every vCenter server that is registered for
vSphere Web Client services on the connected Spectrum Control Base.
To visualize how this cloud interface is integrated in a virtualized environment, see
“Concept diagram” on page 3.
IBM Storage Plug-in for VMware vRealize Orchestrator
The IBM Storage Plug-in for VMware vRealize Orchestrator allows VMware
administrators to include IBM storage discovery and provisioning in their vRealize
Orchestrator (vRO) automation workflows.
Note: In version 3.0.2, the IBM Storage Plug-in for VMware vRealize Orchestrator
does not support the DS8000 family storage systems.
The plug-in package can be downloaded from Spectrum Control Base and can then
be deployed on the vRealize Orchestrator server. The deployment includes the
matching of a unique token key that is set on both servers.
Through vRealize Orchestrator Client, dedicated IBM Storage control elements
become available, allowing the issuing of workflows with storage volumes that are
attached to the vRealize Orchestrator server.
Rather than issuing volume operations manually and being limited to one manual
operation at a time, VMware administrators can preplan and automate storage
operations in their virtualized cloud environments, either directly from vRealize
Orchestrator or through the VMware vCloud Automation Center (vCAC) platform.
To visualize how this cloud interface is integrated in a virtualized environment, see
“Concept diagram” on page 3.
2
IBM Spectrum Control Base Edition
IBM Storage Management Pack for VMware vRealize
Operations Manager
The IBM Storage Management Pack for VMware vRealize Operations Manager
allows Operations Manager users to obtain comprehensive monitoring information
about the IBM storage resources that are utilized in their virtualized environment.
Note: In version 3.0.2, the IBM Storage Management Pack for VMware vRealize
Operations Manager does not support the DS8000 family storage systems.
The management pack can be downloaded from Spectrum Control Base and can
then be deployed on the vRealize Operations Manager server.
After a VMware vRealize Operations Manager server is registered on Spectrum
Control Base that is configured with storage systems, storage spaces, services, and
vRealize servers, storage-related data is pushed to the Operations Manager server
every five minutes by default.
The dedicated IBM storage system adapter deployed on the vRealize Operations
Manager server enables monitoring the supported IBM storage system via the
vROps Manager. This adapter reports the storage-related information, such as
monitoring data of all logical and physical elements, covering storage systems,
storage domains, storage pools, volumes, hosts, modules, target ports, disks, health
status, events, thresholds, and performance. It also provides the dashboards that
display detailed status, statistics, metrics, and analytics data alongside hierarchical
flowcharts with graphic representation of IBM storage system elements.
Relationships between the IBM storage elements (storage systems, ports, storage
pools, volumes, host, host initiator, modules, domain) and datastores, virtual
machines, and hosts are displayed graphically in a drill-down style, providing
VMware administrators a complete and up-to-date picture of their utilized storage
resources.
To visualize how this cloud interface is integrated in a virtualized environment, see
“Concept diagram.”
Concept diagram
The following concept diagram illustrates how IBM storage systems are accessed
and utilized from the VMware environment through IBM Spectrum Control Base
Edition.
The storage administrator uses Spectrum Control Base to select which IBM storage
systems (arrays) and what storage resources should be available for use in the
VMware environment, and control which specific vCenter servers can utilize the
IBM storage resources.
Chapter 1. Introduction
3
Figure 1. Integration of IBM storage systems with a VMware environment
Spectrum Control Base allows registered VMware vCenter servers to utilize its
VASA functions, which can be monitored on the vSphere Web Client station.
In parallel, the following operations are enabled on the VMware environment side:
v Through vSphere Web Client, administrators can manually create, map, and
fully control storage volumes on the available storage systems and storage
resources.
v Through vRealize Orchestrator, administrators can issue workflows for
automating the same volumes operations that are available through vSphere
Web Client. The automation is run by the VMware vCloud Automation Center
(vCAC) platform.
v Through vRealize Operations Manager, administrators can obtain comprehensive
monitoring information about the IBM storage resources that are utilized in their
virtualized environment.
Note: New storage resources (pools) can be created in advance through the
dedicated storage system management tools or from Spectrum Control Base. New
resources cannot be added from the VMware environment.
Version 3.0.0 introduced a new storage provisioning method, which replaces
physical objects (pools and storage systems) with abstracted storage entities (spaces
and services), as detailed in “Storage Policy Based Management (SPBM)” on page 6
and “Storage space and service management” on page 7.
4
IBM Spectrum Control Base Edition
Virtual volumes
IBM Spectrum Control Base Edition delivers comprehensive storage virtualization
support that use VMware vSphere Virtual Volume (VVol) technology.
Note: The virtual volume technology is supported only by the IBM XIV (11.5.1 or
later) and storage systems that run IBM Spectrum Virtualize™ (7.6 or later).
The VVol architecture, introduced in VMware VASA 2.0, preserves the concept of a
traditional datastore, maintaining familiarity and compatibility with previous data
storage implementations. With VVol, the IBM storage systems become aware of
individual VMs, allowing data operations, such as snapshot and replication, to be
performed directly by the storage system at the VM level.
The storage system uses VASA provider to present VVols to the ESXi host and
inform the vCenter of the availability of VVol-aware storage. Storage services are
configured on VASA provider by the storage administrator and are used to manage
storage resources (pools) and VVols. The services represent storage capacity with a
set of attributes, such as encryption or provisioning type.
VVol usage improves system scalability, ensures granular management, leverages
hardware features and performance of storage systems at the VM level, providing
complete end-to-end cloud solution. An additional entity, a storage space, includes
one or more services, and can be assigned to different storage customers.
As illustrated below, the IBM Storage Provider for VMware VASA implements the
VMware Virtual Volume API, providing an out-of-band management bridge
between vSphere and the storage system. Out-of-band link separates the
management path from the data path, which connects the ESXi servers to the
virtual disks in a VVol datastore through a Protocol Endpoint (PE). Instead of
presenting a LUN to the hypervisor and allowing an ESXi host to perform data
operations, a storage system takes on itself a bulk of storage-related functions.
Chapter 1. Introduction
5
Figure 2. Using virtual volumes with IBM Spectrum Control Base Edition
For instructions about how to configure a VVol-enabled storage service, see
“Creating a VVol-enabled service” on page 161.
Storage Policy Based Management (SPBM)
IBM Spectrum Control Base Edition uses VMware vSphere Storage Policy Based
Management (SPBM) technology for optimizing the virtual machine provisioning
process.
Delivering only one service level, the traditional storage provisioning models fail
to match storage consumer needs with storage provider capabilities. This results in
misalignment between the system capacities and application requirements, leading
to over-provisioning and waste of IT resources.
The SPBM approach allows dynamic definition of storage policies with their
subsequent delivery on a per-VM basis. In this case, the storage consumer can pair
an application with existing storage policies and provision storage resources
exactly according to application requirements. Storage policies, referred to as
storage services in this user guide, combine storage capacity with a set of attributes
(encryption, provisioning type, etc.) to define storage spaces, which are used as
virtual datastores to suit requirements of a specific VM, as illustrated below.
6
IBM Spectrum Control Base Edition
Figure 3. Storage Policy Based Management (SPBM) concept
Note: The virtual volume functionality is supported only by the IBM XIV (11.5.1 or
later) and storage systems that run IBM Spectrum Virtualize (7.6 or later).
Storage space and service management
After deployment and storage system attachment, the IBM Spectrum Control Base
Edition administrators must define the new virtual entities, resulting in simpler
and more flexible storage management.
Note: The virtual volume functionality is supported by the IBM XIV (11.5.1 or
later) and storage systems that run IBM Spectrum Virtualize (7.6 or later).
The virtual storage entities include:
v Storage service – A combination of assigned storage resources (pools) and
user-defined policies (capabilities). The storage resources which are assigned to
the service may reside on any storage system, as illustrated below. The policies
are additional capabilities, or storage requirements for the service. They are
compression, encryption, etc.
v Storage space – A logical grouping of several storage services. Usually, a single
space is assigned to a specific organization (storage tenant).
Chapter 1. Introduction
7
Figure 4. Storage elements without VVol utilization
When the use of VMware virtual volumes (VVols) is enabled for a service, it is
assigned to a space which must reside on a single storage system (see drawing
below). Such system holds a storage resource (XIV group pool or child pool on
storage systems that run IBM Spectrum Virtualize) connected to the service.
For XIV storage systems, the storage resource consists of the following pools:
v Thin pool for thin provisioning.
v Thick pool for thick provisioning.
v Meta pool for holding VM-related management metadata.
Thus, in addition to its set of attributes (compression, encryption, etc), each service
receives a user-defined storage capacity.
8
IBM Spectrum Control Base Edition
Figure 5. Storage elements with VVol utilization
The combination of storage space and service is created by storage administrators
to include the required resource capacity and storage capabilities on a matching
storage system. Then the space/service combination is used by VMware
administrators for volume provisioning instead of physical objects.
Management options
IBM Spectrum Control Base Edition can be managed using the following methods:
v Graphical user interface (GUI).
v Command line interface (CLI).
Graphical user interface (GUI)
IBM Spectrum Control Base Edition includes a simple user-friendly web-based
graphical user interface (GUI) for storage management.
The Spectrum Control Base GUI simplifies storage provisioning, delivering a single
control instance for all available resources. The GUI has the following management
capabilities:
v Addition and management of the physical storage resources (storage systems
and pools).
v Creation and configuration of virtual storage entities (spaces and services).
v Integration with cloud interfaces (VMware VASA, vWC, vRO and vROps).
v User administration.
v Certificate management.
Command-line interface (CLI)
IBM Spectrum Control Base Edition can be managed via a command-line interface
(CLI).
Chapter 1. Introduction
9
The Spectrum Control Base CLI is used for user and storage system management,
as well as for integration of the cloud interfaces. However, the CLI application
scope is limited, and the use of the web-based graphical user interface (GUI) is
advised.
The CLI tool is supplied as a part of the Spectrum Control Base package. It can be
run locally from the Linux command prompt environment, or from a remote
terminal connection.
10
IBM Spectrum Control Base Edition
Chapter 2. Installation
Download and install IBM Spectrum Control Base Edition software package as
described in the following sections.
v “Compatibility and requirements”
v “Downloading IBM Spectrum Control Base Edition software”
v “Upgrading an existing installation” on page 14
v “Performing first-time installation” on page 12
v Installing IBM Spectrum Control Base in the shared environment
For information about uninstallation, see “Uninstalling the Spectrum Control Base
Edition software” on page 18.
Compatibility and requirements
For the complete and up-to-date information about the compatibility and
requirements of IBM Spectrum Control Base Edition, refer to its latest release notes.
You can find the latest release notes on IBM Knowledge Center
(www.ibm.com/support/knowledgecenter) or on IBM Fix Central
(www.ibm.com/support/fixcentral).
Note: Refer to the relevant VMware documentation for information about how to
install the compatible versions of vSphere Web Client Server. You should also refer
to the latest installation and configuration instructions for ESXi and vCenter
servers.
Downloading IBM Spectrum Control Base Edition software
IBM Spectrum Control Base Edition is available as a free software solution.
About this task
You can download the latest version of the Spectrum Control Base at any time
from the IBM Fix Central (www.ibm.com/support/fixcentral). Fix Central provides
fixes and updates for your systems software, hardware, and operating system. This
procedure describes how to locate the Spectrum Control Base package on the
website.
Procedure
To download the Spectrum Control Base software:
1. Go to the Spectrum Control Base welcome page on IBM Knowledge Center
(www.ibm.com/support/knowledgecenter/STWMS9).
2. Click Download the latest Spectrum Control package from IBM Fix Central.
The IBM Fix Central page for Spectrum Control Base is displayed.
3. Download the required software version.
© Copyright IBM Corp. 2013, 2016
11
Performing first-time installation
You can install the IBM Spectrum Control Base Edition software on a compatible
version of Red Hat Enterprise Linux (RHEL). For more information, refer to the
release notes.
Before you begin
v Verify that the following TCP ports are open to ensure network connectivity
between VMware resources, Spectrum Control Base and IBM storage systems:
– 8440 and 443 (vCenter, vROps and vRO servers). Refer to the installation
procedure below for details on opening the 8440 port for the 'iptables'(RHEL
6.x) or 'firewall-cmd' (RHEL 7.x). In addition, Spectrum Control Base must be
allowed to bind to port 8440, if Security-Enhanced Linux (SELinux) is
enabled.
– 7778 (XIV, Spectrum Accelerate, FlashSystem A9000/A9000R).
– 22 (storage systems that run IBM Spectrum Virtualize).
– 8452 (DS8000).
You can change the default TCP port (8440) at any time by running a script, as
explained in “Changing the Spectrum Control Base communication port” on page
136.
v Verify that the TCP ports 5672 and 4369 are open. These ports are used by the
'rabbitmq' and 'ampq' internal processes, respectively. Refer to the installation
procedure below for the port opening procedures.
v Make sure that the 'ibmsc' user can access the /opt/ibm and /var/log/sc folders.
v Check that the 'policycoreutils-python' package has been installed for RHEL
6.x.
v Check that the 'zlib' library has been installed for RHEL 7.x.
v Check that the 'bzip2' program has been installed for RHEL 6.x and RHEL 7.x.
v Verify that the 'postgresql' package is not installed on your host. Your server
may have a package of 'postgresql' version 8 installed, as a part of operation
system distribution. This may result in a conflict with version of the package,
installed during the Spectrum Control Base deployment. Use the >> rpm -qa |
grep postgres command to search for the 'postgresql' package.
Procedure
Follow these steps to install Spectrum Control Base:
1. Open the 8440 TCP port:
v RHEL 6.x:
– iptables -I OUTPUT -p tcp --dport 8440 -j ACCEPT
– iptables -I INPUT -p tcp --dport 8440 -j ACCEPT
– service iptables save
– service iptables restart
v RHEL 7.x:
– firewall-cmd --permanent --add-port=8440/tcp
– firewall-cmd --reload
2. If you are using SELinux, allow Spectrum Control Base to bind to the 8440
TCP port:
12
IBM Spectrum Control Base Edition
v RHEL 6.x: semanage port -a -t http_port_t -p tcp 8440
v RHEL 7.x: setsebool -P nis_enabled 1
3. Open the 5672 and 4369 TCP ports under RHEL 7.x:
v firewall-cmd --permanent --zone=trusted --add-interface=lo
v firewall-cmd --permanent --zone=trusted --add-port=5672/tcp
v firewall-cmd --permanent --zone=trusted --add-port=4369/tcp:
4. Download the installation package and the
IBM_Spectrum_Control_Signing_Key_Pub.key file, used for the package
validation. See “Downloading IBM Spectrum Control Base Edition software”
on page 11).
5. Copy the installation package and the public key files to a local folder on the
Linux host that will be used as Spectrum Control Base.
6. Go to the local folder and then use the gpg --import
IBM_Spectrum_Control_Signing_Key_Pub.key to import the IBM GNU Privacy
Guard (GPG) public key to validate the installation files. This ensures that the
files were received from IBM and were not manipulated in any way by a third
party.
Note: Downloading the install package from a trusted, SSL-protected resource,
such as Fix Central, ensures its authenticity and integrity. However, you can mark
the key as trusted by entering gpg --edit-key "IBM Spectrum Control Signing
Key", typing the trust command and selecting option 5.
7. Extract the installation package file ('* ' represents the build number) :
# tar -xzvf IBM_Spectrum_Control_Base_Edition-3.0.2-*-x86_64.tar.gz
Depending on the RHEL version, the following files are extracted:
v RHEL 6.x:
– erlang-18.1-1.el6.x86_64.rpm
– nginx-1.8.0-1.el6.ngx.x86_64.rpm
– postgresql92-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-contrib-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-libs-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-server-9.2.14-1PGDG.rhel6.x86_64.rpm
– rabbitmq-server-3.6.0-1.noarch.rpm
– uuid-1.6.1-10.el6.x86_64.rpm
– ibm_spectrum_control-3.0.2-*.bin – product BIN file.
– ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc– digital signature file
for the BIN file verification.
v RHEL 7.x:
– erlang-18.1-1.el7.centos.x86_64.rpm
– nginx-1.8.0-1.el7.ngx.x86_64.rpm
– postgresql92-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-contrib-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-libs-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-server-9.2.14-1PGDG.rhel7.x86_64.rpm
– rabbitmq-server-3.6.0-1.noarch.rpm
Chapter 2. Installation
13
– uuid-1.6.2-26.el7.x86_64.rpm
– ibm_spectrum_control-3.0.2-*.bin – product BIN file.
– ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc– digital signature file
for the BIN file verification.
8. Enter # gpg --verify ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc
ibm_spectrum_control-3.0.2-xxxx-x86_64.bin to verify the digital signature
of the installation files.
9. Go to the extracted directory and then use the rpm -iv *.rpm command to run
and install all the complementary RPM files. The IBM Storage Provider service
starts automatically after the installation (for more information, see “Checking
and controlling the Spectrum Control Base service” on page 133) and a new
Linux username – ibmsc – is created so that you can use it for the Spectrum
Control Base management operations.
Note: If needed, you can customize the user ID for ibmsc by adding a Linux user
(useradd command in RHEL) prior to the package installation.
10. Enter chmod +x ibm_spectrum_control-3.0.2-*.bin to authorize the
installation of the product BIN file.
11. Enter ./ibm_spectrum_control-3.0.2-*.bin to start the installation.
12. Review the license agreement which is displayed after you run the installation
file.
13. Enter 1 to accept the license agreement and complete the installation:
Press Enter to continue viewing the license agreement, or enter "1" to accept
the agreement, "2" to decline it, "3" to print it, "4" to read non-IBM terms,
or "99" to go back.
1
Preparing for new installation...
Creating system user ibmsc...
Configuring rsyslog...
Setting up nginx...
Generating SSL certificate...
Configuring postgresql database...
Creating IBM Spectrum Control user...
Configuring IBM Spectrum Control...
Adding iptables rules...
Starting Celery services... [OK]
Starting Django service... [OK]
NOTE: An initial username ’admin’ with an initial password ’admin1!’
has been defined for the initial access (via the CLI or GUI) to the
IBM Spectrum Control.
IMPORTANT: To avoid unauthorized access to the IBM Spectrum Control,
the password for this username should be changed as soon as possible.
You can control IBM Spectrum Control services using the
’service ibm_spectrum_control {start|stop|status}’ command.
Installation completed successfully.
14. To avoid unauthorized access to Spectrum Control Base via GUI, it is strongly
recommended to change the default password for the 'admin' user as soon as
possible, as described in “Changing the password of a Spectrum Control Base
user” on page 43.
Upgrading an existing installation
If you are already using earlier releases of IBM Spectrum Control Base Edition, you
can upgrade to the newer version without having to uninstall the previous one.
14
IBM Spectrum Control Base Edition
Before you begin
v If needed, back up the current Integration Server or Spectrum Control Base
database, by entering one of the following commands:
– isis_configuration backup -f /var/tmp/backup -k <key value> for IBM
Storage Integration Server
– sc_configuration backup -f /var/tmp/backup -k <key value> for IBM
Spectrum Control Base Edition
v Verify that the following communication ports are open to ensure network
connectivity between VMware resources, Spectrum Control Base and IBM
storage systems:
– 8443 and 443 (vCenter, vROps and vRO servers)
– 7778 (XIV, Spectrum Accelerate, FlashSystem A9000/A9000R)
– 22 (storage systems that run IBM Spectrum Virtualize)
– 8452 (DS8000)
Note: The 8443 port remains open after the Spectrum Control Base upgrade. If you
install the software package anew, the 8440 port is used. You can change the
default TCP port at any time by running a script, as explained in “Changing the
Spectrum Control Base communication port” on page 136. Moreover, certain
upgrade scenarios, such as using SELinux, may require additional configuration
steps, as detailed in “Performing first-time installation” on page 12.
v Make sure that the 'ibmsc' user can access the /opt/ibm and /var/log/sc folders.
Procedure
Perform the following procedure to upgrade Spectrum Control Base:
1. Log out of the Spectrum Control Base GUI and close the browser.
2. On the Spectrum Control Base side: download the newer installation package
and the IBM_Spectrum_Control_Signing_Key_Pub.key file, used for the package
validation. See “Downloading IBM Spectrum Control Base Edition software”
on page 11).
3. Copy the installation package and the public key files to a local folder on a
current Spectrum Control Base server.
4. Go to the local folder and then use the gpg --import
IBM_Spectrum_Control_Signing_Key_Pub.key to import the IBM GNU Privacy
Guard (GPG) public key to validate the installation files. This ensures that the
files were received from IBM and were not manipulated in any way by a third
party.
Note: Downloading the install package from a trusted, SSL-protected resource,
such as Fix Central, ensures its authenticity and integrity. However, you can mark
the key as trusted by entering gpg --edit-key "IBM Spectrum Control Signing
Key", typing the trust command and selecting option 5.
5. Extract the installation package file ('* ' represents the build number) :
# tar -xzvf IBM_Spectrum_Control_Base_Edition-3.0.2-*-x86_64.tar.gz
Depending on the RHEL version, the following files are extracted:
v RHEL 6.x:
– erlang-18.1-1.el6.x86_64.rpm
Chapter 2. Installation
15
– nginx-1.8.0-1.el6.ngx.x86_64.rpm
– postgresql92-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-contrib-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-libs-9.2.14-1PGDG.rhel6.x86_64.rpm
– postgresql92-server-9.2.14-1PGDG.rhel6.x86_64.rpm
– rabbitmq-server-3.6.0-1.noarch.rpm
– uuid-1.6.1-10.el6.x86_64.rpm
– ibm_spectrum_control-3.0.2-*.bin – product BIN file.
– ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc– digital signature file
for the BIN file verification.
v RHEL 7.x:
– erlang-18.1-1.el7.centos.x86_64.rpm
– nginx-1.8.0-1.el7.ngx.x86_64.rpm
– postgresql92-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-contrib-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-libs-9.2.14-1PGDG.rhel7.x86_64.rpm
– postgresql92-server-9.2.14-1PGDG.rhel7.x86_64.rpm
– rabbitmq-server-3.6.0-1.noarch.rpm
– uuid-1.6.2-26.el7.x86_64.rpm
– ibm_spectrum_control-3.0.2-*.bin – product BIN file.
– ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc– digital signature file
for the BIN file verification.
6. Enter # gpg --verify ibm_spectrum_control-3.0.2-xxxx-x86_64.bin.asc
ibm_spectrum_control-3.0.2-xxxx-x86_64.bin to verify the digital signature
of the installation files.
7. Go to the extracted directory and then use the rpm -U *.rpm command to run
and install all the complementary RPM files.
8. Enter chmod +x ibm_spectrum_control-3.0.2-*.bin to authorize the
installation of the product BIN file.
9. Enter ./ibm_spectrum_control-3.0.2-*.bin to start the upgrade.
Note: During the upgrade:
v The ibm_storage_integration_server service and other related services are
stopped and the new service ibm_spectrum_control starts automatically after the
installation (for more information, see “Checking and controlling the Spectrum
Control Base service” on page 133).
v The following entities are renamed:
– Username isis to ibmsc. The user ID is preserved. The upgrade may fail, if
you create a new user (ibmsc) in the system prior to the procedure. This
occurs because the user ID is already stored in the operating system database.
– Group name isis to ibmsc. The group ID is preserved.
– Log directory name /var/log/isis to /var/log/sc
– User home directory name /home/isis to /home/ibmsc
v Several configuration files are overwritten by newer versions (as illustrated by
the screen output below). If these files were changed in the previous versions,
you must apply the same changes to the new files, if you want to preserve the
settings.
16
IBM Spectrum Control Base Edition
10. Review the license agreement which is displayed after you run the installation
file.
11. Enter 1 to accept the license agreement and complete the installation:
Press Enter to continue viewing the license agreement, or enter "1" to accept
the agreement, "2" to decline it, "3" to print it, "4" to read non-IBM terms,
or "99" to go back.
1
Preparing to upgrade [ibm_storage_integration_server] to the new [ibm_spectrum_control]
Stopping service ibm_storage_integration_server...
Renaming old user isis to ibmsc
Renaming old group isis to ibmsc
Upgrading [ibm_storage_integration_server] to the new [ibm_spectrum_control]
Moving rpm configuration files to IBM Spectrum Control
3 configuration files replaced by newer versions. The original files moved to:
/opt/ibm/ibm_spectrum_control/conf.d/ibmsyslog.conf.saverpm
/opt/ibm/ibm_spectrum_control/conf.d/nginx/sc_nginx.conf.saverpm
/opt/ibm/ibm_spectrum_control/conf.d/vasa1/vasa_config.ini.saverpm
Moving Django key to IBM Spectrum Control
Moving SSL Certificate to IBM Spectrum Control
Configuring rsyslog
Setting up nginx
Migrating database to IBM Spectrum Control
Configuring new service [ibm_spectrum_control]
Update SC_UUID
Upgrading the extension of all registered vCenter servers...
Adding a default vCO server instance...
Starting Celery services ... [OK]
Starting Django service ... [OK]
Unconfiguring old service [ibm_storage_integration_server]
Installation completed successfully.
12. Log in (see “Logging in” on page 29) and click Settings > About to verify that
the Spectrum Control Base version number has been updated.
Figure 6. Spectrum Control Base version number
13. To avoid unauthorized access to Spectrum Control Base via GUI, it is strongly
recommended to change the default password for the 'admin' user as soon as
Chapter 2. Installation
17
possible, as described in “Changing the password of a Spectrum Control Base
user” on page 43. After the upgrade, Spectrum Control Base:
v Adds a service for each existing storage resource (pool) that was connected
to a vCenter or a vRO server. The new services are placed under default
storage space. See “Managing storage spaces and services” on page 54 for
details on how to configure storage spaces and services.
v With the Spectrum Control Base update, the IBM Storage Enhancements for
VMware vSphere Web Client is upgraded automatically for all connected
vCenter servers. However, the following components must be updated
manually:
– IBM Storage Plug-in for VMware vRealize Orchestrator. See “Managing
integration with vRealize Orchestrator” on page 71.
– IBM Storage Management Pack for VMware vRealize Operations
Manager. See “Managing integration with vRealize Operations Manager”
on page 77.
– Registration of Spectrum Control Base as a VASA storage provider on the
vCenter server. Re-register Spectrum Control Base, as detailed in
“Registering Spectrum Control Base as a storage provider on vCenter
server” on page 83.
What to do next
To ensure proper transition from the physical to abstracted storage provisioning,
perform the following:
v When upgrading from version 2.x to version 3.x, restart the vSphere Web Client
via the vCenter administration panel, after the upgrade is completed.
v For VMware vRealize Orchestrator, run configuration workflow, as detailed in
“Downloading and installing the plug-in package for vRO” on page 72. Then
use relevant workflows for new storage objects (space, service, volume), as
explained in Chapter 6, “Using the IBM Storage Plug-in for VMware vRealize
Orchestrator,” on page 109.
v For VASA 1.0 and VASA 2.0 (VVols), update VM storage policy and select
storage services instead of capabilities, when setting requirements for the storage
resources.
Uninstalling the Spectrum Control Base Edition software
If you want to completely remove the IBM Spectrum Control Base Edition software
from the Linux host upon which it is installed, follow the steps in the following
procedure.
18
IBM Spectrum Control Base Edition
Before you begin
Important:
v Before removing Spectrum Control Base software, remove all vCenter servers
that were registered for vSphere Web Client, as explained in “Removing a
vCenter server” on page 69. If any vCenter server is not removed prior to the
uninstallation, the IBM Storage Enhancements will remain visible but not
functional for that vCenter server.
v To avoid loss of user accounts, credentials, storage system configurations,
storage pool attachments, and vCenter server associations – always back up the
Spectrum Control Base configuration before any uninstallation.
v Uninstalling the software on the Spectrum Control Base side causes the
following features to cease functioning:
– All CLI and GUI management options on the Spectrum Control Base side.
– IBM Storage Enhancements on the vSphere Web Client side.
– VASA-related operations on the vCenter server side.
Procedure
To uninstall the Spectrum Control Base software from the Linux host:
1. Log on to the Linux command prompt environment as a root user.
2. Stop the Spectrum Control Base service, as explained in “Checking and
controlling the Spectrum Control Base service” on page 133.
3. Run the standard Linux uninstallation command for each installed package (as
detailed in “Performing first-time installation” on page 12).
Chapter 2. Installation
19
20
IBM Spectrum Control Base Edition
Chapter 3. Operation and management
This chapter describes the initial operation tasks, as well as the full range of
management options that are available on IBM Spectrum Control Base Edition.
v “Required and optional initial tasks”
v “Configuring LDAP-based directory user access” on page 23
Required and optional initial tasks
After IBM Spectrum Control Base Edition is installed, different tasks are required
before the server can become fully operational.
Refer to the following tables for information about the required and optional
management tasks.
Note: Unless specified otherwise in the 'Management method' column, you can
initiate tasks from either the graphical user interface (GUI) or command-line
interface (CLI) .
Table 1. Required tasks in sequential order
Management Relevant cloud
method
interface
Step
Required task
1.
Set a password for
the 'ibmsc' user if
necessary (a Linux
root user action),
and then switch to
the 'ibmsc' user.
CLI
All
v “CLI – Switching to 'IBMSC' user
mode” on page 137
2.
Run initial setup to
define
high-availablity
groups, add SSL
certificate and set
storage system
credentials. If you
complete the initial
setup, you can skip
steps 4–6 below.
GUI
All
v “Running initial setup” on page 33
3.
Log in to the GUI
GUI
and then change the
password of the
initial admin user.
All
v “Logging in” on page 29
4.
Define a
high-availability
group
GUI
IBM Storage Provider
for VMware VASA
v “Managing high-availability
groups” on page 36
5.
Add SSL certificate
for the Spectrum
Control Base server
CLI or GUI
All
v “CLI – Managing server
certificates” on page 139
© Copyright IBM Corp. 2013, 2016
Refer to
v “Changing the password of a
Spectrum Control Base user” on
page 43
v “Managing server certificates” on
page 39
21
Table 1. Required tasks in sequential order (continued)
Step
Required task
6.
Add the storage
system access
credentials
Management Relevant cloud
method
interface
CLI or GUI
All
Refer to
v “CLI – Adding or removing
storage system credentials” on
page 141
v “Entering the storage system
credentials” on page 45
7.
Add the storage
systems to be used
CLI or GUI
All
v “CLI – Managing storage systems”
on page 143
v “Adding a storage system” on
page 47
Table 2. Optional tasks
Management Relevant cloud
method
interface
Step
Optional task
1.
Set the VASA access
credentials ("VASA
Secret") to allow
connection of
vCenter servers that
require VASA
functions.
CLI or GUI
Define storage
spaces and services.
GUI
2.
IBM Storage Provider
for VMware VASA
Refer to
v “CLI – Setting the VASA
credentials” on page 145
v “Setting the VASA credentials” on
page 53
v IBM Storage
Enhancements for
VMware vSphere
Web Client
v “Adding a storage space” on page
56
v IBM Storage Plug-in
for VMware vRealize
Orchestrator
v “Defining and attaching storage
resources” on page 60
v “Adding a storage service” on
page 57
v IBM Storage Provider
for VMware VASA
3.
Add vCenter
servers.
CLI or GUI
IBM Storage
Enhancements for
VMware vSphere Web
Client
v “Adding a vCenter server” on
page 66
4.
If you want to use
CLI or GUI
vWC plug-in for
managing volumes
created on storage
resources attached
to specific services,
delegate the services
to the previously
added vCenter
servers.
IBM Storage
Enhancements for
VMware vSphere Web
Client
v “Delegating storage services to a
vCenter server” on page 69
5.
Establish integration GUI
with vRealize
Orchestrator (vRO).
Note: Not
applicable for the
DS8000 family
storage systems.
IBM Storage Plug-in for v “Managing integration with
VMware vRealize
vRealize Orchestrator” on page 71
Orchestrator
22
IBM Spectrum Control Base Edition
Table 2. Optional tasks (continued)
Management Relevant cloud
method
interface
Step
Optional task
6.
Delegate storage
services to the
previously added
vRO server.
Note: Not
applicable for the
DS8000 family
storage systems.
7.
Establish integration CLI or GUI
with vRealize
Operations Manager
(vROps).
Note: Not
applicable for the
DS8000 family
storage systems.
IBM Storage
Management Pack for
VMware vRealize
Operations Manager
v “CLI – Managing integration with
vRealize Operations Manager” on
page 146
8.
Configure
CLI
LDAP-based
directory user access
to Spectrum Control
Base.
-
v “Configuring LDAP-based
directory user access”
9.
Manage the
Spectrum Control
Base users.
-
v “CLI – Managing Spectrum
Control Base users” on page 138
10.
GUI
CLI
Back up or restore a CLI
Spectrum Control
Base configuration,
including the data of
all existing user
accounts,
credentials, storage
systems, and storage
resources.
Refer to
IBM Storage Plug-in for v “Managing integration with
VMware vRealize
vRealize Orchestrator” on page 71
Orchestrator
v “Managing integration with
vRealize Operations Manager” on
page 77
v “Managing Spectrum Control Base
users” on page 41
-
v “CLI – Backing up or restoring a
Spectrum Control Base
configuration” on page 150
Configuring LDAP-based directory user access
You can allow external directory users to connect to Spectrum Control Base and
manage it without having a locally-defined user account.
The connection to the directory server is established through Lightweight Directory
Access Protocol (LDAP) authentication. When directory server access is enabled,
any login attempt (attempt to log in to Spectrum Control Base) is authenticated
against the defined directory server.
Use the sc_ldap CLI command to configure LDAP-based directory user access to
Spectrum Control Base. Use the required argument after the command, as specified
in the following table.
Chapter 3. Operation and management
23
Note:
v When directory user access is enabled and configured through sc_ldap, the
directory users can access and manage only Spectrum Control Base. A separate
and unrelated authentication system may be used on the storage system side for
directory-based management of the storage system. For more information, refer
to “CLI – Adding or removing storage system credentials” on page 141 and to
your storage system documentation.
v Once the connection is established, all users that are defined on the directory
server can access and manage Spectrum Control Base.
24
IBM Spectrum Control Base Edition
Table 3. Arguments for sc_ldap
Argument
Use after sc_ldap to:
configure -e -a
Enable directory access and establish a connection to a directory
server as an anonymous user with the following parameters
specified after the -a argument on the command line:
-s <server URI>
-t <directory server type>
-r <user search DN>
-k <user search key>
-g <user group DN>
-o <user group object class
-n <user group authentication DN>
or
v Server URI (-s; --server_uri) – Uniform resource identifier
(URI) of the directory server. This parameter determines
which directory server should be accessed and used for
directory user management of Spectrum Control Base.
v Server type (-t; --server_type) – Type of the directory server.
One of the following types can be specified:
– Active Directory (ACTIVE_DIRECTORY)
– Open LDAP (OPEN_LDAP)
– Custom (CUSTOM)
v User search DN (-r; --user_search_dn) – Distinguished name
(DN) to be used for the user search.
--server_uri <server URI>
v User search key (-k; --user_search_key) – Search key of the
directory user. Valid only if the specified server type (-t;
--server_type) is CUSTOM.
--server_type <directory server type>
v Group search DN (-g; --group_search_dn) – Distinguished
name (DN) of the user group for search purposes.
configure --enable --anonymous
--user_search_dn <user search DN>
--user_search_key <user search key>
--group_search_dn <user group DN>
--group_object_class <user group object
class>
--authentication_group_dn <user group
authentication DN>
v Group object class (-o; --group_object_class) – Object class
of the user group. Valid only if the specified server type (-t;
--server_type) is CUSTOM.
v Authentication group DN (-n; --authentication_group_dn) –
Distinguished name (DN) used for the user group
authentication.
For example:
sc_ldap configure -e -a -s ldap://ad1.ibm.com
-t ACTIVE_DIRECTORY -r "CN=Users,DC=mydomain,DC=test,DC=com"
-g "CN=sc_TestGrp,CN=Users,DC=mydomain,DC=test,DC=com"
-n "CN=sc_TestGrp,CN=Users,DC=mydomain,DC=test,DC=com"
When prompted to enter a password, press Enter without
entering any password:
Please enter the BIND_DN password (password not shown):
The following changes were applied to the LDAP configuration:
ENABLED
Please restart the IBM Spectrum Control to apply
the new configuration.
After enabling the directory access, you can test the directory
connection by using the test option (see below). Then, restart
the Spectrum Control Base service as explained in “Checking
and controlling the Spectrum Control Base service” on page 133.
Chapter 3. Operation and management
25
Table 3. Arguments for sc_ldap (continued)
Argument
Use after sc_ldap to:
configure -e -u <Bind DN username>
Enable directory access and establish a connection to a directory
server by using the Bind DN user account that was predefined
on the directory server (predefined by the directory server
administrator). For this command, specify these two parameters
in addition to the entries listed for the anonymous user:
-p <Bind DN password>
v Bind DN username (-u; --bind_dn) – Username of the Bind
DN user through which access to the directory server is
established. Spectrum Control Base uses this username to log
in to the directory server and establish the connection with it.
v Bind DN password (-p; --bind_password) – Password of the
Bind DN username.
For example:
sc_ldap configure -e -s ldap://myad1.ibm.com
-t ACTIVE_DIRECTORY -r "CN=Users,DC=sc,DC=test,DC=com"
-g "CN=Users,DC=sc,DC=test,DC=com"
-n "CN=SC_TestGrp,CN=Users,DC=sc,DC=test,DC=com"
-u mybinduser -p mypassw0rd
When prompted to enter a password, enter the directory server's
Bind DN user password:
Please enter the BIND_DN password (password not shown): ******
The following changes were applied to the LDAP configuration:
ENABLED
Please restart the IBM Spectrum Control to apply
the new configuration.
configure -d
Disable directory user access.
or
After disabling the directory access, restart the Spectrum Control
Base service as explained in “Checking and controlling the
Spectrum Control Base service” on page 133.
configure --disable
list
Display the current directory server configuration status (on
Spectrum Control Base) and Bind DN username.
test -u <directory username> -p <password>
Test a directory user account by specifying the username and
password of that account. You can test any user account that is
defined on the directory server (the test is not for the Bind DN
user account, but for an actual directory account).
For example:
sc_ldap test -u mytestuser -p mytestuserpassw0rd
IBM Spectrum Control LDAP configuration has been verified
successfully.
-h
Display help information that is relevant to sc_ldap.
or --help
You can also display help for the configure, list, or test
argument if it is typed on the command line as well.
26
IBM Spectrum Control Base Edition
Adding a directory server certificate
If the directory server uses Transport Layer Security (TLS), you must edit the
ldap.conf file and specify the trusted certificate directory location and filename on
Spectrum Control Base. Complete the following steps to update Spectrum Control
Base:
1. Log in to the directory server and issue the following command: certutil
-ca.cert client.crt. This command generates the server certificate.
2. Go to the /etc/openldap/ directory and edit the ldap.conf file by setting the
value for the TLS_CACERT parameter. The following example shows the contents
of the ldap.conf file:
#LDAP Defaults
#
#BASE
dc=example,dc=com
#URI
ldap://ldap.example.com ldap://ldap-master.example.com:port#
#SIZELIMIT
12
#TIMELIMIT
15
#DEREF
never
TLS_CACERT /etc/openldap/certs/trusted_ldap.pem
Make sure that the TLS_CACERT parameter has the directory and file name of the
new certificate that you generated. After editing the ldap.conf file, the
ldap.ini file is automatically updated.
Editing the ldap.ini configuration file
In addition to using the sc_ldap CLI command (see Table 3 on page 25), you can
edit the ldap.ini configuration file to manually change the directory user access
settings.
Attention:
v Do not edit the ldap.ini file if you are not familiar with directory setting
conventions.
v Restart Spectrum Control Base after editing the ldap.ini file to apply the
changes.
The following example shows the editable parameters and their values specified
after the '=' sign:
enable_ldap = True
server_uri = ldap://servername.domainname:389
server_type = OPEN_LDAP
user_search_dn = ou=users,dc=dcname,dc=com
user_search_key =
group_search_dn = dc=dcname,dc=com
group_object_class =
authentication_group_dn = cn=authenticating-group,dc=dcname,dc=com
bind_dn =
bind_password = <enctypted password>=
bind_pwd_verification = <encrypted key>=
The following table summarizes the parameters and their indication. Refer to
Table 3 on page 25 for more detailed information.
Chapter 3. Operation and management
27
Table 4. ldap.ini configuration parameters
Parameter
Indication
enable_ldap
True or False.
When True and enabled, the login attempt is
authenticated against the directory server.
server_uri
Uniform resource identifier (URI) of the directory
server.
server_type
Type of the directory server:
v Active Directory
v Open LDAP
v Custom
user_search_dn
Distinguished name (DN) to be used for user
search.
user_search_key
Search tag for obtaining a unique relative
distinguished name (RDN).
Commonly used values: uid, preferredId
group_search_dn
Distinguished name (DN) to be used for user
group search.
group_object_class
Type of the user group.
Commonly used values: GroupOfNames,
NestedGroupOfNames, GroupOfUniqueNames,
NestedGroupOfUniqueNames, ActiveDirectoryGroup,
NestedActiveDirectoryGroup
28
authentication_group_dn
Distinguished name (DN) of the authentication
user group.
bind_dn
Username of the Bind DN user through which
access to the directory server is established.
bind_password
Password of the Bind DN username. The
password is displayed in its encrypted form.
bind_pwd_verification
Verification string for the Bind DN password. The
string is displayed in its encrypted form.
IBM Spectrum Control Base Edition
Note:
v user_search_key and user_search_dn return unique results. For example:
user_search_key=uid
user_search_dn=ou=users,dc=dcname,dc=com
In this case, if the user name is "John", the resulting DN for matching the user
over LDAP would be: uid=John,ou=users,dc=dcname,dc=com
v If authentication_group_dn is set, only users that belong to that group are
authenticated. You can remove this parameter from the ldap.ini file to disable
group authentication.
v When server_type type is Active Directory, the following parameters are used
by default:
user search key = sAMAccountName
user group object class = ActiveDirectoryGroup
v When server_type type is Open LDAP, the following parameters are used by
default:
user search key = uid
user group object class = GroupOfUniqueNames
v You can use a valid username and password (defined on the LDAP server) with
the sc_ldap test command to test your LDAP configuration.
Logging in
To log in to Spectrum Control Base from a browser, you need to enter the web
address (URL) of the Linux host upon which Spectrum Control Base is installed.
Procedure
Use the following login method to start working with IBM Spectrum Control Base
Edition:
1. Enter the web address (URL) of the Linux host upon which Spectrum Control
Base is installed. Use the following format https://[Spectrum Control Base IP
address]:8440.
You can change the default TCP port (8440) at any time by running a script, as
explained in “Changing the Spectrum Control Base communication port” on page
136.
If your web browser displays a connection security message after entering the
web address, see “Managing server certificates” on page 39.
The Spectrum Control Base login page is loaded .
Chapter 3. Operation and management
29
Figure 7. Spectrum Control Base login screen in a standard web browser
2. Log in by entering your Spectrum Control Base username and password.
Attention:
v After the instillation, the initial username is admin and the initial password is
admin1!. To avoid unauthorized access to Spectrum Control Base, it is strongly
recommended to change this password as soon as possible, or create a new user
account and then delete the admin account (see “Managing Spectrum Control
Base users” on page 41).
v If the Spectrum Control Base service is stopped on the Linux host (see
“Checking and controlling the Spectrum Control Base service” on page 133), it is
not possible to log in or perform any GUI operation.
What to do next
After successful login, complete the initial setup wizard, which includes the
following mandatory configuration steps:
v Setting up a high-availability group.
v Providing SSL certificate.
v Defining storage system credentials.
Spectrum Control Base GUI
The IBM Spectrum Control Base Edition GUI provides an intuitive easy-to-use
browser-based interface for managing IBM storage resources.
The Spectrum Control Base GUI consists of the four panes:
v Interfaces – integration with vCenter and vRO servers.
v Spaces/Storage Services – handling storage spaces and services.
v Storage Systems – management of storage systems and storage resources.
v Monitoring integration with vROps server.
30
IBM Spectrum Control Base Edition
After successful login, the Spaces/Storage Services and Storage Systems panes are
displayed.
Figure 8. Spaces/Storage Services and Storage Systems panes
Click Interfaces on the left of the screen to go to the Interfaces pane, or click
Monitoring on the right to display the Monitoring pane. When the Interfaces pane
is displayed, click Allocation to return to the initial view (Spaces/Storage Services
and Storage Systems panes).
Figure 9. Interfaces and Spaces/Services panes
To return to the initial view from the Monitoring pane, click Storage Space.
Chapter 3. Operation and management
31
Figure 10. Storage Systems and Monitoring panes
The table below summarizes functionality of the GUI elements.
Table 5. Spectrum Control Base GUI elements
GUI Element
Description
Add button. Click this button to add a new object (server,
storage service, system, etc).
Edit button, which is displayed a row in a table is selected.
Click this button to configure the object in the table row (user,
storage space, etc).
Home button. Click this button to display the home screen
(Spaces/Services and Storage Systems panes).
Settings button. Use this button to access the Settings menu to:
v Define storage credentials
v Define VASA Provider credentials
v Manage certificates
v Add and change the Spectrum Control Base users
v Add and edit storage spaces
v Collect logs
v Display version number of Spectrum Control Base and
included applications
v Access product documentation
Remove button. Click this button to remove a storage element
or delete a user from the User List.
Help button. Click this button to display the guided tour,
which is also available after the initial login.
Right and left navigation pointers. They indicate if additional
panes are available to the right or to the left of the current
display.
32
IBM Spectrum Control Base Edition
Table 5. Spectrum Control Base GUI elements (continued)
GUI Element
Description
Attach/Delegate button. It is available, when an unattached
storage object is selected. Click this button to:
v Delegate a storage service to a previously selected interface
(vCenter or vRO)
v Attach a storage resource to a previously selected storage
service
Detach/Cancel Delegation button. It is available, when an
attached storage resource is selected. Click this button to:
v Cancel delegation of a storage service to a previously
selected interface (vCenter or vRO)
v Detach a storage resource from a previously selected storage
service
Bar View button. Click this button to display the available
storage systems and resources as vertical bars.
Table View button. Click this button to display the available
storage systems and resources as a table.
Start Monitoring button. It is available, when the mouse
pointer is moved over a storage system, which is not
monitored via vCOps. Click this button to start the monitoring
process.
Stop Monitoring button. It is available, when the mouse
pointer is moved over a storage system, which is monitored
via vCOps. Click this button to stop the monitoring process.
Running initial setup
After you log in to Spectrum Control Base, the program invokes a setup wizard to
facilitate with the initial configuration.
Procedure
Follow the procedure below to complete the initial setup process, which is run
automatically after the first successful login. This procedure is mandatory for
subsequent storage provisioning, using Spectrum Control Base.
Note: This operation is not available from the CLI .
1. Enter the name of the high-availability (HA) group and the FQDN of the
Spectrum Control Base server. For detailed description of high-availability
groups, see “Managing high-availability groups” on page 36.
Chapter 3. Operation and management
33
Figure 11. Initial setup wizard, defining HA group
2. Generate or upload SSL certificate, required for establishing a secure
communication link with the Spectrum Control Base server. For detailed
description of SSL certificates, see “Managing server certificates” on page 39.
34
IBM Spectrum Control Base Edition
Figure 12. Initial setup wizard, defining SSL certificate
3. Define credentials to be used to connect to the IBM storage systems. For
detailed description of storage system credentials, see “Entering the storage
system credentials” on page 45.
Important: An identical storage admin user account with identical credentials (the
same username and password) must already be predefined on all the IBM storage
systems that you intend to use. Spectrum Control Base can use only a single
system management account for accessing all the different storage systems that
you use. For storage systems, running Spectrum Virtualize, ensure that the
credentials belong to a user account with VASAProvider role.
Chapter 3. Operation and management
35
Figure 13. Initial setup wizard, defining storage system credentials
What to do next
After successful login, take a guided tour, which is invoked automatically, to
familiarize yourself with the main interface elements and principles of operation.
Managing high-availability groups
IBM Spectrum Control Base Edition implements VMware's high-availability
architecture for multiple VASA providers.
Multiple Spectrum Control Base instances that manage the same storage system
can be combined into high-availabilty (HA) group for VASA provider redundancy.
The HA technology is implemented in the active/passive mode. In this mode, one
Spectrum Control Base acts as active and the other acts as standby for transfer of
responsibility if the active Spectrum Control Base fails or becomes unreachable, as
illustrated below.
36
IBM Spectrum Control Base Edition
Figure 14. High-availability group concept
To configure an HA group, open the Settings menu. For configuration instructions,
see “Defining a high-availability group.”
Figure 15. General Settings option on the Settings menu
Defining a high-availability group
To ensure continuous storage management, multiple Spectrum Control Base
instances must be activated and combined into a high-availability (HA) group.
Before you begin
You must define an HA group before adding storage systems to Spectrum Control
Base.
About this task
An HA group is a combination of two Spectrum Control Base instances, operating
in the active/passive mode. Active Spectrum Control Base instances are backed up
by the standby ones to provide uninterruptible service if one of them becomes
unavailable. A default HA group (ha_group_<1–100>) is created automatically
during Spectrum Control Base installation.
Chapter 3. Operation and management
37
Procedure
1. Click General settings on the Settings menu. The General Settings dialog box is
displayed.
2. Enter the FQDN of the first Spectrum Control Base and the name of the HA
group that you want to create, and then click Apply.
Note:
v The FQDN, which you enter, is automatically copied to the Hostname field of
the Server Certificate dialog box during the generation of the Spectrum Control
Base server certificate, as explained in “Managing server certificates” on page 39.
v A default HA group name is assigned automatically by Spectrum Control Base
in the ha_group_number format. The number is randomly selected from 1 to 100. If
you intend to change the default HA group name, any XIV storage system with
microcode 11.5, connected to Spectrum Control Base, which is the default HA
group member, must be removed from Spectrum Control Base before the group
name change.
Figure 16. General Settings dialog box
3. Log in to the standby instance of Spectrum Control Base and add its FQDN, as
explained above. The HA group name must be identical to the value that was
provided when registering the active Spectrum Control Base instance.
Important: The Spectrum Control Base software must be installed and configured
separately for each HA group member. This is required for obtaining a unique
VASA key which is generated during installation.
Do not clone an existing instance of an active Spectrum Control Base for use as
a standby member. However, cloning the VM which will host Spectrum Control
Base prior to installation is acceptable.
4. Define storage credentials for all Spectrum Control Base instances, as explained
in “Entering the storage system credentials” on page 45.
5. Add the same storage system for all Spectrum Control Base instances. Spectrum
Control Base redundancy is available only if active and standby members
manage the same storage system. See “Adding a storage system” on page 47.
6. Configure the server certificates. See “Managing server certificates” on page 39.
7. Register all HA group members as storage providers in the vCenter server. See
“Registering Spectrum Control Base as a storage provider on vCenter server”
on page 83.
8. Add storage spaces and services to the active Spectrum Control Base. There is
no need to configure these settings for a standby HA member. See “Managing
38
IBM Spectrum Control Base Edition
storage spaces and services” on page 54.Storage spaces and services defined on
an active instance of Spectrum Control Base do not appear on the standby
instance immediately. Any VVol-enabled storage services defined on the active
Spectrum Control Base are populated on the standby server's GUI during
system failover.
A failover to a standby HA group member occurs when the active Spectrum
Control Base service is stopped or reset. See “Checking and controlling the
Spectrum Control Base service” on page 133.
Managing server certificates
During the installation, a self-signed Secure Sockets Layer (SSL) certificate is
generated to create a secure communication channel for servers and clients. If you
already have a trusted certificate that you want to use, you can replace the
self-signed certificate with an existing trusted certificate or generate a new
certificate.
About this task
A self-signed certificate file, vp.crt, and a certificate key file, vp.key, are stored in
the following directory:
/opt/ibm/ibm_spectrum_control/settings/ssl_cert.
Because the self-signed certificate is not automatically recognized by the web
browser that you use to log in to Spectrum Control Base, you might encounter a
connection security warning before you can access the Spectrum Control Base login
page (see “Logging in” on page 29).
Figure 17. Connection security warning in the Mozilla FireFox web browser
Chapter 3. Operation and management
39
To avoid such warning messages, you need to upload a server certificate which is
signed by a public certificate authority (CA), such as VeriSign, or by a CA whose
root certificate was imported to your web browser. In addition, you can generate
an SSL certificate.
Procedure
1. Click Server certificate in the Settings menu. The Server Certificate dialog box
is displayed.
Figure 18. Generate option on Server Certificate dialog box
2. Enter the hostname/FQDN, common name, IP address of the Spectrum Control
Base server and certificate validity period, and then click Generate.
Note: The Spectrum Control Base hostname is automatically copied from the
FQDN field of the Settings menu. The value is entered during high-availability
group definition, as explained in “Defining a high-availability group” on page 37.
Spectrum Control Base generates the SSL certificate and key files, restarts the
Nginx process and refreshes the web browser.
3. Log out and log into Spectrum Control Base to complete the certificate
generation.
4. To upload a certificate and a certificate key files, select Upload files on the
Server Certificate dialog box.
40
IBM Spectrum Control Base Edition
Figure 19. Upload files option on Server Certificate dialog box
5. Click Browse and attach your certificate vp.crt, and a certificate key files,
vp.key, and then click Upload. Spectrum Control Base overwrites the existing
SSL certificate and key files, restarts the Nginx process and refreshes the web
browser.
6. Log out and log into Spectrum Control Base to complete the procedure.
Managing Spectrum Control Base users
At any time, you can add new Spectrum Control Base user accounts, change user
account passwords, or delete existing user accounts.
To access the user management options, click the Settings button and select Users
in the Settings menu. You can then view, add, and manage the Spectrum Control
Base users as explained in the following sections.
Chapter 3. Operation and management
41
Figure 20. Users option in the Setting menu
Note: The same operations are available from the CLI as well, as explained in
“CLI – Managing Spectrum Control Base users” on page 138.
v “Adding a new user”
v “Changing the password of a Spectrum Control Base user” on page 43
v “Deleting a user” on page 44
Adding a new user
You can add a user account for any authorized user that requires access to
Spectrum Control Base.
About this task
In addition to storage system credentials, you can define a user for logging into
Spectrum Control Base and performing GUI or CLI management actions.
Note: All Spectrum Control Base users have the same permission level, and can
undo any setting or action made by another user.
Procedure
1. Click Users in the Settings menu. The User List is displayed, which details all
existing users.
2. Click Add.
42
IBM Spectrum Control Base Edition
Figure 21. Add option in the Users dialog box
The New User dialog box is displayed.
3. Enter the username and password for the account that you want to create, and
then click Apply. The minimum password length is seven characters and it
must include at least one letter and one digit. The username of the created
account is added to the Users list.
Changing the password of a Spectrum Control Base user
At any time, you can change the password of a Spectrum Control Base user
account.
About this task
You can modify a user account only by changing its password. Periodic password
change is recommended on a regular basis.
Note:
v Spectrum Control Base user names cannot be changed. Instead, you can delete a
user account (see “Deleting a user” on page 44) and then create a new one (see
“Adding a new user” on page 42).
v This operation is available from the CLI as well, as explained in “CLI –
Managing Spectrum Control Base users” on page 138.
Procedure
1. Click Users on the Settings menu. The Spectrum Control Base User List is
displayed, which details all existing users.
2. Click the Edit button in the row of the user account that you want to update.
Chapter 3. Operation and management
43
Figure 22. Edit button in user account row
The Change Password dialog box is displayed.
3. Enter the current password of the user account, and then the new password as
required. The minimum password length is seven characters and it must
include at least one letter and one digit. Then, click Apply.
Deleting a user
When necessary, you can delete any user account.
About this task
After you delete a Spectrum Control admin user account from the GUI, the specific
user can no longer log in to the Spectrum Control Base server from either the GUI
or the CLI. Although the user deletion is a non-reversible operation, you can
redefine the same username as explained in “Adding a new user” on page 42.
Note: Deleting a Spectrum Control Base user does not affect the storage
credentials.
Procedure
1. Click Users in the Settings menu. The User List is displayed, which details all
existing users.
2. Click the Remove button on the row of the user account that you want to
remove.
A confirmation message appears.
3. Click Yes to delete the user, or No to cancel the operation.
Managing storage systems
All IBM storage systems that provide storage resources to your VMware platforms
must be defined as storage systems on IBM Spectrum Control Base Edition.
To access the storage system management options, go to the Storage Systems pane
of the Spectrum Control Base GUI, illustrated below. You can then view, add,
manage the storage systems and their resources, as explained in the following
sections.
44
IBM Spectrum Control Base Edition
Figure 23. Storage Systems pane
Note: The same operations are available from the CLI as well, as explained “CLI –
Adding or removing storage system credentials” on page 141 and in “CLI –
Managing storage systems” on page 143.
v “Entering the storage system credentials”
v “Adding a storage system” on page 47
v “GUI – Working with storage system views” on page 49
v “Modifying the IP address or hostname of a storage system” on page 51
v “Removing a storage system” on page 52
Entering the storage system credentials
The storage system credentials are used to connect to the IBM storage system or
systems, which your VMware platforms use for storage provisioning.
About this task
From the Spectrum Control Base GUI you can set or change the current storage
system access credentials that are used for accessing all the IBM storage systems.
Chapter 3. Operation and management
45
Important:
v An identical storage admin user account with identical credentials (the same
username and password) must already be predefined on all the IBM storage
systems that you intend to use. Spectrum Control Base can use only a single
system management account for accessing all the different storage systems that
you use. For storage systems, running Spectrum Virtualize, ensure that the
credentials belong to a user account with VASAProvider role.
For more information about how to define a storage admin account on your IBM
storage systems, refer to the relevant storage system management tools
documentation.
v Setting the storage credentials on Spectrum Control Base allows you to add the
IBM storage systems on the next step.
v If the system management account is defined on a directory server, see
“Checking the format of directory-based storage system credentials” on page
155.
Note: The same operations are available from the CLI as well, as explained in
“CLI – Adding or removing storage system credentials” on page 141.
Procedure
1. Click the Settings button and select Storage credentials from the Settings
menu.
Figure 24. Settings button
The Storage Credentials dialog box is displayed. The dialog box presents the
currently defined storage system username in the User name configuration box.
Figure 25. Current storage system username (for all storage systems)
2. Enter the username and password of the storage admin user that was defined
on all your IBM storage systems.
46
IBM Spectrum Control Base Edition
3. If the storage admin user account is defined on a directory server, select the
Directory account check box. If the storage admin user account is
locally-defined on the storage system, clear the check box.
4. Click Apply.
What to do next
You can now start adding storage systems. Spectrum Control Base will use the
credentials that you have set in order to connect to the storage systems that you
add.
Attention: During regular operation, whenever a directory-based storage admin
fails to log in (from the Spectrum Control Base side) to any storage system that is
in use, Spectrum Control Base immediately locks the storage admin user account
and all storage systems become inaccessible on the Spectrum Control Base side.
This is to prevent repeated login attempt failures after which the directory server
blocks that user account. In such a case, set the storage system credentials again to
unlock the storage admin account on the Spectrum Control Base side, with either
the same credentials or with updated credentials. The equivalent action in the
Spectrum Control Base CLI is to use the force credentials options, as described in
“CLI – Adding or removing storage system credentials” on page 141.
Adding a storage system
After the storage system credentials are set, you can start adding storage systems
to Spectrum Control Base.
About this task
The storage systems that you add can be used by the solution components that are
included in the Spectrum Control Base package (see “Included cloud interfaces” on
page 1). You can add each individual storage system separately, as described in the
following procedure.
Procedure
1. Click the Add button on the Storage Systems pane.
Figure 26. Add button
The Add New IBM Storage System dialog box is displayed.
Chapter 3. Operation and management
47
Figure 27. Add New IBM Storage System dialog box
2. Enter the management IP address or hostname of the array.
3. Click Add. If the credentials are correct (as previously defined; see “Entering
the storage system credentials” on page 45) and the IP connection is
established, the storage system is added to the Storage Systems pane.
If the storage system includes previously defined storage pools, you can view
their names and sizes on the system. If no pools exist on the system, you can
define them, as explained in “Defining and attaching storage resources” on
page 60.
Spectrum Control Base fetches information about storage resources on a system
every ten minutes by default. You can refresh the storage resource information
immediately by right-clicking a system that you want to refresh, , and then
selecting Refresh.
Figure 28. Storage Systems pane, bar view
If a storage system connectivity problem occurs, Spectrum Control Base
displays a red frame around the system. Move the mouse pointer over the
system, and click the red triangle to display the error message.
4. Click the Table View button to display the existing storage systems as a table.
48
IBM Spectrum Control Base Edition
Figure 29. Storage Systems pane, table view
What to do next
See “GUI – Working with storage system views” to learn how arrange storage
systems in the table view or search for a specific storage system or resource.
GUI – Working with storage system views
Spectrum Control Base offers powerful search tools to help you locate a specific
storage system or resource, according to its name or other attributes.
About this task
After the storage systems become visible on the Storage System pane of Spectrum
Control Base, you can arrange the way they appear in the table view. In addition,
you can use the search box on the top of the Storage System pane to locate a
specific storage system or resource, as described below.
Procedure
1. In the table view mode, click on an attribute column header to arrange the
existing storage systems and resources, according to one on the following
criteria:
v Resource name
v Parent pool name
v Domain name
v Storage array name
v Storage space usage in %
v Size in GiB
v Storage service it is attached to, if any
v Storage system type
Chapter 3. Operation and management
49
You can change the item order by clicking the arrow in the column header.
Figure 30. Storage Systems pane with storage elements arranged according to descending space usage
2. Enter a full or partial name of a storage system or resource into the search box.
Spectrum Control Base displays search results, highlighting the names that
match the search string.
Figure 31. Storage Systems pane with highlighted search string results
3. Click the arrow in the search box to display the advanced filtering tool.
50
IBM Spectrum Control Base Edition
Figure 32. Advanced filtering tool
4. In the advanced filtering tool, select one or more of the following filtering
attributes and their values from the drop-down lists. The available attributes
may vary, depending on a storage system in use.
v Software version
v Disk size.
v Hardware model
v Product type
Spectrum Control Base arranges storage elements according to the selected
filtering attributes and their values. The best matching results are grouped at
the left in the bar view mode and at the top in the table view.
Figure 33. Storage Systems pane with storage elements filtered according to disk size
Modifying the IP address or hostname of a storage system
At any time, you can modify the IP address or hostname of an added storage
system.
Chapter 3. Operation and management
51
About this task
If the management IP address or hostname of a storage system changes, you can
update this change on Spectrum Control Base without having to remove or re-add
the storage system.
Procedure
1. In the Storage Systems pane, right-click a storage system that you want to
update, and then select Modify. The Array Settings dialog box is displayed.
Figure 34. Array Settings dialog box
Note: If a storage system has multiple management IP addresses, you can display
all of them by moving the mouse pointer over the Hostname field in the Array
Settings dialog box.
2. Enter the new management IP address or hostname of the storage system, and
then click Apply.
Removing a storage system
If a storage system is no longer needed, you can remove and disconnect it from
Spectrum Control Base.
About this task
v A removed storage system, along with its storage pools and volumes, can no
longer be managed by the included solution components (see “Included cloud
interfaces” on page 1).
v If the removed storage system contains working storage resources and volumes,
the information of these storage pools and volumes is no longer displayed in
vSphere Web Client. However, vSphere data access and service level for these
storage pools and volumes is not affected. In addition, the removed system and
its storage resources and volumes can be managed from the standard IBM
storage system management tools.
v After the removal, you can add the storage system back again to fully restore its
management.
Procedure
1. In the Storage Systems pane, right-click a storage system that you want to
remove, and then select Delete. The confirmation message is displayed.
2. Click OK to confirm your action. The storage system is removed.
52
IBM Spectrum Control Base Edition
Managing and monitoring VASA access
You can control and monitor the utilization of the IBM Storage Provider for
VMware VASA, which is part of the IBM Spectrum Control Base Edition solution.
Refer the following sections on details how to set VASA credentials and manage
trusted certificates.
v “Setting the VASA credentials”
v “Managing VASA trusted certificates” on page 54
Setting the VASA credentials
The VASA credentials comprise a username and a password that is set separately
from the Spectrum Control Base user accounts, and separately from the storage
system credentials.
About this task
VMware vCenter servers can use the VASA credentials to connect to Spectrum
Control Base and utilize VASA functions, as explained in “Registering Spectrum
Control Base as a storage provider on vCenter server” on page 83.
From the Spectrum Control Base GUI you can set, change, or display these VASA
credentials at any time.
Note:
v Only one set of a username and a password can be used for the VASA
credentials, which applies to all vCenter servers that require VASA functions and
connect to Spectrum Control Base.
v The same operations are available from the CLI as well, as explained in “CLI –
Setting the VASA credentials” on page 145.
Procedure
1. Click VASA Provider credentials on the Settings menu. The VASA Credentials
dialog box is displayed.
Figure 35. VASA Credentials dialog box
2. Enter the username and password that you want to set, confirm the password
and then click Apply.
Chapter 3. Operation and management
53
Note: The VASA username must be different from any username stored in the
Spectrum Control Base user database. See “Managing Spectrum Control Base
users” on page 41
Managing VASA trusted certificates
You can view and, if needed, remove all registered vCenter servers as well as
upload new certificates.
Before managing VASA certificates, verify that the VASA credentials have been set,
as explained in the previous section.
To display a list of all vCenter servers that are currently registered and are
utilizing VASA functions, go to the VASA Trusted Certificates dialog box (Settings
> VASA trusted certificates). Instructions on adding Spectrum Control Base as a
storage provider to the VMware vCenter Server are detailed in the “Registering
Spectrum Control Base as a storage provider on vCenter server” on page 83
section. During Spectrum Control Base registration, the certificate validity is
verified for VMware VASA 1.0 and VASA 2.0. Also, for VMware VASA 2.0, it is
verified that the certificate is signed by the VC root CA (when working with
VMCA) or it is uploaded as a trusted certificate.
Figure 36. Registered VASA servers (vCenter servers that employ VASA services)
If you want to disconnect a vCenter server, click and highlight the row of the
vCenter server that you want to disconnect, and then click the Remove button.
If you want to upload a new certificate, click Add > Upload Certificate > Browse
and attach your certificate file.
Managing storage spaces and services
After defining physical storage resources on Spectrum Control Base you must add
virtual storage elements: spaces and services.
Spectrum Control Base administers storage at the virtual level, using spaces and
services. This simplifies storage provisioning, and allows users to allocate their
own storage resources to suit requirements of a specific VM.
Storage spaces and services are described in the “Storage space and service
management” on page 7 section of Chapter 1.
54
IBM Spectrum Control Base Edition
Storage spaces are added and managed, using the Manage Spaces option in the
Settings menu. You can also add a new space via the drop-down menu of the
Default Space tab on the Spaces/Storage Services pane.
Storage services are added and configured via the Spaces/Storage Services pane of
the Spectrum Control Base GUI.
Figure 37. Spaces/Storage Services pane
v “Adding a storage space” on page 56
v “Removing a storage space” on page 57
v “Adding a storage service” on page 57
v “Removing a storage service” on page 60
v “Defining and attaching storage resources” on page 60
v “Modifying storage resource attachments” on page 65
Chapter 3. Operation and management
55
Adding a storage space
Once physical storage elements are defined in the IBM Spectrum Control Base
Edition, you can continue by adding the first virtual entity – a storage space.
About this task
A storage space is a logical grouping of storage services and underlying physical
storage resources. This combination determines the storage that is available when a
user requests a storage service provisioning.
A storage space is added by providing it with a meaningful name and description.
Procedure
1. Click the Settings button and select Manage spaces from the Settings menu.
The list of storage spaces is displayed.
2. Click Add . The New Space dialog box is displayed.
Figure 38. New Space dialog box
3. Enter the name and description of the storage space that you want to create,
and then click Apply. The name and description of the created storage space is
added to the Spaces list.
56
IBM Spectrum Control Base Edition
Figure 39. List of storage spaces
Note: You can also add a new space by clicking Add New Space in the
drop-down menu of the Default Space tab on the Spaces/Storage Services pane.
Removing a storage space
If a storage space is no longer needed, you can remove it from Spectrum Control
Base.
Before you begin
Before removing a storage space, delete all services that are defined on this space.
See “Removing a storage service” on page 60
About this task
A removed storage system, along with its services and pools, can no longer be
available for storage service provisioning.
Procedure
1. Click the Settings button and select Manage spaces from the Settings menu.
The Spectrum Control Base space list is displayed, detailing all existing storage
spaces.
2. Click the Remove button on the row of the storage space that you want to
remove. A confirmation message appears.
3. Click OK to remove the space, or Cancel to cancel the operation.
Adding a storage service
After a storage space is defined, you can start adding storage services to the space.
Chapter 3. Operation and management
57
About this task
Storage services contain one or more physical storage pools. In addition to storage
capacity, a service has a set of capabilities, defining the storage quality, such as
thin/thick provisioning, compression, encryption, etc.
The services that you add become available for the solution components included
in the Spectrum Control Base package (see “Included cloud interfaces” on page 1).
When provisioning storage, the end users consume it from the spaces and services
without dealing underlying physical storage infrastructure.
You can add each individual storage service separately, as described in the
following procedure.
Procedure
1. In the Spaces tab of the Spaces/Storage Services pane, select a space on which
you want to create a new service.
2. Click Add button on the Spaces/Storage Services pane. The New Storage
Service dialog box is displayed.
Figure 40. New Storage Service dialog box
3. Use the Select Capability drop-down box to define the new service attributes
and their values. See table below for details.
58
IBM Spectrum Control Base Edition
Important: Spectrum Control Base uses dynamic filtering to simplify selection of a
storage system and a resource, which provides the best match for selected service
attributes. When a service is created, Spectrum Control Base groups the best
matching storage systems in the left section of the Storage Systems pane. Also, the
matching storage resources are grouped at the top of the respective storage system.
In addition, storage system and resources that do not support the selected service
attributes are grayed out in the bar view or removed from the list in the table
view.
Table 6. Service parameters
Parameter
Description and values
Name
Alphanumeric string for service identification. This is a
mandatory field. The service name must not contain spaces.
Description
Alphanumeric string for service description.
Encryption
Enables encryption for the service. If enabled, you can attach
only encrypted storage resource to the service.
Flash
Enables utilization of a storage resource, located on a
flash-based storage resource. This can be one of the following
storage systems: FlashSystem™ 900, FlashSystem V9000,
Storwize Family.
Space Efficiency
Enables storage space efficiency features for the service. When
selected, you can configure the service to be attached to a
thick- or thin-provisioned storage resource.
Data Reduction
Enables the use IBM Real-time Compression™ with or without
data deduplication.
Configuration considerations
A service with enabled IBM Real-time Compression will be
able to support the compression-compatible (thin-provisioned)
storage resources on XIV and Spectrum Accelerate systems.
For the FlashSystem V9000, Storwize Family storage systems, a
storage resource must have the data compression enabled prior
to service attachment (via product CLI or GUI).
Currently, DS8000 storage systems do not support IBM
Real-time Compression.
VVol Service
Enables virtual volume functionality for the service.
The virtual volume functionality is supported by the IBM XIV
(11.5.1 or later) and storage systems that run IBM Spectrum
Virtualize (7.6 or later).
An XIV VVol-enabled service does not support IBM Real-time
Compression.
Important: The following requirements apply to the VVol-enabled services:
v All storage resources attached to a VVol-enabled service must reside on the same
storage system.
v Only one VVol-enabled service is allowed per storage system and per storage
space.
4. Click Create to finish the procedure. A new service is added to the current
Spaces tab.
Chapter 3. Operation and management
59
5. You can edit the service properties by right-clicking a service which you want
modify, and then selecting Modify Properties.
What to do next
Define and attach storage resources (pools) to the service, as explained in
“Defining and attaching storage resources.”
Removing a storage service
If a storage service is no longer needed, you can remove it.
About this task
v A removed storage service, along with its pools, can no longer be managed by
the included solution components.
v If the removed storage service contains working storage resources, these
resources become available for allocation by other existing services.
Procedure
1. On the Spaces/Storage Services pane, right-click a service that you want to
remove, and then select Remove. A confirmation message is displayed.
2. Click OK to confirm the removal.
Defining and attaching storage resources
After the storage systems and services are added, you can start defining resources
on the systems.
Before you begin
Verify that the storage resource, which you intend to define and attach, will be
compatible with the service in terms of space efficiency, compression mode or any
other attribute defined for the service..
About this task
If no resources (pools) exist on the storage systems, you can define the resources
and attach them to a service to make the physical storage available for the
Spectrum Control Base components and end users. You can attach several
resources to a single service. However, a specific resource can be added to one
service only.
Note: For VVol-enabled services, the minimum recommended storage resource size
is 500 GiB.
Procedure
1. On the Spaces/Storage Services pane, select the storage space from which you
want to choose storage services. The available services that reside on the
selected storage space are immediately displayed.
2. Click on a service to which you want to attach a resource. The service color
changes to green to indicate selection.
3. On the Storage Systems pane, right-click a storage system on which you want
to define a new resource, and then select Add Resource. The Add New
60
IBM Spectrum Control Base Edition
Resource dialog box is displayed.
Figure 41. Add New Resource dialog box
4. In the Add New Resource dialog box, enter configuration parameters for a new
resource. See table below for details.
Table 7. Storage resource parameters
Parameter
Description and values
Name
Alphanumeric string for storage resource identification. The
name must not contain spaces. This is a mandatory field.
Domain
Management domain of the pool IBM XIV systems, or a parent
pool for storage systems that run IBM Spectrum Virtualize (7.6
or later).
Configuration considerations
Management domains are available for the XIV systems with
microcode version 11.5.x and above. To use this feature, verify
that:
v Domains are already defined on your storage system.
v Default credentials of a storage admin user are assigned to
the domain.
Size
Storage resource size in GiB.
Chapter 3. Operation and management
61
Table 7. Storage resource parameters (continued)
Parameter
Description and values
Over-provisioning
Percentage of over-provisioned storage space on the service,
defining the ratio between logical and physical storage
capacity. For example, when configured to 100, it sets a 1:1
ratio between the two values, while a value of 200 defines the
logical capacity (soft size) to be twice the physical capacity
(hard size).
Configuration considerations
The recommended over-provisioning value for a VVol-enabled
service with XIV storage systems is 400®%.
The recommended over-provisioning value for a service with
IBM Real-time Compression is 200%.The XIV utilizes thin
provisioning for all VM configuration volumes. When creating
a regular VM on an XIV disk, you can choose the provisioning
mode, according to your application requirements.
For other cases, you can choose any value:
v 100%, if you do not want to utilize thin provisioning.
v Above 100%, if you want to take a risk of allocating
resources that the XIV storage system may not have.
In addition, when utilizing the over-provisioning, XIV storage
systems must be also configured to allow support for this
feature. When used with the XIV domains, the domain must
be also configured with matching soft and hard capacity
settings. To enable the VVol functionality at the XIV side, see
“Creating a VVol-enabled service” on page 161.
Important
The managed domain that you created cannot be used for
traditional volumes without virtualization. You must create a
separate regular domain for them. This domain must have the
same user and the ESXi hosts that you intend to manage.
However, you need to create a separate storage resource and a
new service on the regular domain via Spectrum Control Base
for subsequent use by the vWC.
The over-provisioning is not relevant for the storage systems
that run IBM Spectrum Virtualize and DS8000.
Configuration examples
v Storage pools in a regular service with over-provisioning at
100% are created as thick pools.
v Storage pools in a regular service with over-provisioning at
150% are created as thin pools. If a hard pool size is 500
GiB, its soft size is 750 GiB.
v Group storage pools in a VVol-enabled service with
over-provisioning at 400% are created as thin pools with
their soft sizes to be four time bigger than their hard sizes.
Snapshot reserve
62
IBM Spectrum Control Base Edition
Percentage of storage space on the service reserved for
snapshots.
5. Click Add. The storage resource is created on the storage system and attached
to the service. The resource color changes to green to indicate the successful
attachment.
The resources defined on the system before the system was attached to
Spectrum Control Base, can be allocated to a service by selecting the service
and clicking an unattached resource.
A storage service provides indication for the allocated and used storage space.
v Allocated – amount of storage space available on all pools connected to the
service.
v Used – amount of storage space used by all storage elements connected to
the service (datastores, servers, etc).
Important:
v When attaching a resource to an over-provisioned service, verify that a storage
system which hosts the pool has enough capacity to accommodate the service
space requirements.
v Datastores created on VVol-enabled services always display the meta and thick
pools of its group pool to be 100% full. You can disregard this alert.
6. You can display detailed information for all storage resources defined on a
storage system by switching to the table view. The System Storage Resources
table is displayed.
Figure 42. Storage Resources table
The table lists all storage resources defined on the storage system, including
their sizes, free and used storage space, parent pool for storage systems that
run IBM Spectrum Virtualize, and a service that the resource is attached to.
When you click on a storage resource row to select it, you can complete the
following:
Chapter 3. Operation and management
63
v Click the Attach/Delegate button to attach the storage resource to a
previously selected storage service.
v Click the Detach/Cancel Delegation button to detach the storage resource
from a previously selected storage service.
v Right-click and select Modify to resize the resource or remove it.
v Right-click and select Delete button to delete child pools or XIV pools. This
option does not exist for parent pools or DS8000 pools.
7. You can display detailed information for all storage resources attached to a
service on a storage system by right-clicking the service on which you want
zoom, and then selecting View Resources. The Service Storage Resources table
is displayed.
Figure 43. Service Storage Resources table
The table lists all storage resources attached to the storage service, including
their sizes, free and used storage space and a system that the resource was
created on. When you click on a storage resource row to select it, you can
complete the following:
v Click the Resource Detach button to detach the storage resource from a
storage service.
v Click the Resource Settings button to resize the resource or remove it.
v Click the Remove button to delete child pools or XIV pools. This option is
not functional for parent pools or DS8000 pools.
Resizing storage resources
If needed, you can change a size of any resource (pool) defined on a storage
system.
About this task
Storage resources can be resized to match the requirements of the connected
services, as described in the following procedure.
Note: Pool resizing does not function for parent or DS8000 pools.
64
IBM Spectrum Control Base Edition
Procedure
1. On the Storage Systems pane, right-click a pool which you intend to resize and
select Modify. The Resource Settings dialog box is displayed.
Figure 44. Resource Settings dialog box
2. In the Size text box of the dialog box, enter the new size for the pool.
3. Click Modify to save the change.
Note: You can also access the Resource Settings dialog box by selecting a storage
resource row in the System Storage Resource or Service Storage Resource table.
Refer to “Defining and attaching storage resources” on page 60 for details.
Modifying storage resource attachments
When required, you can modify a storage resource (pool) service attachments.
About this task
Storage resources can be detached from the service or attached to it.
v A detached storage pool can no longer be managed by the included solution
components.
v A detached storage pool becomes available for allocation by other existing
services.
v After the detachment, you can attach the pool again to fully restore its
management.
Procedure
1. On the Spaces/Storage Services pane, right-click a storage service and select
Manage Resources. The pools that are currently attached to the service and
those that can be attached to it are highlighted on the Storage Systems pane.
Chapter 3. Operation and management
65
Figure 45. Manage Resources dialog box
2. From the Storage Systems pane:
v Click the Attach/Delegate button to attach the storage resource to the storage
service. The pool color changes to indicate the successful attachment.
v Click the Detach/Cancel Delegation button to detach the storage resource
from the storage service. The pool color changes to indicate the successful
detachment.
Managing integration with vSphere Web Client
Before you can use the IBM Storage Enhancements for VMware vSphere Web
Client on the web client side, you need to define on the Spectrum Control Base
side the vCenter servers for which you want to provide storage resources. Then,
you can attach storage services that you want to make available to each vCenter
server.
The storage services that you attach on the Spectrum Control Base side become
visible on vSphere Web Client, and can be used for volume creation by using the
IBM Storage Enhancements for vSphere Web Client (for more information, see
Chapter 5, “Using the IBM Storage Enhancements for VMware vSphere Web
Client,” on page 87).
v “Adding a vCenter server”
v “Updating the credentials of a vCenter server” on page 68
v “Removing a vCenter server” on page 69
v “Delegating storage services to a vCenter server” on page 69
v “Canceling service delegation to a vCenter server” on page 71
Adding a vCenter server
Add the VMware vCenter servers for which you want to provide storage resources
through IBM Spectrum Control Base Edition.
66
IBM Spectrum Control Base Edition
Before you begin
Log out of any vSphere Web Client application connected to a vCenter Server that
you want to add to Spectrum Control Base. If you stay logged in, you will be able
to use the extension only after you log out and log into vCenter after the
connection.
About this task
You need to connect to and add the vCenter servers for which you can later attach
storage services that would be visible and accessible on the vSphere Web Client
side. You can add a single vCenter server at a time, as described in the following
procedure.
Note: For any vCenter server that you add, the IBM Storage Enhancements for
VMware vSphere Web Client (see Chapter 5, “Using the IBM Storage
Enhancements for VMware vSphere Web Client,” on page 87) are automatically
deployed and enabled on the vSphere Web Client Server side.
Procedure
1. Click Add Interface on the Interfaces pane and then select Add vCenter. The
Add New vCenter Server for vWC dialog box is displayed.
Figure 46. Add vCenter Server for vWC dialog box
2. Enter the IP address or hostname of the vCenter server, as well as the
username and password for logging into that vCenter server. If the provided IP
address and credentials are accepted by the vCenter server, it is added to the
list of servers on the Interfaces pane.
Chapter 3. Operation and management
67
Figure 47. Interfaces pane
Note:
v If you want to use the vSphere Web Client extension on all vCenter servers that
operate in linked mode, each server instance must be added to Spectrum Control
Base. This ensures that the extension is registered on all linked servers properly.
v The same vCenter server cannot be added to more than one Spectrum Control
Base instance. Any attempt to add an already registered vCenter server to
another Spectrum Control Base will override the primary connection.
What to do next
Attach storage services to the vCenter server, as explained in “Delegating storage
services to a vCenter server” on page 69.
Updating the credentials of a vCenter server
At any time, you can update the credentials that are used by Spectrum Control
Base to access a vCenter server.
About this task
Whenever the credentials on the vCenter server side change, you can update these
credentials on the Spectrum Control Base side to allow continued management of
storage resources on the vSphere Web Client side.
Note: Prior to changing the vCenter credentials on the Spectrum Control Base side,
verify that the vCenter user has sufficient access level to complete this procedure.
68
IBM Spectrum Control Base Edition
Procedure
1. On the Interfaces pane, right-click the vCenter server for which you want to
update the credentials, and then select Modify. The vCenter Server Settings
dialog box is displayed.
Figure 48. vCenter Server Settings dialog box
2. Enter the new username and password for accessing the vCenter server. Then,
click Apply.
Removing a vCenter server
When a vCenter server is no longer needed, you can disconnect it from Spectrum
Control Base by removing it from the Interfaces pane.
About this task
v A removed vCenter server, along with the storage services attached to it, can no
longer be managed by the IBM Storage Enhancements for VMware vSphere Web
Client. Following the removal, the IBM Storage Enhancements become disabled
for that vCenter on the vSphere Web Client Server side.
v If the removed vCenter server is attached to active storage service, the
information for these services, as well as their pools is no longer displayed in
vSphere Web Client. However, vSphere data access and service level for the
services and pools is not affected.
v After the removal, you can add the vCenter server again to fully restore its
management.
Procedure
1. On the Interfaces pane, right-click the vCenter server that you want to remove,
and then select Remove. A confirmation message is displayed.
2. Click OK to remove the vCenter server.
Delegating storage services to a vCenter server
You must delegate any storage service that you want to use for volume
management operations on the vSphere Web Client side to the vCenter server.
Before you begin
v Storage services can be delegated only with Spectrum Control Admin, Storage
Admin, System Admin, or Security Admin storage credentials (see “Entering the
storage system credentials” on page 45).
Chapter 3. Operation and management
69
v When working with DS8000, services can be delegated only with Spectrum
Control Admin or Logical Operator storage credentials.
v Working with VMware VVols requires the Storage Integration Admin access level
configured at the storage system side.
Any other type of storage credentials (read-only, application admin) cannot
perform service delegation. If your credentials are not sufficient, contact your
storage administrator for assistance.
About this task
The service delegation is done on the Spectrum Control Base side, providing more
control to storage administrators as opposed to the VMware administrators on the
vSphere environment side. After the delegation, the services and their pools
become visible and manageable on the vSphere Web Client side (by using the IBM
Storage Enhancements).
Procedure
1. On the Interfaces pane, click the vCenter server to which you want to delegate
one or more services.
2. On the Spaces/Storage Services pane, select the storage space from which you
want to choose storage services. The available services that reside on the
selected storage space are immediately displayed.
3. Right-click on a service that you want to delegate to the vCenter server, and
then select Delegate to vCenter_IP_address, or click the Attach/Delegate
button on the service. The service color changes to indicate the successful
delegation, as illustrated below.
You can continue the process by right-clicking available services under the
current storage space.
Figure 49. vCenter server with delegated service
The vCenter server provides indication for the allocated and used storage
space.
v Allocated – amount of storage space available on all pools connected to the
delegated services.
v Used – amount of storage space used by volumes on all pools connected to
the delegated services. The volumes are created using IBM Storage
Enhancements for VMware vSphere Web Client.
70
IBM Spectrum Control Base Edition
Canceling service delegation to a vCenter server
When required, you can cancel a storage service delegation to the vCenter server.
About this task
v A storage service, which delegation has been canceled, can no longer be
managed by the included solution components (see “Included cloud interfaces”
on page 1).
v If the storage resources on such service contain working volumes, the
information of these volumes is no longer displayed in vSphere Web Client.
However, vSphere data access and service level for these volumes is not
affected. In addition, the removed storage pools (including its volumes) can be
managed from the standard IBM storage system management tools.
v The working volumes of such service remain visible in vSphere Web Client, as
long as they are mapped to ESXi hosts. However, these volumes cannot be
managed via vWC.
v At any time, you can delegate the storage service again to fully restore its
management.
Procedure
1. On the Interfaces pane, click a vCenter server which service delegation you
want to cancel. The services that are currently delegated to the vCenter server
are highlighted on the Spaces/Storage Services pane.
2. Right-click on a service which delegation you want cancel, and then select
Cancel delegation to vCenter_IP_address, or click the Detach/Cancel
Delegation button on the service. The service color changes to indicate the
successful cancellation of service delegation.
You can continue the process by right-clicking delegated services under the
current space.
Managing integration with vRealize Orchestrator
The IBM Storage Plug-in for the VMware vRealize Orchestrator is used for
discovery of the IBM storage resources and provisioning automation workflows in
the vRealize Orchestrator (vRO).
Note: In version 3.0.x, the IBM Storage Plug-in for VMware vRealize Orchestrator
does not support the DS8000 family storage systems.
To access the vRO management options, add the vRO server (interface) on the
Interfaces pane. You can then manage the integration with vRO as explained in the
following sections:
v “Downloading and installing the plug-in package for vRO” on page 72.
v “Delegating storage services to the vRO server” on page 75.
v “Canceling service delegation to a vRO server” on page 76
v “Regenerating the vRO token” on page 76.
Chapter 3. Operation and management
71
Figure 50. vRO server on the Interfaces pane
Downloading and installing the plug-in package for vRO
To enable the IBM Storage workflows in vRealize Orchestrator, you must first
download the IBM Storage plug-in package from Spectrum Control Base and
install it on the vRealize Orchestrator server.
Before you begin
To allow the IBM Storage Plug-in to securely identify Spectrum Control Base and
work properly, the SSL certificate that is automatically created on Spectrum Control
Base upon installation must be replaced with a new one. For more information
about how to replace the certificate, see “Managing server certificates” on page 39.
Important: After the IBM Storage Plug-in is installed on vRealize Orchestrator, the
Java™ security APIs validate that the hostname received from Spectrum Control
Base is identical to the common name (CN) value that is in the server certificate.
About this task
The following procedure details how to download, install, and properly configure
the IBM Storage Plug-in for VMware vRealize Orchestrator.
Procedure
1. On the Interfaces pane, right-click the vRO server, and then select Modify.
The vRO Settings dialog box is displayed.
2. On the bottom of the dialog box, click Download plug-in package.
72
IBM Spectrum Control Base Edition
Figure 51. Download plug-in package button
Alternatively, you can download the package from the following directory on
the Spectrum Control Base:
/opt/ibm/ibm_spectrum_control/downloads/static/o11nplugin-ibmstorage.vmoapp
3. Copy the current vRO token key from the Current vRO Token box.
Figure 52. Current vRO Token
4. Launch the VMware vRealize Orchestrator configuration interface.
5. On the Network tab, click SSL Trust Manager and then import the Spectrum
Control Base certificate. The certificate URL format should be:
https://IP_address: TCP port in use.
6. On the Plug-ins tab, click Install New Plug-in, locate and choose the
downloaded plug-in file, and then click Upload and Install. Accept the license
agreement. The message 'IBM Storage (3.0.0.x) New plug-in installed.' is
displayed. Installation is completed and the IBM Storage plug-in is displayed
in the list of vRO plug-ins.
Chapter 3. Operation and management
73
Figure 53. Successful installation of IBM Storage plug-in for vRO
7. Go to the Startup Options, and click Restart service to restart the vRO Server
service.
Figure 54. Restarting vRO Server service
8. Start the VMware vRealize Orchestrator client and go to the Workflows tab.
9. On the Workflows tab, go to Library > IBM > Storage > Configuration.
74
IBM Spectrum Control Base Edition
10. Select and run the Set Server and Token workflow. The Start Workflow: Set
Server and Token dialog box is displayed.
Figure 55. Start Workflow: Set Server and Token dialog box
11. Enter the Spectrum Control Base IP address or hostname, TCP port in use and
the token that you obtained earlier.
12. Click Submit to finish the configuration workflow.
Delegating storage services to the vRO server
Before you can use the IBM Storage Plug-in for VMware vRealize Orchestrator on
the vRealize Orchestrator (vRO) server side, you must delegate the storage services
that you want to make available for vRealize Orchestrator.
About this task
The services and their storage resources that you delegate on Spectrum Control
Base can be used for issuing volume workflows through vRealize Orchestrator (for
more information, see Chapter 6, “Using the IBM Storage Plug-in for VMware
vRealize Orchestrator,” on page 109).
Procedure
To delegate storage services to the vRO server:
1. On the Interfaces pane, click the vRO server to select it.
2. On the Spaces/Storage Services pane, select the storage space from which you
want to choose storage services. The available services that reside on the
selected storage space are immediately displayed.
3. Right-click on a service that you want to delegate to the vRO server, and then
select Delegate to vRO, or click the Attach/Delegate button on the service. The
service color changes to indicate the successful delegation.
You can continue the process by right-clicking available services under the
current space.
Chapter 3. Operation and management
75
Figure 56. vRO server with delegated services
The vRO server provides indication for the allocated and used storage space.
v Allocated – amount of storage space available on all pools connected to the
delegated services.
v Used – amount of storage space used by workflows on all pools connected to
the delegated services.
Canceling service delegation to a vRO server
When required, you can cancel a storage service delegation to the vRO server.
About this task
Storage services, which delegation has been canceled, and their resources (pools)
are removed from the vRO inventory and cannot be used for workflows. Any
scheduled workflows, involving these elements, will fail to run.
Procedure
1. On the Interfaces pane, click the vRO server. The services that are currently
delegated to the vRO server are highlighted on the Spaces/Storage Services
pane.
2. Right-click on a service which delegation you want cancel, and then select
Cancel delegation to vRO , or click the Detach/Cancel Delegation button on
the service. The service color changes to indicate the successful detachment.
You can continue the process by right-clicking delegated services under the
current space.
Regenerating the vRO token
The vRO token used during installation of the IBM Storage Plug-in for vRO can be
regenerated.
About this task
If the communication link between the vRealize Orchestrator server and Spectrum
Control Base has been compromised, you can regenerate the vRO token and
reconfigure the IBM Storage Plug-in for vRO. For the plug-in installation
instructions, see “Downloading and installing the plug-in package for vRO” on
page 72.
76
IBM Spectrum Control Base Edition
Procedure
To regenerate the vRO token:
1. On the Interfaces pane, right-click the vRO server, and then select Modify. The
vRO Settings dialog box is displayed.
2. Click the Regenerate button. A new vRO token is regenerated.
Managing integration with vRealize Operations Manager
Before you can use the IBM Storage Management Pack for VMware vRealize
Operations Manager, you must set a connection to at least one vRealize Operations
Manager (vROps) server, and then define which storage systems should be
monitored in vROps.
After a vROps server connection is defined and storage systems are associated
with the vROps server, detailed monitoring information for these storage systems
becomes available in vROps (for more information, see Chapter 7, “Using the IBM
Storage Management Pack for VMware vRealize Operations Manager,” on page
113).
Note: In version 3.0.x, the IBM Storage Management Pack for VMware vRealize
Operations Manager does not support the DS8000 family storage systems.
To access these options, go to the Monitoring pane of Spectrum Control Base GUI.
You can then manage the integration with vROps as explained in the following
sections:
v “Downloading the vROps management package” on page 78.
v “Deploying the management package on vROps” on page 79.
v “Connecting the vROps server to Spectrum Control Base” on page 80.
v “Controlling storage system monitoring on the vROps server” on page 81.
Chapter 3. Operation and management
77
Figure 57. Monitoring pane
The vROps integration, except for the management package operations, can be
performed from the CLI as well, as explained in “CLI – Managing integration with
vRealize Operations Manager” on page 146.
Downloading the vROps management package
IBM Spectrum Control Base Edition provides management package in the form of
a PAK file which can be deployed on the vRealize Operations Manager.
About this task
Although vROps can display IBM Storage information even without the
management package (storage adapter) installation, the IBM Storage adapter is
required for displaying the dedicated dashboards, graphic icons, and user-friendly
attribute names for the IBM storage elements. The adapter is provided through a
PAK file that you need to download, as described in the following procedure.
Procedure
To download the PAK file from IBM Spectrum Control Base:
1. Go to Monitoring pane of the Spectrum Control Base GUI. The Set vROps
Server dialog box is displayed.
2. On the bottom of the dialog box, click Download PAK file.
78
IBM Spectrum Control Base Edition
Figure 58. Download PAK File button
Alternatively, you can download the package from the following directory on
Spectrum Control Base:
/opt/ibm/ibm_spectrum_control/downloads/static/IBM_Storage_Adapter3.0.0-x.pak, where x designates the current build number.
3. Save the file to your computer to later upload it to the vRealize Operations
Manager.
What to do next
See “Deploying the management package on vROps.”
Deploying the management package on vROps
After the management package is downloaded to the computer, it must be
deployed on the vRealize Operations Manager.
About this task
The management package must deployed on the vROps, as described below.
Procedure
To deploy the management package on the vROps:
1. After the management package is downloaded to the computer, access the
vRealize Operations Manager administrative web console using
https://hostname or IP address of the vROps UI.
2. Go to Administration > Solutions.
3. In the Solutions pane, click the plus sign on the top toolbar to add a new
management package. The Add Solution dialog box is displayed.
4. In the Add Solution dialog box, click Browse and select the management
package downloaded from Spectrum Control Base. After that, click Upload to
start deployment.
Chapter 3. Operation and management
79
Figure 59. Deploying the management package on the vROps
The IBM license agreement is displayed.
5.
Accept the IBM license agreement, click OK to continue. The confirmation
message is displayed.
6. Click OK to confirm the update. The vROps Manager displays a confirmation
message after the management package is deployed successfully.
Connecting the vROps server to Spectrum Control Base
After the management package is successfully deployed and described, you must
add the vROps Manager server to IBM Spectrum Control Base Edition.
About this task
The vRealize Operations Manager server must be connected to Spectrum Control
Base, as explained below.
Procedure
1. Go to the Monitoring pane.
2. Enter IP address or FQDN of the vRealize Operations Manager server, user
name, password and select the check box to confirm you have installed the
PAK file on the vROps Manager server; click Apply to save the settings.
80
IBM Spectrum Control Base Edition
Figure 60. Adding the vROps server to Spectrum Control Base
If the vROps server connection is successful, its color changes from gray to
green.
What to do next
See “Controlling storage system monitoring on the vROps server.”
Controlling storage system monitoring on the vROps server
The IBM storage systems connected to Spectrum Control Base must be added to
the vROps Manager as well to enable their monitoring.
About this task
To enable monitoring of the IBM storage systems, they must be added to the
vROps server. You can also remove the systems that do not require monitoring by
the vROps.
Procedure
To monitor the storage systems on the vROps server:
1. On the Monitoring pane, click the vROps server which you want to use for
monitoring.
2. In the Storage Systems pane, right-click a storage system that you intend to
monitor, and select Start vROps monitor..., or click the Start Monitoring button
on the storage system. The monitored system color changes to indicate the
connection to the vROps server. Spectrum Control Base starts pushing the
Chapter 3. Operation and management
81
information to vRealize Operations Manager, using HTTP post requests.
Figure 61. Storage system monitored by the vROps server
You can stop monitoring a storage system by clicking the Stop Monitoring
button on the monitored system.
You can prevent the vROps server from collecting performance data from the
monitored storage systems by toggling the Activate switch (
).The legend
below the vROps server specifies how many storage systems are being
monitored by the server out of total number of systems defined on Spectrum
Control Base. The color of the vROps server changes from dark to bright blue
in accordance with the number of monitored systems.
82
IBM Spectrum Control Base Edition
Chapter 4. Using the IBM Storage Provider for VMware VASA
This chapter focuses on how to use the IBM Storage Provider for VMware VASA
after the required configuration on IBM Spectrum Control Base Edition has been
completed.
After the IBM storage systems have been added to Spectrum Control Base, and
after the VASA access credentials were set (see “Required and optional initial
tasks” on page 21), you can start using the IBM Storage Provider for VMware
VASA by registering Spectrum Control Base on the relevant vCenter servers.
Registering Spectrum Control Base as a storage provider on vCenter
server
To use the IBM Storage Provider for VMware VASA solution component, you need
to register IBM Spectrum Control Base Edition as a storage provider on VMware
vCenter server.
Before you begin
v When the IBM Storage Provider for VMware VASA and the IBM Spectrum
Control storage provider, formerly known as IBM Tivoli® Storage Productivity
Center (TPC), are registered on the same VMware vCenter server, while the
same storage system is configured for both, vCenter uses IBM Spectrum Control
provider as the only source of information for that system's storage views on
vSphere Web Client.
In such a case, determine whether the IBM Spectrum Control capabilities are
sufficient for replacing the IBM Storage Provider for VMware VASA. If the IBM
Storage Provider for VMware VASA is still needed, IBM TPC 5.2 (or later)
provides a method of excluding storage systems from a specific storage provider,
allowing you to remove the system association with the IBM TPC provider.
v The date and time that are defined on both the vCenter server and on Spectrum
Control Base must be identical. To accurately synchronize the date and time
between the two servers, you can connect both to a Network Time Protocol
(NTP) server.
Note: VMware VASA 2.0 is required for implementing virtual volume
functionality.
About this task
The following procedure describes how to register Spectrum Control Base on a
single vCenter server by using vSphere Web Client.
Procedure
To register Spectrum Control Base on VMware vCenter server, complete the
following steps.
1. In vSphere Web Client, click vCenter > vCenter Servers, and click the vCenter
server, on which you want to register the IBM storage provider.
2. On the Manage tab, click Storage Providers.
© Copyright IBM Corp. 2013, 2016
83
3. Click the plus sign to add a new storage provider.
Figure 62. vSphere Web Client – Storage Providers list
The New Storage Provider dialog box is displayed.
4. Enter the name, URL, and pre-configured username and password (VASA
Secret) for accessing Spectrum Control Base (the VASA Secret is predefined as
explained in “Setting the VASA credentials” on page 53). The URL should be
entered in the ip:port format, specifying the relevant IP address and port
number of Spectrum Control Base:
v https://[Spectrum Control Base IP address]:8440/services/vasa1 for
VASA 1.0
v https://[Spectrum Control Base IP address]:8440/services/vasa for VASA
2.0
Note:
v In this example, "Spectrum Control Base IP address" stands for the IP address
or domain namespace of Spectrum Control Base .
v You can change the default TCP port (8440) at any time by running a script, as
explained in “Changing the Spectrum Control Base communication port” on
page 136.
Figure 63. New Storage Provider dialog box for VASA 2.0
5. Click OK. A security alert dialog box is displayed.
84
IBM Spectrum Control Base Edition
Figure 64. vCenter certificate thumbprint dialog box
6. Click Yes to accept the certificate. Spectrum Control Base is added to vCenter
Server.
Note: The certificate provides improved security by adding server authentication.
If, during the registration process, you have an active Spectrum Control Base
instance, restart your web browser or refresh the Spectrum Control Base GUI
window to ensure the successful acquisition of the new server certificate.
Figure 65. Storage Providers list displaying Spectrum Control Base
7. You can ensure continuous storage management by combining multiple
Spectrum Control Base instances, registered as storage providers, into
high-availability groups. This process is described in “Defining a
high-availability group” on page 37.
Chapter 4. Using the IBM Storage Provider for VMware VASA
85
Note: Storage spaces and services defined on an active storage provider do not
appear on the standby Spectrum Control Base. The spaces and services become
visible on the Spaces/Services pane of the Spectrum Control Base GUI, when it
becomes active after system failover.
What to do next
After Spectrum Control Base is registered as a storage provider on vCenter server,
you can start managing VMware storage resources on IBM storage systems via
vSphere Web Client. Complete the following tasks, referring to the relevant
VMware documentation for details.
1. Create a new VM storage policy to set requirements for the storage resources.
Note: During a VM storage policy creation, a VVol-enabled storage service is
exposed as a capability value of the IBM Storage Service entry. The storage space is
presented as a VVol container. This information is displayed in the storage
container:storage service format.
2. Add a new datastore.
3. Create a new virtual machine on the datastore.
86
IBM Spectrum Control Base Edition
Chapter 5. Using the IBM Storage Enhancements for VMware
vSphere Web Client
Together with supported IBM storage systems that are managed by IBM Spectrum
Control Base Edition, the deployed IBM Storage Enhancements enable the
following management features on vSphere Web Client for registered vCenter
servers:
v Full control over storage volumes, including volume creation, resizing,
renaming, mapping, unmapping, multipath policy enforcement, and deletion.
v Easy and integrated allocation of volumes to VMware datastores, used by virtual
machines that run on ESXi hosts, clusters, or datacenters.
Note:
v The IBM Storage Enhancements are automatically deployed and made available
for the vCenter servers that were registered (added) on IBM Spectrum Control
Base (see “Adding a vCenter server” on page 66).
v For information about the required vSphere user privileges, see “Required
vSphere privileges.”
See the following sections for more information:
v “Viewing the IBM storage object information” on page 89
v “Creating and mapping a new storage volume (LUN)” on page 94
v “Extending a volume” on page 99
v “Renaming a volume” on page 101
v “Setting multipath policy enforcement for a volume” on page 102
v “Unmapping a volume from one or more hosts” on page 103
v “Deleting an unused volume” on page 104
v “Displaying the virtual volume information” on page 105
Required vSphere privileges
To operate the IBM Storage Enhancements for VMware vSphere Web Client, you
must have the minimum required privileges defined in your vSphere user role.
Use the Role Manager extension in vSphere Web Client to define the required
privileges for your user role as detailed in the following table.
Table 8. Required vSphere privileges
Task
Required vSphere user privilege
Adding a vCenter server to the IBM Spectrum
Control Base
v Extension – In this category, select Register extension,
Unregister extension, and Update extension.
(see “Adding a vCenter server” on page 66)
v Global – In this category, select Log event and Cancel task.
Storage provisioning (volume creation and
management) from vSphere Web Client
(see Chapter 5, “Using the IBM Storage
Enhancements for VMware vSphere Web
Client”)
© Copyright IBM Corp. 2013, 2016
v Tasks – In this category, select Create task and Update task.
v Sessions – In this category, select Impersonate user.
v Host – In this category, select Configuration > Storage partition
configuration.
87
Figure 66. VMware vSphere Web Client – Create Role dialog box
For more detailed information about how to set the vSphere Web Client privilege
types, refer to the VMware vSphere 5.1 Documentation Center
(pubs.vmware.com/vsphere-51/index.jsp ).
88
IBM Spectrum Control Base Edition
Viewing the IBM storage object information
After the IBM Storage Enhancements for VMware vSphere Web Client are properly
installed, the IBM Storage categories are shown under the standard vSphere Web
Client categories for each vCenter server, as shown in the following figure.
Figure 67. IBM Storage categories in vSphere Web Client
For each vCenter server, the following IBM Storage categories are available for that
vCenter server:
v Storage services
v Storage spaces
v Storage volumes
v Storage virtual volumes (VVols)
You can click and open an IBM Storage category to view the entities which are
currently available for the selected vCenter server.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
89
Figure 68. IBM Storage Service information
Figure 69. IBM Storage Space information
90
IBM Spectrum Control Base Edition
Figure 70. IBM Storage Volume information
Figure 71. IBM Storage VVol information
In addition, you can display a summary of IBM storage items, as well as
information on objects related to them, as shown in the following figures.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
91
Figure 72. IBM Storage Service summary
Figure 73. IBM Storage Space summary
92
IBM Spectrum Control Base Edition
Figure 74. IBM Storage Volume summary
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
93
Figure 75. IBM Storage VVol summary
And so on, click the other information categories that are available in vSphere to
view the relevant IBM storage information in these categories as well.
Creating and mapping a new storage volume (LUN)
The IBM Storage Enhancements for VMware vSphere Web Client allow you to
create new volumes (LUNs) directly from the vSphere Web Client interface. These
volumes can be used as storage devices in the vSphere environment.
About this task
Any created volume is mapped to either ESXi hosts, clusters, or datacenters, so
that the virtual machines on these hosts, clusters, or datacenters would be able to
save datastore information on that volume. The volume is created on a storage
service, according to the service definitions from Spectrum Control Base.
In addition to single volume creation, you can create multiple volumes
simultaneously. If you choose this option, the created volumes are appended with
differently numbered suffixes that are automatically generated by the system in
consecutive order.
Important:
v You can create volumes only on storage pools that have been attached to the
relevant vCenter server on the Spectrum Control Base side. For more
information, see “Managing integration with vSphere Web Client” on page 66
v The ESXi hosts and clusters to which you map the created volumes must be
predefined on the storage system side. For more information, refer to your IBM
storage system documentation.
94
IBM Spectrum Control Base Edition
Procedure
1. In vSphere Web Client, navigate to the relevant vCenter server and then to the
specific IBM storage object (space, service or volume). The IBM storage object
and the relevant storage resources (pools) should already be associated with
the vCenter server (see “Viewing the IBM storage object information” on page
89).
2. Go to the Getting Started tab of an IBM Storage Services or IBM Storage
Volumes entry.
3. Click Create a new IBM Storage Volume. Alternatively, select a storage object,
and click Actions > Create New Volume.
Figure 76. IBM storage service view – Clicking Create New Volume
Figure 77. Top Level Objects view – Clicking Create a new IBM Storage volume
The Create New Volume dialog box is displayed.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
95
Figure 78. Create New Volume wizard (XIV example)
Note: When you create a single volume, a LUN (logical unit number) is assigned
to that volume, and you can later change the LUN assignment. If you create
multiple volumes, LUNs (logical unit numbers) are automatically assigned to those
volumes and cannot be modified later.
4. In the Volume Size text box, enter the size for the new volume.
Note:
v It is recommended to define the size of an XIV volume in a multiple of 17 GB.
The Volume Size box appears with a yellow rectangle around it if the size value
is not a multiple of 17 GB. The XIV Recommended Volume Size (GB)
information is displayed below.
v A storage resource with largest amount of free space, which is currently attached
the service, is automatically selected.
v The minimum size for compressed XIV volumes is 87 GB, and their
recommended size is 103 GB.
5. In the Volume Name text box, enter the name that you want to assign to the
new volume.
6. If you want to create multiple volumes simultaneously: In the Number of
Volumes text box, enter the number of volumes that you want to create
simultaneously. The text box next to the Volume Name entry displays vol_{1}
by default. The {1} represents the suffix value, and it must be kept as part of
the volume name. You edit the volume name and also move the suffix value
within the name (the {1} suffix does not have to be at the end of the volume
name).
96
IBM Spectrum Control Base Edition
Figure 79. Creating multiple volumes
7. In the Storage Service text box, select a storage service, on which the volume
will be created.
Figure 80. Selecting storage service
8. From Host Mapping, select the host(s), cluster(s), or datacenter(s) to which
you want to map the new volume. You can click Custom to specify a custom
mapping in the Advanced Host Mapping dialog box.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
97
Figure 81. Advanced Host Mapping dialog box
Note: Any ESXi host that is connected to the storage system can be selected. Hosts
that are not connected to the storage system are marked and a message notifies
you about any connectivity problem. If you select a datacenter, its member clusters
and hosts are automatically selected under it.
Important: You must map the volume to at least one ESXi host, cluster, or
datacenter in order to enable vSphere management of the created volume.
9. If you are creating a single volume, you can select the LUN that should
represent the new volume on the storage system, or keep the automatically
selected LUN. The LUNs are automatically selected when creating multiple
volumes.
98
IBM Spectrum Control Base Edition
Figure 82. Selecting LUN
Note: After the volume is created, the specific LUN association cannot be changed,
and the same number cannot be assigned to a different volume. The specific LUN
can become available for reassignment only after its associated volume is deleted.
10. Review the details of the new volume that is about to be created, and then
click OK to confirm its creation as detailed.
Extending a volume
If enough free space is available on the relevant storage pool, you can extend the
size of an existing volume.
Procedure
Complete the following procedure to extend the size of a volume.
1. In vSphere Web Client, locate a volume that you want to extend:
v Go to IBM Storage Services, select a service that contains the volume, open
the Related Objects tab, and select the required volume row, or
v Go to IBM Storage Volumes, select the required volume.
2. Right-click the volume and choose Extend or use the Actions menu to select
Extend.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
99
Figure 83. Clicking Extend on the pop-up menu
The Extend Volume dialog box is displayed.
3. In the Volume Size text box, enter the new size for the volume. Alternatively,
place the mouse pointer on the graphic image of the storage pool, and then
click and slide the space marker rightward to set the new volume size. The
numerical value in Volume Size is automatically updated accordingly.
Figure 84. Extend Volume dialog box
4. Click OK.
Important: Extending the size of a volume does not automatically increase the
datastore capacity.
100
IBM Spectrum Control Base Edition
Renaming a volume
Whenever required, you can rename any existing volume by performing the
following procedure.
About this task
Renaming a volume is a logical action that does not have any physical effect on
the volume or its logical connections. Renaming a volume also changes its
displayed name in the vSphere environment.
Procedure
1. In vSphere Web Client, locate a volume that you want to rename:
v Go to IBM Storage Services, select a service that contains the volume, open
the Related Objects tab, and select the required volume row, or
v Go to IBM Storage Volumes, select the required volume.
2. Right-click the volume and choose Rename or use the Actions menu to select
Rename.
The Rename Volume dialog box is displayed.
Figure 85. Rename volume option
Figure 86. Rename Volume dialog box
3. Enter the new name that you want to assign to the volume, and then click OK.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
101
Setting multipath policy enforcement for a volume
You can set the multipath policy enforcement for a single volume.
About this task
By default, the Round Robin multipath policy is enforced on volumes. You can
disable or change this enforcement for a specific volume if needed.
Note: If you are using ESXi version 5.1 or earlier with DS8000 or Storwize Family
systems, see “Setting the multipath policy for DS8000 and Storwize Family
systems” on page 159.
Procedure
1. In vSphere Web Client, locate a volume for which you want to change the
enforcement:
v Go to IBM Storage Services, select a service that contains the volume, open
the Related Objects tab, and select the required volume row, or
v Go to IBM Storage Volumes, select the required volume.
2. Right-click the volume and choose Set Multipath Policy Enforcement or use
the Actions menu to select Set Multipath Policy Enforcement.
The Change Multipath Policy Enforcement dialog box is displayed.
Figure 87. Set Multipath Policy Enforcement option
102
IBM Spectrum Control Base Edition
Figure 88. Change Multipath Policy Enforcement dialog box
3. Select the required option and then click OK.
Important: After the policy is set, it is enforced by overriding any existing policy
for this volume.
Unmapping a volume from one or more hosts
When volumes or ESXi hosts are no longer needed, or if new ones are to replace
the current ones, you can unmap volumes from the hosts.
About this task
Important: A volume (LUN) must remain mapped to at least one host. Otherwise,
you cannot view the volume or perform any actions on it from vSphere Web
Client.
Procedure
1. In vSphere Web Client, locate a volume that you want to unmap:
v Go to IBM Storage Services, select a service that contains the volume, open
the Related Objects tab, and select the required volume row, or
v Go to IBM Storage Volumes, select the required volume.
2. Right-click the volume and choose Unmap or use the Actions menu to select
Unmap.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
103
Figure 89. Unmap volume
The Unmap Volume dialog box is displayed.
3. Select the hosts or clusters from which you want to unmap the volume, and
then click OK.
Deleting an unused volume
When a storage volume is unused and no longer required, you can delete it.
Before you begin
Important: You cannot delete volumes that are currently used by datastores or as a
raw-mapped LUN.
Procedure
1. In vSphere Web Client, locate a volume that you want to delete:
v Go to IBM Storage Services, select a service that contains the volume, open
the Related Objects tab, and select the required volume row, or
v Go to IBM Storage Volumes, select the required volume.
2. Right-click the volume and choose Delete or use the Actions menu to select
Delete.
104
IBM Spectrum Control Base Edition
Figure 90. Delete volume
The Delete Volume confirmation message is displayed.
3. Click OK to confirm the deletion, or Cancel to exit without deleting the
volume.
Note: A volume, whose deletion fails, disappears from the volume list. The
volume reappears in the list after the next population.
Displaying the virtual volume information
If virtual volumes are used as storage resources for virtual machines, you can view
the VVol summary, snapshot information and details of VMs which are using
them.
Before you begin
Verify that a virtual machine has been created on a VVol datastore.
Procedure
1. In vSphere Web Client Navigator, go to IBM Storage VVols and select a virtual
volume that you intend to view.
2. In the right-hand pane, select one of the following tabs:
v Getting Started to review general information on IBM's implementation of
VMware virtual volume technology.
v Summary to display the general information about the virtual volume and
its characteristics.
v Monitor to view the snapshot status, if this functionality is enabled.
v Related Objects to list the VMs which are using the VVol.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
105
Figure 91. VVol Summary tab
Figure 92. VVol Related Objects tab
106
IBM Spectrum Control Base Edition
Important:
Some operations on VVol-based VMs with deployed Spectrum Control Base
instance, such as hard disk removal, may result in the Invalid Virtual Machine
configuration message, displayed by the vWC. This message is not related to the
VM functionality and indicates a loss of connectivity between the Spectrum
Control Base and the vCenter server.
Chapter 5. Using the IBM Storage Enhancements for VMware vSphere Web Client
107
108
IBM Spectrum Control Base Edition
Chapter 6. Using the IBM Storage Plug-in for VMware vRealize
Orchestrator
Use the IBM Storage Plug-in for VMware vRealize Orchestrator to include IBM
Storage discovery and provisioning in your vRealize Orchestrator (vRO)
automation workflows.
Note: In version 3.0.x, the IBM Storage Plug-in for VMware vRealize Orchestrator
does not support the DS8000 family storage systems..
After the IBM Storage Plug-in is deployed (see “Downloading and installing the
plug-in package for vRO” on page 72), the IBM storage objects become available in
the vRO, as detailed in the table below.
Table 9. IBM storage objects and events in vRO
Object
Attribute
Type
StorageSpace
name
String
description
String
numServices
long
numVolumes
long
physicalSize
long
physicalFree
long
name
String
description
String
physicalSize
long
physicalFree
long
capabilityValues
String
maxResourceLogicalFree
long
name
String
spaceName
String
serviceName
String
serviceCompliance
String
poolName
String
domainName
String
array
String
storageModel
String
logicalCapacity
long
usedCapacity
long
StorageService
StorageVolume
The Orchestrator workflows, supported by the IBM storage objects are as follows:
v Create and map a volume
v Delete a volume
v Extend a volume
© Copyright IBM Corp. 2013, 2016
109
v Map a volume
v Unmap a volume
Follow these guidelines for vRO workflows:
v Volume creation: the allowed volume sizes are set in whole numbers. Any
number after a decimal point is ignored by the vRO. For example, when the
volume size is set to 1.6 GB, the 1 GB volume is created.
v Volume extension: the allowed volume sizes are set in whole numbers. Any
number after a decimal point is ignored by the vRO. For example, when the
volume size is extended to 3.6 GB, the volume size is set to 3 GB.
v Volume mapping is performed by passing initiators to the workflow. If a host
definition at the storage system includes two initiators, only one of them is
passed by the workflow, when it is run. Also, a volume must be mapped to all
hosts using the same LUN.
The following figures display the IBM Storage workflows and elements in vRO.
Figure 93. vRealize Orchestrator – available workflows – General tab
110
IBM Spectrum Control Base Edition
Figure 94. vRealize Orchestrator – available objects
For information about how to initiate workflows in vRealize Orchestrator, refer to
the relevant VMware documentation.
Chapter 6. Using the IBM Storage Plug-in for VMware vRealize Orchestrator
111
112
IBM Spectrum Control Base Edition
Chapter 7. Using the IBM Storage Management Pack for
VMware vRealize Operations Manager
Use the IBM Storage Management Pack for VMware vRealize Operations Manager
to obtain comprehensive monitoring information about the IBM storage resources
that are utilized in your virtualized environment.
About this task
After successfully configuring Spectrum Control Base with vRealize Operations
Manager, it periodically starts sending the storage system information to vRealize
Operations Manager. You can view the detailed IBM storage dashboards, together
with the graphical relationships between the storage elements (storage systems,
ports, storage pools, volumes) and virtual elements (datastores, virtual machines,
hosts) in a drill-down interactive style.
Note: In version 3.0.x, the IBM Storage Management Pack for VMware vRealize
Operations Manager does not support the DS8000 family storage systems.
Three main dashboards are available for IBM storage systems:
v “Overview dashboard” on page 115
v “Performance dashboard” on page 118
v “Top 10 dashboard” on page 126
In addition, you can:
v Monitor storage system resources. See “Displaying the overview of IBM storage
objects” on page 127.
v Define thresholds and alerts for storage resources and metrics in the Overview
and Performance dashboards. See “Defining thresholds and alerts for storage
objects” on page 128.
Procedure
To view the IBM storage dashboards, complete the following steps.
1. Log in to vRealize Operations Manager user interface.
2. Click Dashboard List > IBM Storage and select the required dashboard.
© Copyright IBM Corp. 2013, 2016
113
Figure 95. vROps GUI – IBM STORAGE option
The selected dashboard is displayed. The following icons are used to represent
the IBM storage elements.
Table 10. IBM Storage Icons in vROps.
Icon
Description
IBM storage adapter
IBM storage system
IBM storage system, running Spectrum
Virtualize
IBM disk
IBM MDisk
IBM domain
IBM host
IBM Host Fibre Channel (FC) initiator
114
IBM Spectrum Control Base Edition
Table 10. IBM Storage Icons in vROps (continued).
Icon
Description
IBM host iSCSI initiator
IBM module
Flash canister
Flash enclosure
Flash card
IBM module FC port
IBM module iSCSI port
IBM pool
IBM child pool
IBM volume
IBM I/O group
Overview dashboard
The Overview dashboard presents relationships between all virtual elements and
storage elements that are in use.
Procedure
To display IBM storage resource overview:
1. In the Overview dashboard, click a storage system in the Storage Systems
pane. The list of all the resources related to the selected storage system are
displayed in the right pane of the Overview dashboard. The resources include
virtual machines, host systems, datastores, volumes, pools, storage systems
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
115
(arrays), hosts, FC initiators, FC ports, iSCSI initiators, iSCSI ports, modules,
flash canisters, flash enclosures, flash cards and disks.
The alert widget is detailed in “Using the alert widget” on page 117.
Figure 96. IBM Spectrum Accelerate Storage Systems pane
2. Move the mouse pointer over a resource element or click on it to select it. A
tooltip is displayed, detailing the element name and its health score. The health
score is calculated automatically by the vROps Manager, according to the
number of alarms and statistic information. However, disk health score is based
on the health.requires service metric.
116
IBM Spectrum Control Base Edition
Figure 97. IBM Spectrum Accelerate volume health status
3. Double-click on a selected resource element to display the resource details
(health tree, metrics, etc). These are detailed in the Performance dashboard
below.
Using the alert widget
The Storage System Alerts (All Arrays) widget is located at the lower-left pane of
the Overview dashboard. This widget displays alerts generated by all storage
systems, monitored by the vROps server.
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
117
Figure 98. Alert widget
By default, the events are pushed by the IBM storage adapter to the vRealize
Operations Manager every 10 minutes.
Performance dashboard
Performance dashboard provides health and performance information for the IBM
storage resources.
About this task
Performance information presented in the dashboard is collected for a time period
defined by the vcops_push_interval parameter in the vcops_config.ini file (the
default time period is 5 minutes). This period can be changed, as explained in
“Adjusting system update interval” on page 134.
Procedure
To display performance information:
1. In the Virtual Machines pane of the Performance dashboard, locate a relevant
virtual machine and select it.
2. In the Storage System and vCenter Relationships pane, select an object, which
performance you intend to monitor.
118
IBM Spectrum Control Base Edition
Figure 99. Virtual Machines and XIV and vCenter Relations panes
The HEALTH TREE pane displays the selected element and its relation to other
storage resources in an hierarchical manner.
Figure 100. HEALTH TREE pane
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
119
3. In the HEALTH TREE pane, select a resource element to display all relevant
performance metrics in the METRIC SELECTOR pane. Different metric types
are available for different resource elements, as detailed in “Performance
metrics.”
4. Select a metrics of an element to display its metric graph in the METRIC
GRAPH pane.
Figure 101. METRIC SELECTOR and METRIC GRAPH panes of the Performance dashboard
Performance metrics
Metrics data available in the Performance dashboard provides health and
performance information for the IBM storage objects.
Different metric types are available for different storage elements, as detailed in
tables below.
120
IBM Spectrum Control Base Edition
Table 11. Capacity metrics
Metrics
Description
Relevant storage object
Hard (GB)
Hard size (actual physical capacity) of the storage object Volume, Pool, Array
Soft (GB)
Soft size (maximum capacity) of the storage object, as
seen by the hosts
Utilization Hard (%)
Utilization ratio of the hard capacity
Utilization Soft (%)
Utilization ratio of the soft capacity
Free Hard (GB)
Free hard size of the storage system (array)
Free Soft (GB)
Free soft size of the storage system
Over Provisioning
Ratio (%)
The ratio between virtual capacity and real capacity of
the pool
Pool
Compression Ratio (%)
Volume compression ratio, calculated as 1–(compressed
volume size/uncompressed volume size)
Volume
Compression Saving
(GB)
Volume compression savings, calculated as (number of
17GB uncompressed partitions in use – number of 17GB
partitions in use)/1000
Effective (GB)
Potential capacity of the storage object
Physical (GB)
Actual physical capacity of the storage object
Array
IBM FlashSystem
A9000/A9000R Array or Volume
Utilization Effective (%) Utilization ratio of the effective capacity
Utilization Physical (%) Utilization ratio of the physical capacity
Thin Provisioning
Savings (%)
Total savings achieved due to thin provisioning
Free Effective (GB)
Free effective size of the storage system
Free Physical (GB)
Free physical size of the storage system
Compression Factor
Ratio between unique data (after deduplication) and
actual stored data
IBM FlashSystem
A9000/A9000R Array
Data Reduction Savings Total savings achieved due to data reduction
(%)
Total Stored (GB)
Actual size of data currently stored on the system
Total Written (GB)
Total amount of data written by hosts before
compression or deduplication
Estimated Compression Ratio between unique data and physical data
Factor
Estimated
Deduplication Factor
Ratio between written and unique data
Estimated Minimum
Delete Size (GB)
Amount of unique written data divided by estimated
compression factor
Estimated Data
Reduction Savings (%)
Estimated savings due to data reduction
IBM FlashSystem
A9000/A9000R Volume
Table 12. Health metrics
Metrics
Description
Relevant storage object
Connected
Connection status of the object
Host, Host FC Initiator, Host
iSCSI Initiator
Status
Health status of the module
Module, IBM Spectrum
Virtualize MDisk
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
121
Table 12. Health metrics (continued)
Metrics
Description
Relevant storage object
Requires Service
Heath status of the disk. The REPLACE value indicates
disk failure.
Disk
Online
Connection status of the object. For IBM Spectrum
Virtualize Host, the status can be as follows:
Module FC Port, Module iSCSI
Port, IBM Spectrum Virtualize
Node FC Port, IBM Spectrum
Virtualize Node iSCSI Port, IBM
Spectrum Virtualize Host
v 0 – Offline
v 5 – Excluded
v 10 – Degraded
v 20 – Is Online
Table 13. Counter metrics
Metrics
Description
Relevant storage object
Hosts Count
Total number of hosts connected to the storage system
Volumes Count
Total number of volumes existing in the storage system
Array, IBM Spectrum Virtualize
I/O Group
Mirror Relations Count Total number of mirror relations (master or slave) existing Array
in the storage system
Pools Count
Total number of pools existing in the storage system
Snapshots Count
Total number of snapshots existing in the storage system
Volumes and
Snapshots Count
Total number of volumes and snapshots existing in the
storage system
Nodes Count
Total number of nodes in the I/O group
122
IBM Spectrum Control Base Edition
IBM Spectrum Virtualize I/O
Group
Table 14. Performance metrics
Metrics
Description
Relevant storage object
Total IOPS
Total number of IOPS performed by the object
Total Read IOPS
Total number of read IOPS performed by the object
Array, Host FC Initiator, Host
iSCSI Initiator, Module FC Port,
Module iSCSI Port
Total Write IOPS
Total number of write IOPS performed by the object
Read Hit Large IOPS
Number of IOPS for 64–512 KB packets read from cache
Read Hit Medium
IOPS
Number of IOPS for 8–64 KB packets read from cache
Read Hit Small IOPS
Number of IOPS for 0–8 KB packets read from cache
Read Hit Very Large
IOPS
Number of IOPS for over 512 KB packets read from
cache
Read Miss Large IOPS
Number of IOPS for 64–512 KB packets read from disk
Read Miss Medium
IOPS
Number of IOPS for 8–64 KB packets read from disk
Read Miss Small IOPS
Number of IOPS for 0–8 KB packets read from disk
Read Miss Very Large
IOPS
Number of IOPS for over 512 KB packets read from disk
Write Hit Large IOPS
Number of IOPS for 64–512 KB packets written to cache
Write Hit Medium
IOPS
Number of IOPS for 8–64 KB packets written to cache
Write Hit Small IOPS
Number of IOPS for 0–8 KB packets written to cache
Write Hit Very Large
IOPS
Number of IOPS for over 512 KB packets written to
cache
Write Miss Large IOPS Number of IOPS for 64–512 KB packets written to disk
Write Miss Medium
IOPS
Number of IOPS for 8–64 KB packets written to disk
Write Miss Small IOPS
Number of IOPS for 0–8 KB packets written to disk
Write Miss Very Large
IOPS
Number of IOPS for over 512 KB packets written to disk
Average Latency
Average response time
Average Write Latency
Average response time of a write operation
Average Read Latency
Average response time of a read operation
Read Hit Large
Latency
Response time of cache read operations for 64–512 KB
packets
Read Hit Medium
Latency
Response time of cache read operations for 8–64 KB
packets
Read Hit Small
Latency
Response time of cache read operations for 0–8 KB
packets
Read Hit Very Large
Latency
Response time of cache read operations for over 512 KB
packets
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
123
Table 14. Performance metrics (continued)
Metrics
Description
Relevant storage object
Read Memory Hit
Large Latency
Response time of DRAM cache read operations for
64–512 KB packets
Array
Read Memory Hit
Medium Latency
Response time of DRAM cache read operations for 8–64
KB packets
Read Memory Hit
Small Latency
Response time of DRAM cache read operations for 0–8
KB packets
Read Memory Hit Very Response time of DRAM cache read operations for over
Large Latency
512 KB packets
Read Miss Large
Latency
Response time of disk read operations for 64–512 KB
packets
Read Miss Medium
Latency
Response time of disk read operations for 8–64 KB
packets
Read Miss Small
Latency
Response time of disk read operations for 0–8 KB packets
Read Miss Very Large
Latency
Response time of disk read operations for over 512 KB
packets
Write Hit Large
Latency
Response time of cache write operations for 64–512 KB
packets
Write Hit Medium
Latency
Response time of cache write operations for 8–64 KB
packets
Write Hit Small
Latency
Response time of cache write operations for 0–8 KB
packets
Write Hit Very Large
Latency
Response time of cache write operations for over 512 KB
packets
Write Miss Large
Latency
Response time of disk write operations for 64–512 KB
packets
Write Miss Medium
Latency
Response time of disk write operations for 8–64 KB
packets
Write Miss Small
Latency
Response time of disk write operations for 0–8 KB
packets
Write Miss Very Large
Latency
Response time of disk write operations for over 512 KB
packets
Total Throughput
Total bandwidth
Total Read Throughput Total bandwidth used by read operations
Total Write
Throughput
Total bandwidth used by write operations
Read Hit Large
Throughput
Bandwidth used by cache read operations for 64–512 KB
packets
Read Hit Medium
Throughput
Bandwidth used by cache read operations for 8–64 KB
packets
Read Hit Small
Throughput
Bandwidth used by cache read operations for 0–8 KB
packets
Read Hit Very Large
Throughput
Bandwidth used by cache read operations for over 512
KB packets
124
IBM Spectrum Control Base Edition
Array, Host FC Initiator, Host
iSCSI Initiator, Module FC Port,
Module iSCSI Port
Table 14. Performance metrics (continued)
Metrics
Description
Relevant storage object
Read Memory Hit
Large Throughput
Bandwidth used by DRAM cache read operations for
64–512 KB packets
Array
Read Memory Hit
Medium Throughput
Bandwidth used by DRAM cache read operations for
8–64 KB packets
Read Memory Hit
Small Throughput
Bandwidth used by DRAM cache read operations for 0–8
KB packets
Read Memory Hit Very Bandwidth used by DRAM cache read operations for
Large Throughput
over 512 KB packets
Read Miss Large
Throughput
Bandwidth used by disk read operations for 64–512 KB
packets
Read Miss Medium
Throughput
Bandwidth used by disk read operations for 8–64 KB
packets
Read Miss Small
Throughput
Bandwidth used by disk read operations for 0–8 KB
packets
Read Miss Very Large
Throughput
Bandwidth used by disk read operations for over 512 KB
packets
Write Hit Large
Throughput
Bandwidth used by cache write operations for 64–512 KB
packets
Write Hit Medium
Throughput
Bandwidth used by cache write operations for 8–64 KB
packets
Write Hit Small
Throughput
Bandwidth used by cache write operations for 0–8 KB
packets
Write Hit Very Large
Throughput
Bandwidth used by cache write operations for over 512
KB packets
Write Miss Large
Throughput
Bandwidth used by disk write operations for 64–512 KB
packets
Write Miss Medium
Throughput
Bandwidth used by disk write operations for 8–64 KB
packets
Write Miss Small
Throughput
Bandwidth used by disk write operations for 0–8 KB
packets
Write Miss Very Large
Throughput
Bandwidth used by disk write operations for over 512
KB packets
Aborts
Total number of I/Os aborted during the current
mirroring operation
Failures
Total number of I/Os failed during the current mirroring
operation
Array, Host FC Initiator, Host
iSCSI Initiator, Module FC Port,
Module iSCSI Port
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
125
Table 14. Performance metrics (continued)
Metrics
Description
Relevant storage object
Read Operations
Number of read operations per second
IBM Spectrum Virtualize Vdisk
Write Operations
Number of write operations per second
Read Blocks
Number of blocks read per second (in MB)
Write Blocks
Number of blocks written per second (in MB)
Average Read
Response Time
Average response time for disk reads per read operation
Average Write
Response Time
Average response time for disk writes per write
operation
Worst Read Response
Time Since Last
Statistics Collection
Worst response time for disk reads within the last
statistics collection sample period
Worst Write Response
Time Since Last
Statistics Collection
Worst response time for disk writes within the last
statistics collection sample period
Average Transfer
Response Time
Average transfer latency for both read and write
operations
System CPU
Utilization
CPU busy percentage for I/O process cores
Compression CPU
Utilization
CPU busy percentage for compression process cores
IBM Spectrum Virtualize Node
Top 10 dashboard
The IBM Top 10 dashboard represents top ten IBM volumes and hosts in all
storage systems monitored by the vROps Manager.
The IBM XIV, IBM Spectrum Accelerate and IBM FlashSystem A9000 Top 10
dashboards include the following information:
v Top 10 volumes by IOPS (last hour)
v Top 10 volumes by IOPS (last 24 hours)
v Top 10 volumes by throughput (last hour)
v Top 10 volumes by throughput (last 24 hours)
v Top 10 hosts by IOPS (last hour)
v Top 10 hosts by IOPS (last 24 hours)
v Top 10 hosts by throughput (last hour)
v Top 10 hosts by throughput (last 24 hours)
The Top 10 dashboards for the storage systems that run Spectrum Virtualize
include the following information:
v Top 10 VDisks by read operations per second (last hour)
v Top 10 VDisks by write operations per second (last hour)
v Top 10 VDisks by read blocks per second (last hour)
v Top 10 VDisks by write blocks per second (last hour)
v Top 10 VDisks by worst read response in us since last statistics collection
v Top 10 VDisks by worst write response in us since last statistics collection
v Top 10 VDisks by average transfer response time in us (last hour)
126
IBM Spectrum Control Base Edition
You can double-click on any resource element (disk, host or VDisk) to display its
details.
Figure 102. IBM XIV Top 10 dashboards
Displaying the overview of IBM storage objects
You can display the overview of IBM storage objects, including its health, risk and
efficiency status, and other attributes in a centralized manner, using the vROps
Environment display.
Procedure
To display the overview of IBM storage objects:
1. Click Environment > All Objects > IBM Storage Adapter. The list of IBM
storage objects is displayed in the left-hand pane of the vROps Manager.
2. In the IBM storage object list, select an object that you intend to monitor. The
overview of the selected object status is displayed in the right-hand pane of the
vROps Manager.
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
127
Figure 103. Overview of an IBM FlashSystem A9000 flash canister
Defining thresholds and alerts for storage objects
The vROps Manager maintains thresholds of normal behavior for each storage
element.
About this task
The vROps Manager alerts the user, when a metric violates a threshold. The
thresholds can be set to fit the needs of the user. Afterward, you can define an
alert to be triggered, when the threshold is crossed, changing the color of the
storage object in the Overview and Performance dashboards. In addition, you can
use the storage object metrics as Key Performance Indicator (KPI).
Procedure
To set thresholds and define their alerts:
1. Go to Content > Symptom Definitions > Metric/Property Symptom
Definitions.
2. In the right-hand pane of the Metric/Property Symptom Definitions dialog
box, click on the '+' sign to add a new symptom definition. The Add
Symptom Definition dialog box is displayed.
3. In the Base Object Type drop-down list, select IBM Storage Adapter, and
then choose a storage element and a metrics, which thresholds you intend to
define.
4. Double-click the metrics related to the selected storage resource, or drag it to
the working area of the right-hand pane. The selected object and metrics
attributes are displayed.
128
IBM Spectrum Control Base Edition
Figure 104. Add Symptom Definition dialog box
5. Enter the symptom definition name, criticality level, threshold triggering
condition, wait cycle and cancel cycle values. Then click Save to add the
symptom definition.
6. Go to Content > Alert Definitions, click on the '+' sign to add a new alert
definition. The Alert Definition Workspace dialog box is displayed.
7. In the left-hand pane of the Alert Definition Workspace dialog box, enter
alert name and description.
Figure 105. Adding name and description for alert definition
8. Click Base Object Type and in the drop-down list, select IBM Storage
Adapter, and then choose a storage element and a metrics, to which you
intend to create an alert.
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
129
Figure 106. Selecting base object type for alert definition
9. Click Alert Impact and enter impact, criticality, alert type/subtype, wait cycle
and cancel cycle values for the alert.
Figure 107. Selecting impact for alert definition
10. Click Add Symptom Definition, enter Self for the Defined On parameter,
Metric/Property for the Symptom Definition Type parameter, locate the
previously defined symptom in the Symptom list and add it to the alert
definition by dragging it to the Symptoms area on the right-hand pane.
130
IBM Spectrum Control Base Edition
Figure 108. Adding symptom for alert definition
11. Click Save to save the changes. After the duration of wait cycle that you
defined has elapsed, the storage object color on a dashboard changes, if the
metrics threshold was crossed. Storage objects display different colors,
according to the criticality of symptoms:
v Info –
v Warning –
v Immediate –
v Critical –
12. Navigate to Administration > Policies.
13. In the Policies pane, click the Policy Library tab, select the Default Policy
entry and click the Edit button. The Edit Monitoring Policy dialog box is
displayed.
Chapter 7. Using the IBM Storage Management Pack for VMware vRealize Operations Manager
131
Figure 109. Editing default monitoring policy
14. In the Edit Monitoring Policy dialog box, leave the configuration steps 1 to 4
unchanged.
15. In the left-hand pane of the Edit Monitoring Policy dialog box, select Collect
Metrics and Properties. The list of attributes is displayed in the right-hand
pane of the dialog box.
16. In the list of attributes, filter by the object type to locate the storage object
used for alert definitions, then select the metrics that you want to use as a Key
Performance Indicator, set its KPI to Yes, and click Save to finish.
Figure 110. Enabling KPI for a storage object metrics
132
IBM Spectrum Control Base Edition
Chapter 8. Administration
This chapter details common administrative tasks that can be performed when
using the IBM Spectrum Control Base Edition.
See the following sections for more information:
v “Checking and controlling the Spectrum Control Base service”
v “Checking and modifying the configuration files” on page 134
v “Changing the Spectrum Control Base communication port” on page 136
Checking and controlling the Spectrum Control Base service
At any time, you can check whether the IBM Spectrum Control Base Edition
service runs properly on the Linux host. You can also stop and then start the
service if needed.
Procedure
1. Log on to the Linux command prompt environment as a root user.
Important: Only root users can complete service operations.
2. Enter the following command: service ibm_spectrum_control status. The
status of the Celery and Django services is displayed.
[root@ibmsc]# service ibm_spectrum_control status
Celery services are running...
Django service is running...
vWC refresh service is running...
What to do next
If you want to stop the Spectrum Control Base service, use the stop command:
[root@ibmsc]# service ibm_spectrum_control stop
Stopping ibm_spectrum_control (via systemctl): [
OK
]
To start the service again, use the start command:
[root@ibmsc]# service ibm_spectrum_control start
Starting ibm_spectrum_control (via systemctl): [ OK
]
If you want to stop and then start the Spectrum Control Base service in one
command, use the restart command:
[root@ibmsc]# service ibm_spectrum_control restart
Restarting ibm_spectrum_control (via systemctl): [ OK
© Copyright IBM Corp. 2013, 2016
]
133
Checking and modifying the configuration files
IBM Spectrum Control Base Edition has several configuration files that store
configuration settings that you can change manually if needed.
You can view and modify the contents of each file with any standard text editor,
according to the purpose and contents of each file.
After modifying a configuration file, you must restart the Spectrum Control Base
service by running the following CLI command on the Linux host:
service ibm_spectrum_control restart
For more information about this service, see “Checking and controlling the
Spectrum Control Base service” on page 133.
Table 15. Configuration files
File name
Directory location
Purpose or relevant parameters
ibmsyslog.conf
/opt/ibm/ibm_spectrum_control/conf.d/
Defines the logging standard per application,
as well as the target of the log messages.
ibmlogs-rotate
/opt/ibm/ibm_spectrum_control/conf.d/
Controls the archive and renewal timing
attributes of the log files. For the list of log
files, see “Checking the log files” on page 153.
ldap.ini
/opt/ibm/ibm_spectrum_control/conf.d/
See “Configuring LDAP-based directory user
access” on page 23.
ldap.conf
/etc/openldap/
See “Configuring LDAP-based directory user
access” on page 23.
vasa_config.ini
/opt/ibm/ibm_spectrum_control/conf.d/
vasa1/
v populate_vasa_events_and_alarms – The
time interval in minutes between each
operation of filtering relevant events for
each connected vCenter server. The default
value is 2.
hsgsvr_config.ini
/opt/ibm/ibm_spectrum_control/conf.d/
hsgsvr/
v populate_arrays_and_events – The time
interval in minutes between each update of
information (changes and events) received
from each monitored storage system. The
default value is 10. When using a large
number of storage systems, the value might
need to be higher than 10. See “Working
with multiple storage systems” on page 160
for additional information.
vcops_config.ini
/opt/ibm/ibm_spectrum_control/conf.d/vcops See “Adjusting system update interval.”
See “Configuring alarm reporting” on page
135.
See “Configuring metrics scope” on page 135.
See “Enabling SSL verification” on page 136.
Adjusting system update interval
The IBM Storage adapter pushes the storage system information to the vRealize
Operations Manager HTTP Post Adapter, using HTTP post requests.
134
IBM Spectrum Control Base Edition
About this task
By default, the update occurs every five minutes. The system information includes
the following:
v
v
v
v
Resource definition and all its relevant matrices
Relationship between the storage resources
Relationship between storage volumes and VMware datastores
Storage system events
Procedure
To change the system update interval:
In the vcops_config.ini file, change the vcops_push_interval parameter to a
desired value in minutes.
Configuring alarm reporting
System events are relayed to the vRealize Operations Manager via the IBM Storage
adapter.
About this task
By default, the IBM Storage adapter reports only immediate and critical events to
the vRealize Operations Manager. You can select a lowest severity level, instructing
the IBM Storage adapter to deliver events that are equal or above the specified
value. In addition, you can disable event reporting altogether.
Procedure
To configure alarm reporting:
In the vcops_config.ini file, set the event_level parameter to one of the following
values:
v none – no events are reported
v info – all events are reported
v warning – warning, immediate and critical events are reported
v immediate – immediate and critical events are reported
v critical – only critical events are reported
Configuring metrics scope
The IBM Storage adapter relays the storage system metrics data to the vRealize
Operations Manager.
About this task
You can adjust the scope of metrics data that is pushed by the IBM Storage
adapter. By default, the detailed metrics are reported, but you can change the
setting to deliver only summary of the performance counters.
Procedure
To change the scope of statistics data:
Chapter 8. Administration
135
In the vcops_config.ini file, change the push_detailed_statistics parameter to
True (detailed performance metrics) or False (performance metrics summary).
Enabling SSL verification
SSL protocol provides an encrypted communication link between the vROps server
and the IBM Spectrum Control Base Edition.
About this task
To ensure a secure communication channel between the vROps server and the IBM
Spectrum Control Base Edition, you can enable the SSL certification, which is
disabled by default. If you enable the SSL verification, make sure to provide a
valid certificate via Linux.
Procedure
To enable SSL verification:
In the vcops_config.ini file, change the verify_ssl_certificate parameter to
True (enable).
Changing the Spectrum Control Base communication port
The TCP port used by Spectrum Control Base to communicate with vCenter and
vRO servers can be changed at any time.
About this task
By default, Spectrum Control Base uses TCP ports 8443 or 8440 for communication
with vCenter and vRO servers to access vWC, register as VASA storage provider
and run orchestration workflows. The 8443 port is used if the current Spectrum
Control Base has been upgraded from a previous version. The 8440 port is used if
the software package has been installed anew.
Procedure
To change the current Spectrum Control Base communication port:
1. Verify that you have root access privileges.
2. Access the /opt/ibm/ibm_spectrum_control/bin/ directory.
3. Run the sc_port_change.sh -p <new_port_number> script, replacing
new_port_number with the desired TCP port value. The script changes the port
number and restarts the Nginx and Spectrum Control Base services for the
changes to take effect.
What to do next
After running the script:
v Re-register a previously registered Spectrum Control Base as a VASA storage
provider on the vCenter server.
v
136
If you are using vRO, re-run the configuration script to instruct Spectrum
Control Base to use the new port.
IBM Spectrum Control Base Edition
Chapter 9. Management from the command-line interface
You can access and control Spectrum Control Base by using its command-line
interface (CLI) functions locally from the Linux command prompt environment, or
from a remote terminal connection.
The Spectrum Control Base CLI is used for user and storage system management,
as well as for integration of the cloud interfaces. However, the CLI application
scope is limited. To employ the full functionality range of Spectrum Control Base,
use the web-based graphical user interface (GUI).
The following sections describe all the CLI configuration and management
functions:
v “CLI – Switching to 'IBMSC' user mode”
v “CLI – Managing Spectrum Control Base users” on page 138
v “CLI – Adding or removing storage system credentials” on page 141
v “CLI – Managing storage systems” on page 143
v “CLI – Setting the VASA credentials” on page 145
v “CLI – Managing integration with vRealize Operations Manager” on page 146
CLI – Switching to 'IBMSC' user mode
To start configuring IBM Spectrum Control Base Edition, you must be logged in as
the ibmsc user in the Linux command prompt environment.
About this task
ibmsc is a user account that is automatically created after the installation, allowing
you to carry out the Spectrum Control Base CLI-based configuration and
management operations.
If needed, you can set the password for accessing the ibmsc user account externally
(for example, from a remote computer over SSH), as described in the following
procedure.
Procedure
To set a password for the ibmsc user:
1. Log in to the Linux command prompt environment as a root user.
2. Enter passwd ibmsc and then enter the password for the user account:
[root]# passwd ibmsc
Changing password for user ibmsc.
New password: **********
Retype new password: **********
passwd: all authentication tokens updated successfully.
[root]#
© Copyright IBM Corp. 2013, 2016
137
What to do next
To switch to the IBMSC user, enter the su - ibmsc command:
[root]# su - ibmsc
CLI – Managing Spectrum Control Base users
All user accounts that can be used to access the IBM Spectrum Control Base
Edition must be individually defined.
You can either define (add) a single Spectrum Control Base user account, or define
multiple user accounts to be used separately.
Use the sc_users CLI command to add, delete, or display user accounts, and also
to change the password of any specific account. Use the required argument after
the command, as specified in the following table. In addition, you can configure
the password reuse policy and security timeout, using the sc_setting CLI
command.
Note:
v All CLI command arguments are case-sensitive.
v The same operations are available from the GUI as well, as explained in
“Managing Spectrum Control Base users” on page 41.
v The sc_users utility cannot define or affect external directory users. For more
information about how to configure directory user access, see “Configuring
LDAP-based directory user access” on page 23.
Table 16. Arguments for sc_users
Argument
Use after sc_users to:
add -n <username> -p <password>
Add the username and password of the user that may access
Spectrum Control Base. You can add more than one user. The
minimum password length is seven characters and it must
include at least one letter and one digit.
or
add --user_name <username> --user_password
<password>
For example:
sc_users add -n johnvc -p ********
change_password -n <username> -p <new
password>
or
change_password --user_name <username>
--user_password <password>
Change the password of a user account that was already
added. The password that you type for the specified username
is set as the new password. The minimum password length is
seven characters and it must include at least one letter and one
digit.
For example:
sc_users change_password -n johnvc -p **********
delete -n <username>
Delete a user account from the server.
or
For example:
delete --user_name <username>
138
IBM Spectrum Control Base Edition
sc_users delete -n johnvc
Table 16. Arguments for sc_users (continued)
Argument
Use after sc_users to:
list
Display the names of currently defined user accounts.
For example:
sc_users list
User list:
john_vc
zivkal_vc
lihit_vc
-h
Display help information that is relevant to sc_users.
or --help
You can also display help for the add_user, change_password, or
delete_user argument if it is typed on the command line as
well.
Table 17. User-related arguments for sc_setting
Argument
Use after sc_setting to:
modify -n USER_PASSWORD_HISTORY_LEN -v
<password retention number>
Prevent the user to submit a new password that is the same as
any of the prior passwords for that account.
For example, to prevent the user to submit a new password
that is the same as the last four prior passwords, enter:
sc_setting modify -n USER_PASSWORD_HISTORY_LEN -v 4
modify -n TOKEN_INACTIVITY_TIMEOUT -v
<inactivity timeout in minutes>
Define a time period in minutes after which the Spectrum
Control Base GUI management session is terminated, if no user
input is detected. By default, the timeout is set to 15 minutes.
For example, to set the inactivity timeout to 20 minutes, enter:
sc_setting modify -n TOKEN_INACTIVITY_TIMEOUT -v 20
CLI – Managing server certificates
During the installation, a self-signed Secure Sockets Layer (SSL) certificate is
generated to create a secure communication channel for servers and clients. If you
already have a trusted certificate that you want to use, you can replace the
self-signed certificate with an existing trusted certificate or generate a new
certificate.
A self-signed certificate file, vp.crt, and a certificate key file, vp.key, are stored in
the following directory:
/opt/ibm/ibm_spectrum_control/settings/ssl_cert.
Because the self-signed certificate is not automatically recognized by the web
browser that you use to log in to Spectrum Control Base, you might encounter a
connection security warning before you can access the Spectrum Control Base login
page (see “Logging in” on page 29).
Chapter 9. Management from the command-line interface
139
Figure 111. Connection security warning in the Mozilla FireFox web browser
To avoid such warning messages, use the import option of the sc_ssl command to
upload a server certificate which is signed by a public certificate authority (CA),
such as VeriSign, or by a CA whose root certificate was imported to your web
browser. In addition, you can use the other options of the sc_ssl command to
generate or to trust an SSL certificate.
Note:
v All CLI command arguments are case-sensitive.
v The same operations are available from the GUI as well, as explained in
“Managing server certificates” on page 39.
Table 18. Arguments for sc_ssl
Argument
Use after sc_ssl to:
generate -c <common_name> -n <host_name> -i
<ip_address> -e <expiration_period>
Enter the hostname, common name, IP address of the Spectrum
Control Base server and certificate validity period (in days).
For example:
sc_ssl generate -c mycommonname
-n "sc_serverhostname" -i 1.0.0.200 -e 5000
trust -c <certificate_path>
Select an SSL certificate to be trusted, by providing a path to its
location.
For example:
sc_ssl trust -c CA_certificate.crt
140
IBM Spectrum Control Base Edition
Table 18. Arguments for sc_ssl (continued)
Argument
Use after sc_ssl to:
import -c <certificate_path> -k <key_path>
Import a SSL certificate and a key file, by providing paths to
their locations.
For example:
sc_ssl import -c self_signed_certificate.crt -k private_key.key
Display help information that is relevant to sc_ssl.
-h
You can also display help for the generate, trust, or import
argument if it is typed on the command line as well.
CLI – Adding or removing storage system credentials
This section explains how to set the credentials that will be used to connect to the
IBM storage system, or systems, that your VMware platforms use for storage
provisioning.
Important:
v An identical storage admin user account with identical credentials (the same
username and password) must already be predefined on all the IBM storage
systems that you intend to use. Spectrum Control Base can use only a single
system management account for accessing all the different storage systems that
you use. For more information about how to define a storage admin account on
your IBM storage systems, refer to the relevant storage system management
tools documentation.
v Setting the storage credentials on Spectrum Control Base allows you to add the
IBM storage systems on the next step.
v If the storage system management account is defined on a directory server, see
“Checking the format of directory-based storage system credentials” on page
155.
Use the sc_storage_credentials CLI command to set (add), remove, or display the
current storage system access credentials that Spectrum Control Base uses in order
to access all the IBM storage systems. Use the required argument after the
command, as specified in the following table.
Note:
v All CLI command arguments are case-sensitive.
v The same operations are available from the GUI as well, as explained in
“Entering the storage system credentials” on page 45.
Chapter 9. Management from the command-line interface
141
Table 19. Arguments for sc_storage_credentials
Argument
Use after sc_storage_credentials to:
set -u <storage system username>
Set the username and password for accessing all the relevant IBM
storage systems, and specify whether the storage admin user is
locally-defined on the storage system or on a directory server. For
storage systems running Spectrum Virtualize, ensure that the
credentials belong to a user account with VASAProvider role.
-p <storage system password>
-f
-a <user type>
or
set --user <storage system username>
--password <storage system password>
--force
For example, if the storage admin user is locally defined on the
storage system, enter:
sc_storage_credentials set -u john21 -p ******** -a local
And if the storage admin user is defined on a directory server, enter:
sc_storage_credentials set -u john21 -p ******** -a directory
--user_account <user type>
Attention: During regular operation, whenever a directory-based
storage admin fails to log in (from the Spectrum Control Base side) to
any storage system that is in use, Spectrum Control Base immediately
locks the storage admin user account and all storage systems become
inaccessible on the Spectrum Control Base side. This is to prevent
repeated login attempt failures after which the directory server blocks
that user account. In such a case, use the -f or --force argument on
the command line to unlock the storage admin account on the
Spectrum Control Base side, with either the same credentials or with
updated credentials. For example:
sc_storage_credentials set -u john21 -p ******** -f -a directory
The equivalent action in the Spectrum Control Base GUI is to update
the account credentials, as described in “Entering the storage system
credentials” on page 45.
If the storage credentials are defined on a directory server, see
“Checking the format of directory-based storage system credentials”
on page 155.
remove
Delete the existing storage system user account definition from the
server.
For example:
sc_storage_credentials remove
Attention: If you already added storage systems to the server,
deleting the user account disconnects all these storage systems.
142
IBM Spectrum Control Base Edition
Table 19. Arguments for sc_storage_credentials (continued)
Argument
Use after sc_storage_credentials to:
list
Display the username of the existing storage system user account
definition.
The following example shows the command output when the storage
admin user account is defined locally on the storage system:
sc_storage_credentials list
Username
---------admin
admin
admin
Array Alias
---------------XIV hostdev31b
XIV hostdev32a
XIV hostdev31a
User Category
--------------storageadmin
storageadmin
storageadmin
Account Source
---------------local
local
local
The following example shows the command output when the storage
admin user account is defined on a directory server:
sc_storage_credentials list
Username
---------admin
admin
admin
Array Alias
---------------XIV hostdev31b
XIV hostdev32a
XIV hostdev31a
User Category
--------------storageadmin
storageadmin
storageadmin
Account Source
---------------directory
directory
directory
-h
Display help information that is relevant to sc_storage_credentials.
or --help
You can also display help for the set argument if it is typed on the
command line as well.
CLI – Managing storage systems
All IBM storage systems that provide storage resources to your VMware platforms
must be defined as storage systems on the IBM Spectrum Control Base Edition.
Use the sc_storage_array CLI command to add, remove, or list these IBM storage
systems (referred to as arrays in the command syntax and output). Use the required
argument after the command, as specified in the following table. In addition, you
can set a threshold for alerting the user, when a storage resource capacity is
running low, using the sc_setting CLI command.
Chapter 9. Management from the command-line interface
143
Important:
v IBM storage systems can be added only after the storage credentials are set, as
explained in “CLI – Adding or removing storage system credentials” on page
141.
v If you want to remove existing storage systems:
– A removed storage system, along with its storage pools and volumes, can no
longer be managed by the included solution components (see “Included cloud
interfaces” on page 1).
– If the removed storage system contains working storage pools and volumes,
the information of these storage pools and volumes is no longer displayed in
vSphere Web Client. However, vSphere data access and service level for
these storage pools and volumes is not affected. In addition, the removed
system and its storage pools and volumes can be managed from the standard
IBM storage system management tools.
– After the removal, you can add the storage system back again to fully restore
its management.
Note:
v All CLI command arguments are case-sensitive.
v The same operations are available from the GUI as well, as explained in
“Managing storage systems” on page 44.
Table 20. Arguments for sc_storage_array
Argument
Use after sc_storage_array to:
add -i <management IP address> -a <system
alias name>
Add a storage system specified by an IP address or DNS.
For example:
or
sc_storage_array add -i 10.100.155.200
add --mgmt_ip <management IP address>
--storage_type <storage system type> --alias
<system alias name>
Optional: you can define an alias for the added XIV system, by
adding -a <alias name> or --alias <alias name> to the
command.
For example:
sc_storage_array add -i 10.100.155.200 -a mystorage1
Note: If you choose not to define an alias, the alias that is
already defined (if one was defined) on the IBM storage system
side is automatically assigned as the alias.
remove -a <system alias name>
or
Remove a storage system specified by its alias (alias that was
given by you or was automatically assigned).
For example:
remove --alias <system alias name>
sc_storage_array remove -a mystorage1
144
IBM Spectrum Control Base Edition
Table 20. Arguments for sc_storage_array (continued)
Argument
Use after sc_storage_array to:
list
List the names and details of all the IBM storage systems that
are currently added (and were not removed). The displayed
information includes:
v Array alias
v Array identifier
v Management IP address
v Elapsed time since last update
v Connected
v Notes
See the example after this table.
refresh
Refresh information about all managed IBM storage systems.
-h
Display help information that is relevant to sc_storage_array.
or --help
You can also display help for the add or remove argument if it is
typed on the command line as well.
The following example shows the displayed information and format of the
sc_storage_array list command output.
sc_storage_array list
Array
Alias
---------array1000
Array
Identifier
---------------2810-114-MN65026
Management
IP Addresses
------------9.100.150.155
array2000
2810-114-MN65027 9.200.155.155
Elapsed time
since last update
-----------------16 minutes
Connected
---------False
27 minutes
True
Notes
--------------------------------Failed to log in to array 2810
with the provided credentials.
Table 21. Storage resource-related arguments for sc_setting
Argument
Use after sc_setting to:
modify -n RESOURCE_CAPACITY_THRESHOLD -v
<capacity threshold in %>
Define a threshold for a VVol-based storage resource capacity.
When this threshold is reached, an alarm is generated to
indicate that the storage capacity is running low. By default, the
threshold is set at 70%.
For example, to alert the user, when the storage resource has
reached 80% of its capacity, enter:
sc_setting modify -n RESOURCE_CAPACITY_THRESHOLD -v 80
CLI – Setting the VASA credentials
The VASA credentials comprise a user name and a password that VMware vCenter
servers can use to connect to the IBM Spectrum Control Base Edition and employ
VMware vSphere APIs for Storage Awareness (VASA) functions.
Use the sc_vasa_admin CLI command to set or display the VASA credentials.
vCenter servers can then use these credentials to connect to Spectrum Control Base
and utilize VASA functions, as explained in “Registering Spectrum Control Base as
Chapter 9. Management from the command-line interface
145
a storage provider on vCenter server” on page 83. Use the required argument after
the command, as specified in the following table.
Note:
v Only one set of a username and a password can be used for the VASA
credentials, which applies to all vCenter servers that require VASA functions.
v All CLI command arguments are case-sensitive.
v The same operations are available from the GUI as well, as explained in “Setting
the VASA credentials” on page 53.
Table 22. Arguments for sc_vasa_admin
Argument
Use after sc_vasa_admin to:
set_secret -n <username> -p <password>
Set the username and password that the VASA credentials
should comprise.
or
For example:
set_secret --user_name <username>
--user_password <password>
sc_vasa_admin set_secret -n johnvasa -p ********
The secret key for the VASA Provider has been set
successfully.
Display the username of the currently defined VASA
credentials.
list_secret
For example:
sc_vasa_admin list_secret
Secret key username for the VASA Provider:
johnvasa
-h
Display help information that is relevant to sc_vasa_admin.
or --help
You can also display help for the set_secret argument if it is
typed on the command line as well.
CLI – Managing integration with vRealize Operations Manager
Before you can use the IBM Storage Management Pack for VMware vRealize
Operations Manager, you must set a connection to at least one vRealize Operations
Manager (vROps) server, and then define which storage systems should be
monitored in vROps.
After a vROps server connection is defined and storage systems (referred to as
arrays in the command syntax and output) are associated with the vROps server,
detailed monitoring information for these storage systems becomes available in
vROps (for more information, see Chapter 7, “Using the IBM Storage Management
Pack for VMware vRealize Operations Manager,” on page 113).
Use the sc_vrops_server CLI command to add, remove, or disable connections to
vROps servers, or to list the current server connections. An HTTP POST adapter is
automatically created for each vROps server that you add.
Use the sc_vrops_adapter command to attach storage systems to any created
HTTP POST adapter. A storage system that is attached to an HTTP POST adapter
146
IBM Spectrum Control Base Edition
can be monitored by the vROps server for which the HTTP POST adapter was
created. You can use the sc_vrops_adapter command for additional options as
described below.
Use the required argument after each command, as specified in the following
tables.
Important:
v Storage systems can be attached to HTTP POST adapters only after the storage
systems have been added to Spectrum Control Base, as explained in “CLI –
Managing storage systems” on page 143.
v If the IBM Storage PAK file was not deployed on the vROps server, IBM Storage
monitoring information is not displayed with dedicated dashboards, graphic
icons, and user-friendly attribute names in vROps. For information about how to
deploy the IBM Storage PAK file, see “Downloading the vROps management
package” on page 78.
v If you want to detach storage systems:
– A detached storage system can no longer be monitored through vRealize
Operations Manager.
– After the detachment, you can reattach the storage system to fully restore its
monitoring through vRealize Operations Manager.
Note:
v All CLI command arguments are case-sensitive.
v Apart from the ability to add more than one vROps server and additional HTTP
POST adapters from the CLI, the same operations are available from the GUI as
well, as explained in “Managing integration with vRealize Operations Manager”
on page 77.
Table 23. Arguments for sc_vrops_server
Argument
Use after sc_vrops_server to:
add -n <hostname> -u <username> -p <password>
Add a vROps server connection by specifying the following
parameters on the command line:
or
add --hostname <hostname> --username
<username> --password <password>
v IP address or hostname of the vROps server that you want to
add (connect to).
v Username for accessing the vROps server.
v Password for accessing the vROps server.
For example:
sc_vrops_server add -n vrops1.domain -u john1 -p ********
Note: The local HTTP POST adapter is added automatically
after the vROps server is added.
Chapter 9. Management from the command-line interface
147
Table 23. Arguments for sc_vrops_server (continued)
Argument
Use after sc_vrops_server to:
remove -n <hostname>
Remove a vROps server connection by specifying its IP address
or hostname on the command line.
or
For example:
remove --hostname <hostname>
sc_vrops_server remove -n vrops1.domain
Note: A removed vROps server ceases to receive monitoring
information regarding IBM storage resources that are in use.
You can add a vROps server back by using the add option (see
above).
or
Disable reporting to a vROps server (without removing its
connection) by specifying its IP address or hostname on the
command line.
disable --hostname <hostname>
For example:
disable -n <hostname>
sc_vrops_server disable -n vrops1.domain
Note: A vROps server for which reporting is disabled ceases to
receive monitoring information regarding IBM storage
resources that are in use. You can resume reporting to a vROps
server by using the enable option (see below).
enable -n <hostname>
or
Resume reporting to a vROps server by specifying its IP
address or hostname on the command line.
For example:
enable --hostname <hostname>
sc_vrops_server enable -n vrops1.domain
List all the currently connected (added) vROps servers and
their operation status (enabled or disabled).
list
For example:
sc_vrops_server list
vROps Hostname
--------------vrops1.domain
vrops2.domain
Status
------Enabled
Disabled
-h
Display help information that is relevant to sc_vrops_server .
or --help
You can also display help for the add, remove, enable, or
disable argument if it is typed on the command line as well.
148
IBM Spectrum Control Base Edition
Table 24. Arguments for sc_vrops_adapter
Argument
Use after sc_vrops_adapter to:
array_attach -a <alias> -n <hostname>
Attach a storage system to a vROps HTTP POST adapter (of a vROps
server) by specifying the following parameters on the command line:
or
v Alias name of the storage system that you want to attach.
array_attach --alias <alias> --hostname v IP address or hostname of the storage system that you want to
attach.
<hostname>
For example:
sc_vrops_adapter array_attach -a myXIV -n 9.150.200.100
Note: The storage system must already be added to Spectrum Control
Base, as explained in “CLI – Managing storage systems” on page 143.
array_detach -a <alias> -n <hostname>
or
Detach a storage system from a vROps HTTP POST adapter (of a
vROps server) by specifying the following parameters on the
command line:
array_detach --alias <alias> --hostname v Alias name of the storage system that you want to detach.
v IP address or hostname of the storage system that you want to
<hostname>
detach.
For example:
sc_vrops_adapter array_detach -a myXIV -n 9.150.200.100
add -s <server> -n <hostname>
or
add --server <server> --hostname
<hostname>
Add an HTTP POST adapter for a vROps server by specifying the
following parameters on the command line:
v IP address or hostname of a currently added (connected) vROps
server.
v IP address or hostname of the HTTP POST adapter that you want to
add.
For example:
sc_vrops_adapter add -s vrops1.domain -n adapter2.domain
remove -n <hostname>
or
Remove an HTTP POST adapter by specifying its IP address or
hostname on the command line.
For example:
remove --hostname <hostname>
sc_vrops_adapter remove -n adapter2.domain
report_thresholds -n <hostname>
or
Report the thresholds to a vROps server by specifying its IP address or
hostname on the command line.
For example:
report_thresholds --hostname <hostname>
sc_vrops_adapter report_thresholds -n vrops1.domain
report_thresholds -a
or
report_thresholds -all
Report the thresholds to all vROps servers that are currently added
(connected). Usually, this command can be omitted, because the
thresholds are defined by default, when a vROps server is added.
sc_vrops_adapter report_thresholds -a
Chapter 9. Management from the command-line interface
149
Table 24. Arguments for sc_vrops_adapter (continued)
Argument
Use after sc_vrops_adapter to:
list
List all the currently defined HTTP POST adapters and display their
associated vROps server, alias name of attached storage systems, last
report time (report to the vROps server), and indication regarding
whether the adapter is remote or locally defined.
For example:
sc_vrops_adapter list
vROps Hostname
-------------vrops1.domain
vrops2.domain
HTTP POST Hostname
-----------------adapter1.domain
adapter2.domain
Remote
-----No
Yes
Last Reported
------------5 minutes ago
8 minutes ago
Array alias
----------myXIV
myXIV
-h
Display help information that is relevant to sc_vrops_adapter.
or --help
You can also display help for the array_attach, array_detach, add,
remove, or report_thresholds argument if it is typed on the command
line as well.
CLI – Backing up or restoring a Spectrum Control Base configuration
At any point, you can back up the current Spectrum Control Base configuration
and save it to a file, or load a previously saved configuration to restore a
configuration.
The configuration includes storage credentials, storage systems, vCenter
credentials, and storage resource attachments.
Use the sc_configuration CLI command to save the existing configuration, or load
a saved configuration to replace the existing one. Use the required argument after
the command, as specified in the following table.
Note:
v All CLI command arguments are case-sensitive.
v The backup and restore operations are not available on the Spectrum Control
Base GUI.
Attention:
v Before using the restore option, the IBM VASA Provider service must be
stopped as explained in “Checking and controlling the Spectrum Control Base
service” on page 133. Start the service again after the configuration has been
loaded.
v restore should be used only with a freshly installed Spectrum Control Base that
has not yet been configured.
150
IBM Spectrum Control Base Edition
Table 25. Arguments for sc_configuration
Argument
Use after sc_configuration to:
backup -f <file name> -k <8 characters>
Save the current IBM Storage Provider configuration to the
specified file using an AES-256 encryption key that comprises 8
characters.
or
backup --file <file name> --key <8 characters> For example:
sc_configuration backup -f confbackup -k abcdefghijklmnop
Important: You will need to provide this key in any restore
operation (see below).
restore -f <file name> -k <8 characters>
or
restore --file <file name> --key <8
characters>
Load a configuration from a specified file by providing the file
name and the encryption key that was used in the creation of
the file.
Attention: See the notes above this table.
For example:
sc_configuration restore -f confgbackup -k abcdefghijklmnop
restore -f ./vasa115exported.db
Restore an existing Spectrum Control Base configuration that
was made with IBM Storage Provider for VMware VASA
version 1.1.5 (applicable only to XIV systems).
For this restore operation, you do not need to provide an
encryption key:
sc_configuration restore -f ./vasa115exported.db
-h
Display help information that is relevant to sc_configuration.
or --help
You can also display help for the backup or restore argument if
it is typed on the command line as well.
Chapter 9. Management from the command-line interface
151
152
IBM Spectrum Control Base Edition
Chapter 10. Troubleshooting
This chapter can help you detect and solve problems that you might encounter
when using the IBM Spectrum Control Base Edition.
Note:
v For up-to-date information about known issues and possible workarounds, refer
to the latest release notes.
v When contacting IBM Support, specify the storage system you are managing,
using Spectrum Control Base.
See the following sections for more information:
v “Checking the log files.”
v “Checking the format of directory-based storage system credentials” on page
155.
v “Configuring event forwarding” on page 156.
v “Deleting virtual volumes and group pools via XCLI” on page 156
v “Self-assist options for IBM Spectrum Control Base Edition” on page 157.
Checking the log files
The IBM Spectrum Control Base Edition maintains log files that record different
types of events.
You can find the following log files in the /var/log/sc/ directory:
v events.log – Records Spectrum Control Base events according to their type:
Info, Error, or Warning. The event logging is compatible with the Rsyslog
application, an open source utility for forwarding log messages over IP networks
(for more information, see the Rsyslog website). The following example shows
different events that might be recorded:
IBMSC-0001, INFO, "User {user_name} has logged in."
IBMSC-0002, INFO, "User {user_name} has logged out."
IBMSC-0003, WARNING, "User {user_name} login attempt failed."
IBMSC-0004, INFO, "IBM Spectrum Control local user account {user_name} was created."
IBMSC-0005, INFO, "IBM Spectrum Control local user account {user_name} was deleted."
IBMSC-0006, INFO, "IBM Spectrum Control local user account {user_name} password was reset."
IBMSC-0007, INFO, "Storage credentials were set for user {user_name}."
IBMSC-0008, ERROR, "Storage credentials for user {user_name} were disabled. Reason: {reason}."
IBMSC-0009, INFO, "Storage array identified as {identifier} with IP address {ip_address} has been added."
IBMSC-0010, WARNING, "Storage array {identifier} was removed."
IBMSC-0011, WARNING, "Storage array {identifier} was modified. Its new IP address is {ip_address}."
IBMSC-0014, INFO, "vCenter server with IP address {ip_address} was added by user {user_name}."
IBMSC-0015, WARNING, "vCenter server with IP address {ip_address} was removed."
IBMSC-0016, WARNING, "Credentials for vCenter server with IP address {ip_address} were updated by user {user_name}."
IBMSC-0017, INFO, "Storage pool {pool_name} on storage array {identifier} was attached to vCenter server with IP address
{ip_address}."
IBMSC-0018, WARNING, "Storage pool {pool_name} on storage array {identifier} was detached from vCenter server with IP address
{ip_address}."
IBMSC-0019, ERROR, "Failed to connect to storage array {identifier}. Reason: {reason}."
IBMSC-0020, INFO, "Information retrieval from storage array {identifier} was completed."
IBMSC-0021, ERROR, "Failed to retrieve information from storage array {identifier}. Reason: {reason}."
IBMSC-0022, INFO, "LDAP authentication was enabled."
IBMSC-0023, INFO, "LDAP authentication was disabled."
IBMSC-0024, INFO, "Completed the vSphere Web Client extension task {task_name} with the following parameters: {parameter_list}."
IBMSC-0025, ERROR, "Failed to complete the vSphere Web Client extension task {task_name} with the following parameters
{parameter_list}.
Reason: {reason}."
© Copyright IBM Corp. 2013, 2016
153
v hsgsvr.log – Records events regarding monitoring and operations on storage
systems and volumes.
v vasa1.log – Records events regarding the communication between Spectrum
Control Base and the connected vCenter servers that utilize VASA 1.0 functions.
v vasa2.log – Records events regarding the communication between Spectrum
Control Base and the connected vCenter servers that utilize VASA 2.0 functions.
In addition, several events related to the VASA 1.0 activity may be recorded in
the vasa2.log file as well.
v vwc.log – Records events regarding the communication between Spectrum
Control Base and the vSphere Web Client Server on which the IBM Storage
Enhancements are installed.
v celery.log – Records events regarding the Celery services on the Linux host on
which Spectrum Control Base is installed.
v django.log – Records events regarding the Django service on the Linux host on
which Spectrum Control Base is installed.
v vco.log – Records events regarding operation of the vSphere Orchestrator,
complementing information stored in the hsgsvr.log file. The vco.log file can be
accessed via the Log tab of the vCO plug-in interface. If the Inventory folder
within the 'IBM Storage' context is empty and the following message is stored in
the vco.log:
[SCRepository] com.sun.jersey.api.client.ClientHandlerException:
javax.net.ssl.SSLHandshakeException:
java.security.cert.CertificateException: No name matching
sc8.ps.xiv.ibm.com found,
replace the default Spectrum Control Base SSL certificate and key files as
described in “Managing server certificates” on page 39.
v vcops.log – Records events regarding the communication between Spectrum
Control Base and the connected vROps servers.
v traffic.log – Records XCLI events. This log file is reserved for debug purposes.
You can retrieve and save the current log files in a compressed TAR archive file by
using the Collect Log option on the Settings menu of the Spectrum Control Base
GUI. This option allows you to save different instances of the log files at different
times.
Figure 112. Controller GUI – Collect Log option
154
IBM Spectrum Control Base Edition
Checking the format of directory-based storage system credentials
If you are using directory-based storage credentials for adding storage systems to
the IBM Spectrum Control Base Edition (not for logging in to Spectrum Control
Base), you must verify that the directory user name is provided in the correct
format.
Different formats are possible for a directory-based user name. For example:
v User name without the domain name, for example: john21
v User name with the domain name, for example: john21@domain_name
The format that should be used depends on the directory user name attribute
string that is defined on the storage system. For example:
v sAMAccountName – User name without the domain name (john21).
v userPrincipalName – User name with the domain name (john21@domain_name).
Important: Other user name formats that are not specified above may be used.
Consult with your directory server administrator about the required user name
format, and make sure that the user name format is properly defined on the
storage system.
The following figure shows the user name attribute in the LDAP role mapping
definitions for XIV (defined via the XIV management GUI).
Figure 113. XIV role mapping attributes for directory (LDAP) users
Related tasks:
“Entering the storage system credentials” on page 45
The storage system credentials are used to connect to the IBM storage system or
systems, which your VMware platforms use for storage provisioning.
Chapter 10. Troubleshooting
155
Configuring event forwarding
Storage system level events generated by a storage system can be forwarded by the
IBM Spectrum Control Base Edition to the VMware vRealize Log Insight for
monitoring and analysis.
Procedure
To configure event forwarding:
1. Go to the /opt/ibm/ibm_spectrum_control/conf.d/ directory.
2. Open the ibmsyslog.conf file for editing.
3. Look for the following code block:
if $programname == ’array_events’ then ?SCLogFileName;SCLogFormat
& ~
4. Add the IP address of the VMware vRealize Log Insight server and UDP port
in the following format: & @@<log_insight_address>:<port>.
Example
To forward the storage system events to the VMware vRealize Log Insight server
with IP address 9.151.163.122 via UDP port 514 in addition to writing them to the
/var/log/sc/array_events.log file, enter the following:
if $programname == ’array_events’ then ?ISISLogFileName;ISISLogFormat
& @@9.151.163.122:514
& ~
To relay the storage system events to the VMware vRealize Log Insight server with
IP address 9.151.163.122 via UDP port 514 without writing them to the local log
file, enter the following:
if $programname == 'array_events' then @@9.151.163.122:514
& ~
Deleting virtual volumes and group pools via XCLI
A group pool, used by virtual volumes, can be deleted only after its VVols are
removed via XCLI.
About this task
This procedure details how to use XCLI to delete virtual volumes, as they are not
visible in the Spectrum Control GUI. When the virtual volumes are removed, you
can delete a group pool, which was used by VVols as well.
Procedure
To delete the virtual volumes and group pools via XCLI:
1. Launch the XIV XCLI tool and log in as a storage integration administrator
(storageintegrationadmin). Make sure that you are allowed to manage the current
domain.
2. List all existing virtual volumes, by using the vol_list command.
XIV hostdev31c>>vol_list managed=yes domain=test
Name Size (GB) Master Name Consistency Group Pool
Creator Compressed Compression Ratio (%) Used Capacity (GB) Compression Saving (GB) Managed
test_1 17
gp_1_meta tester_1 no
0
yes
test_2 18
gp_2_meta tester_1 no
0
yes
3. Delete the required virtual volume, by using the vol_delete command.
156
IBM Spectrum Control Base Edition
XIV hostdev31c>>vol_delete vol=test_1 -y
Warning: This is a managed object. Performing manual operations on it may cause severe problems to the managing software. Are you sure you want to perform
the operation on this managed object? y/n: y
4. List all group pools in the domain, by using the gp_list command.
XIV hostdev31c>>gp_list
Name
gp_1
gp_2
domain=test
Meta Pool Name
gp_1_meta
gp_2_meta
Thin Pool Name
gp_1_thin
gp_2_thin
Thick Pool Name
gp_1_thick
gp_2_thick
5. List all pools in the group pool, by using the pool_list command.
pool_list gp=gp_1 managed=yes
Name
Size (GB) Soft Vols (GB) Snap Size (GB) Soft Empty (GB) Hard Size (GB) Hard Vols (GB) Locked
gp_1_thin 653
0
34
619
309
0
no
gp_1_meta 0
0
0
0
0
0
no
gp_1_thick 34
0
34
0
34
0
no
Hard Snaps (GB) Hard Empty (GB) Domain
0
309
test
0
0
test
0
34
test
Create Compressed Volumes Managed
no
yes
no
yes
no
yes
6. Delete the group pool, by using the gp_delete command.
XIV hostdev31c>>gp_delete gp=gp_1 -y
7. Delete the all pools that belonged to the deleted group pool, by using the
pool_delete command.
XIV hostdev31c>>pool_delete pool=gp_1_thin -y
XIV hostdev31c>>pool_delete pool=gp_1_thick -y
XIV hostdev31c>>pool_delete pool=gp_1_meta -y
Self-assist options for IBM Spectrum Control Base Edition
IBM Support provides several online self-service tools for Spectrum Control Base
Edition users.
You can try using the following tools to find information and resolve issues
without having to contact IBM Support:
v Spectrum Control-related questions on IBM developerWorks
(developer.ibm.com/answers/topics/spectrum%20control/#) – Allows you to
ask questions online and get answers from IBM experts or other users. The issue
of interest can also be searched for in older discussions.
v IBM Redbooks®(redbooks.ibm.com) – Technical documents where IBM experts
share their expertise and best practices for using Spectrum Control Base.
The above resources are constantly being indexed by web search engines such as
Google (google.com).
Chapter 10. Troubleshooting
157
158
IBM Spectrum Control Base Edition
Chapter 11. Best practices
Refer to the general guidance and best practices that are described in the following
sections.
v “Handling datastores”
v “Handling ESXi hosts that use XIV volumes”
v “Distributing volumes evenly on DS8000 systems”
v “Setting the multipath policy for DS8000 and Storwize Family systems”
v “Working with multiple storage systems” on page 160
v “Upgrading or installing Spectrum Control Base with vSphere failover” on page
160
v “Creating a VVol-enabled service” on page 161
– “Creating a VVol-enabled service on XIV storage systems” on page 162
– “Creating a VVol-enabled service on storage systems that run IBM Spectrum
Virtualize” on page 163
Handling datastores
For best performance of VMware datastores:
v Create each datastore on a separate storage volume.
v If you use snapshots/mirroring for volumes, place all Datastore Extents volumes
(the building block LUNs of a datastore) in a consistency group (defined by
using the storage system GUI or CLI).
Handling ESXi hosts that use XIV volumes
For the best performance of ESXi hosts that use XIV volumes, define all ESXi hosts
within a cluster as cluster hosts on the XIV storage system as well.
Following this practice prevents situations in which a storage volume is mapped to
different ESXi hosts in a cluster using different LUN numbers, thus making this
LUN unusable.
Distributing volumes evenly on DS8000 systems
DS8000 storage systems have two rank groups, 0 and 1, each managed by a single
server. In addition, each DS8000 extent pool is based on one rank group.
Accordingly, it is recommended to spread volumes evenly across the DS8000
systems. Spreading the volumes equally on the extent pools of rank groups 0 and 1
balances the workload across the DS8000 system.
Setting the multipath policy for DS8000 and Storwize Family systems
When using the IBM Storage Enhancements for VMware vSphere Web Client, the
recommended multipath policy for DS8000 and Storwize Family (including SAN
Volume Controller) storage systems is Round Robin.
If you are using VMware ESXi servers of version 5.5 or later, the Round Robin
multipath policy is enforced by default. However, if you are using earlier ESX or
© Copyright IBM Corp. 2013, 2016
159
ESXi versions, the Fixed policy is chosen by default, and it is recommended to
change the multipath policy on those servers to Round Robin.
For information about how to change the default multipath policy enforcement for
earlier ESX or ESXi versions, refer to article 1017760 on the VMware Knowledge
Base website (kb.vmware.com/selfservice/microsites/search.do?language=en_US
&cmd=displayKC&externalId=1017760).
Working with multiple storage systems
The IBM Spectrum Control Base Edition, running on RHEL 6.3–6.6 64-bit operating
systems, utilizes CPU and memory resources in accordance with the amount of
objects monitored by the vROps server.
Before you begin
For best results, deploy Spectrum Control Base on a dedicated server. The
minimum hardware requirements are detailed in the latest release notes, available
on the IBM Knowledge Center or on the IBM Fix Central (www.ibm.com/support/
fixcentral).
About this task
Any increase in the amount of the monitored objects requires additional hardware
resources and population interval adjustment. The recommended hardware and
software requirements for different amounts of monitored objects are as follows:
v Up to 1000 objects per storage system:
– Up to 20 storage systems – 64-bit dual-core CPU, 4 GB of RAM
– Up to 40 storage systems – 64-bit quad-core CPU, 6 GB of RAM
– Up to 100 storage systems – 64-bit six-core CPU, 6 GB of RAM
v Up to 5000 objects per storage system:
– Up to 20 storage systems – 64-bit quad-core CPU, 4 GB of RAM
– Up to 40 storage systems – 64-bit six-core CPU, 6 GB of RAM, 15 min.
population interval
– Up to 100 storage systems – 64-bit six-core CPU, 6 GB of RAM, 25 min.
population interval
The procedure for adjusting population interval is detailed below.
Procedure
To adjust a population interval:
1. Go to the /opt/ibm/ibm_spectrum_control/conf.d/hsgsvr directory.
2. Edit the hsgsvr_config.ini file and change the population interval in the
populate_arrays_and_events parameter to a desired value in minutes.
3. Save the changes.
4. Restart the Spectrum Control Base service (service ibm_spectrum_control
restart).
Upgrading or installing Spectrum Control Base with vSphere failover
Spectrum Control Base can be upgraded or installed together with vSphere failover
procedure.
160
IBM Spectrum Control Base Edition
Before you begin
v Verify that at least two Spectrum Control Base instances are registered as storage
providers on a vCenter server.
v Both Spectrum Control Base instances must be online, one of them must be
active and the other one – standby.
About this task
To minimize system downtime, you can upgrade the existing Spectrum Control
Base or install its new release along with completing failover between active and
standby instances in vSphere environment.
Procedure
1. Copy the upgrade or installation package files to a temporary folder on a
virtual machine that is hosting Spectrum Control Base.
2.
Upgrade or install the standby Spectrum Control Base instance. See
“Upgrading an existing installation” on page 14 or “Performing first-time
installation” on page 12.
3. Verify the standby instance connectivity to a storage system, by using the
sc_storage_array list command. A proper connectivity to a storage system is
indicated by Yes in the Connected field, as illustrated in the following example.
Array Alias
Array Identifier
------------- -----------------SVC232
0000020062A1D16C
Management IP Addresses
Elapsed time since last update
------------------------- -------------------------------9.115.246.232
7 minutes
Connected
Notes
----------- ------Yes
4. Complete the active Spectrum Control Base failover to the standby instance, by
restarting the guest operation system of the virtual machine that is hosting the
active Spectrum Control Base. The failover process can take up to 8 minutes to
complete. As a result, the standby instance becomes active, running the newly
upgraded or installed Spectrum Control Base.
5. Repeat the upgrade/install and failover processes for the remaining Spectrum
Control Base instances.
Creating a VVol-enabled service
The IBM Spectrum Control Base Edition introduces a comprehensive storage
virtualization support, using VMware virtual volume (VVol) technology.
Before you begin
Note: The virtual volume functionality is supported by the IBM XIV (11.5.1 or
later) and storage systems that run IBM Spectrum Virtualize (7.6 or later).
v Verify that all required ESXi hosts are connected and defined at the storage
system side.
v Verify that the Spectrum Control Base time is synchronized with the time, used
by the vCenter server
About this task
This section details how to create a VVol-enabled storage service on XIV or storage
systems that run IBM Spectrum Virtualize. The service or a group of services can
be used to define storage spaces, serving as virtual datastores for VM deployment.
See the following sections, depending on the storage system in use:
v “Creating a VVol-enabled service on XIV storage systems” on page 162
Chapter 11. Best practices
161
v “Creating a VVol-enabled service on storage systems that run IBM Spectrum
Virtualize” on page 163
Creating a VVol-enabled service on XIV storage systems
The IBM Spectrum Control Base Edition features a comprehensive storage
virtualization support, using VMware Virtual Volume (VVol) technology.
About this task
This section details how to create a VVol-enabled storage service on XIV storage
systems.
To create a VVol-enabled storage service:
v Enable VVol utilization at the XIV side.
v Create the service, using Spectrum Control Base.
Procedure
1. Launch the XIV management GUI and log in as a storage administrator.
2. Create a domain with required soft and hard capacity. Make sure that the soft
capacity is four times larger than the hard capacity.
3. For XIV and Spectrum Accelerate storage systems, define a user with category
storageintegrationadmin.
4. Associate the storageintegrationadmin user with the domain.
5. Associate all ESXi hosts with the domain.
Important: The managed domain that you created cannot be used for traditional
volumes without virtualization. You must create a separate regular domain for
them. This domain must have the same user and the ESXi hosts that you intend to
manage. However, you need to create a separate storage resource and a new
service on the regular domain via Spectrum Control Base for subsequent use by
the VMware vWC.
6. Launch the XIV XCLI tool.
7. Enable the metadata service for the XIV, using the metadata_service_enable
command.
8. Close the he XIV XCLI tool and return to the XIV management GUI.
9. Change the storage administrator user to storageintegrationadmin user and
re-launch the XIV XCLI tool
10. Create a new Administrative Logical Unit (ALU) per each ESXi host. Use the
following XCLI format: alu_create alu=<alu-name> host=<host-name>
lun=logical-unit-number. Make sure that the LUN is in the 512–755 range.
11. Launch Spectrum Control Base.
12. Configure a fully qualified domain name for the Spectrum Control Base server
and define a high-availability group. See “Defining a high-availability group”
on page 37.
13. Generate a self-signed Spectrum Control Base server certificate. See
“Managing server certificates” on page 39.
14. Set up VASA credentials. See “Setting the VASA credentials” on page 53.
15. Enable the storageintegrationadmin to access the XIV storage resources. See
“Entering the storage system credentials” on page 45.
162
IBM Spectrum Control Base Edition
16. Add the XIV storage system to the Spectrum Control Base. See “Adding a
storage system” on page 47.
17. Add a new storage space. See “Adding a storage space” on page 56.
18. Add a VVol-enabled service to the storage space. See “Adding a storage
service” on page 57.
19. Define a storage resource and attach it to the VVol-enabled service. See
“Defining and attaching storage resources” on page 60.
20. Register Spectrum Control Base as a storage provider on VMware vCenter
server. See “Registering Spectrum Control Base as a storage provider on
vCenter server” on page 83.
21. Launch the vWC and create a VVol-enabled datastore. Select the storage space
that you defined as an underlying storage resource for the datastore.
Creating a VVol-enabled service on storage systems that run
IBM Spectrum Virtualize
The IBM Spectrum Control Base Edition features a comprehensive storage
virtualization support, using VMware Virtual Volume (VVol) technology.
About this task
This section details how to create a VVol-enabled storage service on storage
systems that run IBM Spectrum Virtualize (7.6 or later).
To create a VVol-enabled storage service:
v Enable VVol utilization at the side of a storage system that runs IBM Spectrum
Virtualize.
v Create the service, using Spectrum Control Base.
Procedure
1. Activate the storage system CLI utility and log in as SecurityAdmin, and then
create a user group with role VASAProvider (mkusergrp -name
<vasa_group_name> -role VASAProvider).
2.
Create a VASAProvider user in the user group (mkuser -name <user_name>
-usergrp <vasa_group_name>).
3. Create a metadata volume (mkmetadatavdisk -mdiskgrp <pool_name>). For the
storage systems that run microcode 7.6.1.0 or later, this operation requires the
SecurityAdmin access level. Also, on these storage systems, you can enable the
VVol feature by toggling the Enable VVOL switch under Settings -> System ->
VVOL, using the web GUI.
4. For each ESXi host, define the host on the storage system as adminlun type
(svctask mkhost -name <host_name> -fcwwpn <fibre_channel_wwpn>
-iscsiname <iscsi_wwn> -type adminlun).
5. Launch Spectrum Control Base.
6. Define a high-availability group. See “Defining a high-availability group” on
page 37.
7. Generate a self-signed Spectrum Control Base server certificate. See
“Managing server certificates” on page 39.
8. Set up VASA credentials. See “Setting the VASA credentials” on page 53.
9. Enable the VASAProvider user to access the storage resources. See “Entering
the storage system credentials” on page 45.
Chapter 11. Best practices
163
10. Add the storage system to the Spectrum Control Base. See “Adding a storage
system” on page 47.
11. Add a new storage space. See “Adding a storage space” on page 56.
12. Add a VVol-enabled service to the storage space. See “Adding a storage
service” on page 57.
13. Define a storage resource and attach it to the VVol-enabled service. See
“Defining and attaching storage resources” on page 60.
14. Register Spectrum Control Base as a storage provider on VMware vCenter
server. See “Registering Spectrum Control Base as a storage provider on
vCenter server” on page 83.
15. Launch the vWC and create a VVol-enabled datastore. Select the storage space
that you defined as an underlying storage resource for the datastore.
Configuring an LDAP user for a managed domain
To ensure that proper LDAP authentication is used in a storage system managed
domain, you must create a user with the storage integration administrator role
on the Active Directory server.
Before you begin
Verify that you configured the following entities:
v A managed domain on your storage system. In the example of the configuration
procedure, the dana-domain domain is used as a managed domain on XIV
storage system.
v Operational Microsoft Active Directory service with an active group and a user
attached to the group. In the example of the configuration procedure, they are
illustrated as the xivstorage group and the xivuser user.
About this task
The following procedure details how to configure an LDAP user for a managed
domain.
Procedure
1. Start the XIV management GUI and log in as a storage administrator.
2. Go to Systems > System Settings > LDAP. The LDAP dialog box is
displayed.
164
IBM Spectrum Control Base Edition
Figure 114. General tab, LDAP dialog box
3. On the General tab, enable the LDAP use and select the Microsoft Active
Directory, as a directory service. Then, click Update.
4. Go to the LDAP Servers tab, and verify that the FQDN and IP address of the
Active Directory server are correct.
5. Go to the User Credentials tab, and define the service user (xivuser in the
example) and its password. This user is bound to the Active Directory service.
It retrieves credentials data, which is stored in the LDAP directory. Then, click
Update.
Chapter 11. Best practices
165
Figure 115. User Credentials tab, LDAP dialog box
6. Go to the Role Mapping tab, and set the necessary values for the user
attributes, group attributes, and roles. Pay attention to the Storage Integration
Admin Role setting (xivstorageintegrationadmin in the example). This
parameter, along with the managed domain name, is used as a group name
on the Active Directory server. Then, click Update.
Figure 116. Role Mapping tab, LDAP dialog box
166
IBM Spectrum Control Base Edition
Note: On the Role Mapping tab, the values of the Storage Admin Role and
Storage Integration Admin Role parameters appear truncated. The full value
designations are as follows:
v Storage Admin Role: CN=xivstorage,CN=Users,DC=hsg,DC=test,DC=com.
v Storage Integration Admin Role:
CN=xivstorageintegrationadmin,CN=Users,DC=hsg,DC=test,DC=com.
7. Start your Active Directory management software and go to the group
configuration section.
8. In the group configuration section, add a new group with the following
attributes:
v Group name: xivstorageintegrationadmin@dana-domain. The group name
must be the same as the Storage Integration Admin Role setting on XIV
(xivstorageintegrationadmin) and it must include the name of the XIV
managed domain (dana-domain).
v Description: StorageIntegrationAdmin
v Group type: Security
v Group scope: Global
Figure 117. Group configuration on Active Directory server
9. Go to the user configuration section, create a new user and add it to the
xivstorageintegrationadmin@dana-domain group. The user should have the
following attributes:
v Full name: danasia
v User UPN logon: danasia@hsg.test.com
Chapter 11. Best practices
167
v User SamAccountName logon: hsg\* danasia
v Description: StorageIntegrationAdmin
v Member of: xivstorageintegrationadmin@dana-domain
Figure 118. User configuration on Active Directory server
10. Use the following XCLI commands to verify the LDAP configuration:
v Run the ldap_mode_get command to make sure that the LDAP
authentication is active:
>>ldap_mode_get
Mode
---------Active
v Run the ldap_test command to verify that the LDAP user xivuser has been
configured correctly:
>>>> ldap_test fqdn=hsg-ad1.hsg.test.com user=xivuser password=<password>
command 0:
administrator:
command:
code = "SUCCESS"
status = "0"
status_str = "Command completed successfully"
aserver = "DELIVERY_SUCCESSFUL"
v Run the ldap_test command again to verify that the LDAP storage
integration admin user danasia has been configured correctly:
168
IBM Spectrum Control Base Edition
>>>> ldap_test fqdn=hsg-ad1.hsg.test.com user=danasia password=<password>
command 0:
administrator:
command:
code = "SUCCESS"
status = "0"
status_str = "Command completed successfully"
aserver = "DELIVERY_SUCCESSFUL"
11. Start Spectrum Control Base and go to Setting > Storage Credentials. The
Storage Credentials dialog box is displayed.
Figure 119. Storage Credentials dialog box
12. In the Storage Credentials dialog box, enter the user name defined on the
Active Directory server (danasia), define a password, and select the Directory
account check box to specify that the credentials are stored on the Active
Directory server.
13. Click Apply to finish.
Chapter 11. Best practices
169
170
IBM Spectrum Control Base Edition
Chapter 12. RESTful API
RESTful API for IBM Spectrum Control™ Base Edition provides an application
programming interface (API) for retrieving status information and performing
basic maintenance of IBM Spectrum Accelerate™, deployed as a software storage
solution.
Note: All other storage systems, except the deployable IBM Spectrum Accelerate,
are not supported by the RESTful APIs.
RESTful API for Spectrum Control Base relies on a transport protocol to process
the following requests.
v Query – Returns object entities managed by Spectrum Control Base.
v Create – Creates a new entity.
v Delete – Deletes an existing entity.
v Update – Performs a partial update of an existing entity.
v Action – Performs a complimentary action (for example, phases out a disk on a
specific storage system).
RESTful API protocol
The API uses HTTP as the transport protocol and relies on HTTP for some features
(for example, security).
The protocol relies on HTTP methods to support CRUD operations
(Create/Read/Update/Delete).
v POST – Create and action operations.
v GET – Query (read) operations.
v DELETE – Delete operations.
v PATCH – Partial update operations.
The API URL is built from scope specifiers and resource identifiers.
v api – Specifies the main API scope.
v v1 – Specifies the protocol version.
v resource type – Specifies type of the system resource.
v id – Identifies the resource.
For example, GET /api/v1/disks/7.
RESTful API for Spectrum Control Base returns the following codes for request
status:
v 200 – The request has succeeded.
v 401 – The request requires user authentication.
v 405 – The request method is not allowed for the specified resource.
v 500 – The request cannot be implemented due to an unexpected condition.
Note: Additional codes may be used according to the requirements of the REST
standards.
© Copyright IBM Corp. 2013, 2016
171
Query request and response
RESTful API for IBM Spectrum Control Base Edition uses query requests to return
the state of a single resource or a list of resources.
You can run a query by issuing the GET command (on a URI). The following list
shows the query format types:
v A single resource – Single resource properties are returned.
v A collection of resources – A list of resources and their properties is returned.
For example, GET /api/v1/interfaces/22 lists the properties of the interface with
identification number 22, as illustrated below.
{
"name": "aaab",
"array": "pu16",
"module": "1:Module:1",
"type": "iSCSI",
"address": "3.3.3.5",
"netmask": "255.255.255.0",
"gateway": "3.3.3.254",
"address6": "",
"gateway6": "",
"mtu": "1500",
"ports": "1",
"id": 22
}
Note: Query requests can contain additional URI arguments, such as filtering
parameters. When used, it returns only resources that match your filtering criteria.
For example, GET /api/v1/interfaces?array=pu21 captures interfaces that exist on
array pu21.
The GET command can be used to monitor a running task. For example, GET
/api/v1/tasks/04fc6120-60ae-4182-baa9-687d6ae96ffe returns the current task
status:
{
"reason": null,
"task_id": "04fc6120-60ae-4182-baa9-687d6ae96ffe",
"start_time": "2015-03-03T06:57:48.573",
"task_state": "Running",
"array_id": "2810-999-PR16118",
"name": "disk phase-in"
}
A task ID is generated, when the task is initiated by the action request. See “Action
request and response” on page 174.
Create request and response
RESTful API for IBM Spectrum Control Base Edition uses create requests for object
creation.
You can create an object by issuing the POST command followed by request object.
The request must contain a set of parameters required for object creation.
For example, POST /api/v1/interfaces entered with the parameters detailed
below, creates an interface on the specified storage system module.
172
IBM Spectrum Control Base Edition
name aaab
address 3.3.3.3
netmask 255.255.255.0
gateway 3.3.3.254
array pu16
module 1:Module:1
ports 1
The response to the POST request is as follows:
v OK, followed by the new object, if the task is completed successfully.
v An error message, detailing a reason for the failed request, as illustrated below.
{
"detail": "One of the physical ports specified is already assigned to an IP Interface"
}
Delete request and response
RESTful API for IBM Spectrum Control Base Edition uses delete requests for object
deletion.
You can delete an object by issuing the DELETE command on a full URL. The
request must contains a single object, which is a target of the delete request.
For example, DELETE /api/v1/interfaces/22 deletes the interface 22.
The response to the delete request is OK if the task is completed successfully, or an
error message with a status code, detailing a reason for the failed request, as
illustrated below.
{
"detail": "Not found"
}
Update request and response
RESTful API for IBM Spectrum Control Base Edition uses update requests for
partial object update.
You can update an object by issuing the HTTP PATCH command on a full URL. The
request must contains a single object, which is the target of the update request.
For example, PATCH /api/v1/interfaces/26 entered with the parameters detailed
below, changes the name and IP address of the interface 26.
name aaac
address 3.3.3.5
The response to the update request is as follows:
v OK, followed by the updated object, if the task is completed successfully
v An error message with a status code, detailing a reason for the failed request, as
illustrated below.
{
"detail": "IP address specified for the default gateway is not in the subnet of
the IP Interface"
}
Chapter 12. RESTful API
173
Action request and response
RESTful API for IBM Spectrum Control Base Edition uses action requests to
perform complimentary actions on the requested objects, which are out of scope of
other request types.
You can initiate an action by issuing the POST command (on a URI). For example,
POST /api/v1/disks/82/phasein starts a phase-in procedure for disk 82.
The response to the request is OK, followed by the task ID, as illustrated below.
The task ID can be used in a query request to monitor the task progress, see
“Query request and response” on page 172.
OK
{
"task id": "04fc6120-60ae-4182-baa9-687d6ae96ffe"
}
If the request fails, an error message is displayed, carrying a status code with a
reason for the failed request.
Storage system operations
RESTful API for IBM Spectrum Control Base Edition uses the GET and POST
commands for storage system (array) operations.
You can run a storage system query by issuing the GET command to retrieve a list
of storage systems and their properties, or display the properties of a single
storage system.
For example, GET /api/v1/arrays/2810-999-dc21011 lists the properties of the
storage with identification number 2810-999-dc21011, as illustrated below.
OK 200
{
"id": 2810-999-dc21011,
"alias": "pu21",
"mgmt_addresses": [
"9.151.153.87",
"9.151.153.86",
"9.151.153.39"
"last_updated": "2015-04-15T17:55:02.431",
"error_message": "",
"connected": true,
"name": "XIV pur21m10m11m15",
"firmware_version": "11.5.0",
"scsi_model_identifier": "2810XIV",
"array_type": "2810XIV",
"storage_model": "XIV",
"physical_capacity": 12011310153728,
"serial": "21011",
"capacity_max_pool_size": 12011,
"capacity_soft_mib": 11454878,
"capacity_hard_mib": 11454878,
"capacity_free_soft_mib": 32822,
"capacity_free_hard_mib": 6859798,
"capacity_spare_disks": 3,
"capacity_spare_modules": 1,
"capacity_target_spare_disks": 3,
"capacity_target_spare_modules": 1,
"capacity_limit_percentage": 100
}
174
IBM Spectrum Control Base Edition
The upgrade procedure is implemented by issuing the POST command with this
syntax: POST /api/v1/arrays/<array-id>/upgrade. The input parameters include
the following mandatory entries: username, password and pkg_name.
Note: Before running the upgrade, verify that:
v The correct installation file is stored in the /opt/ibm/ibm_spectrum_control/
downloads/ directory. The package must be compatible with the valid upgrade
path from the current microcode.
v The credentials to be supplied have sufficient access level to complete the
upgrade procedure.
For example, to upgrade the storage system 2810-999-dc21011 microcode to version
11.5.0.c, enter POST /api/v1/arrays/2810-999-dc21011/upgrade with the required
parameters.
POST /api/v1/interfaces
{
"username": "opsadmin",
"password": "opspasswd",
"pkg_name": "xiv_ver_11.5.0.c.tgz"
}
If the response to the upgrade request is OK, followed by the task ID, as illustrated
below. The task ID can be used in a query request to monitor the upgrade
progress, see “Query request and response” on page 172.
OK
{
"task id": "04fc6120-60ae-4182-baa9-687d6ae96ffe"
}
In addition, you can use the GET to retrieve the current state of the upgrade
procedure.
For example, to get the current upgrade status for storage system
2810-999-dc21011, enter GET /api/v1/arrays/2810-999-dc21011/upgrade. The
output is illustrated below.
OK 200
{
"array": "2810-999-dc21011",
"state": "Upgrade Not Underway",
"consequence": "New version has not been downloaded yet",
"package_target_version": ""
}
Module operations
RESTful API for IBM Spectrum Control Base Edition uses the GET and POST
commands for module operations.
You can run a module query by issuing the GET command to get a list of modules
that belong to a storage system and their properties, or display the properties of a
single module.
For example, GET /api/v1/modules/1 lists the properties of the module with
identification number 1, as illustrated below.
OK 200
{
"id": 1,
Chapter 12. RESTful API
175
"component_id": "1:Module:7",
"status": "OK",
"type" : "g3.0_interface",
"requires_service": "REPLACE",
"service_reason" : "HARDWARE_ERROR",
"disk_bay_count" : 12,
"fc_port_count" : 4,
"ethernet_port_count" : 4,
"memory_gb" : 15
}
You can initiate phase-in or phase-out action on a module by issuing the POST
command with the following syntax:
v POST /api/v1/modules/<module-id>/phasein
v POST /api/v1/modules/<module-id>/phaseout
For example, POST /api/v1/modules/3/phasein starts a phase-in procedure for the
module with identification number 3. The response to the request is OK, followed
by the task ID, as illustrated below. The task ID can be used in a query request to
monitor the task progress, see “Query request and response” on page 172.
OK
{
"task id": "04fc6120-60ae-4182-baa9-687d6ae96ffe"
}
Disk operations
RESTful API for IBM Spectrum Control Base Edition uses the GET and POST
commands for disk operations.
You can run a disk query by issuing the GET command to get a list of disks that
belong to a storage system and their properties, or display the properties of a
single disk.
For example, GET /api/v1/disks/1 lists the properties of the disk with
identification number 1, as illustrated below.
OK 200
{
"id": "1",
"array": "pur15m1",
"name": "1:Disk:1:2",
"status": "OK",
"capacity": "2TB",
"vendor" : "IBM",
"model" : "ST32000444SS",
"size" : "1878633",
"serial" : "9WM1YM3M",
"requires_service" : "REPLACE",
"service_reason" : "HARDWARE_ERROR",
"temperature" : 19,
"encryption" : "Not supported"
"controller" : "SAS"
}
You can initiate phase-in or phase-out action on a disk by issuing the POST
command with the following syntax:
v POST /api/v1/disks/<disk-id>/phasein
v POST /api/v1/disks/<disk-id>/phaseout
176
IBM Spectrum Control Base Edition
For example, POST /api/v1/disks/82/phasein starts a phase-in procedure for the
disk with identification number 82. The response to the request is OK, followed by
the task ID, as illustrated below. The task ID can be used in a query request to
monitor the task progress, see “Query request and response” on page 172.
OK
{
"task id": "04fc6120-60ae-4182-baa9-687d6ae96ffe"
}
Interface operations
RESTful API for IBM Spectrum Control Base Edition uses the GET, PATCH, POST and
DELETE commands for interface operations.
You can run an interface query by issuing the GET command to get a list of IP
interfaces that belong to a storage system and their properties, or display the
properties of a single interface. The command output can be filtered by module ID
or interface type (management, iSCSI, etc.).
For example, GET /api/v1/interfaces/11 lists the properties of the interface with
identification number 11, as illustrated below.
OK 200
{
"name": "management",
"array": "pu16",
"module": "1:Module:1",
"type": "Management",
"address": "9.151.156.3",
"netmask": "255.255.248.0",
"gateway": "9.151.159.254",
"address6": "",
"gateway6": "",
"mtu": "1500",
"ports": "",
"id": 11
}
You can initiate a partial update action on an interface by issuing the PATCH
command with the following syntax: PATCH /api/v1/interfaces/<interface-id>.
The input parameters include the following entries: name, mtu, netmask, address,
gateway.
For example, the following request updates the required parameters for interface
25.
PATCH /api/v1/interfaces/25
{
"name": "interface_name",
"address": "9.151.151.3"
}
The response to the request is as follows:
OK 200
{
"name": "interface_name",
"array": "pu16",
"module": "1:Module:1",
"type": "iSCSI",
"address": "9.151.151.3",
"netmask": "255.255.255.248",
"gateway": "9.151.151.222",
Chapter 12. RESTful API
177
"address6": "",
"gateway6": "",
"mtu": "1500",
"ports": "1",
"id": 25
}
You can create a new iSCSI interface entry by issuing the POST command with the
following syntax: POST /api/v1/interfaces. The input parameters include the
following entries:
v Mandatory – name, address, array, netmask, module, ports.
v Optional – mtu, gateway.
For example, the following request creates a new interface with the required
parameters.
POST /api/v1/interfaces
{
"name": "iSCSI_1_1",
"array": "pu16",
"module": "1:Module:1",
"address": "9.151.151.151",
"netmask": "255.255.255.248",
"gateway": "9.151.151.222",
"mtu": "1500",
"ports": "1"
}
The response to the request is as follows:
OK 200
{
"name": "iSCSI_1_1",
"array": "pu16",
"module": "1:Module:1",
"type": "iSCSI",
"address": "9.151.151.151",
"netmask": "255.255.255.248",
"gateway": "9.151.151.222",
"address6": "",
"gateway6": "",
"mtu": "1500",
"ports": "1",
"id": 25
}
You can delete an iSCSI interface by issuing the DELETE command with the
following syntax: DELETE /api/v1/interfaces/<interface-id>.
For example, DELETE /api/v1/interfaces/1 deletes the interface with identification
number 1.
Port operations
RESTful API for IBM Spectrum Control Base Edition uses the GET command for
port operations.
You can run an interface query by issuing the GET command to get a list of IP ports
that belong to a storage system and their properties, or display the properties of a
single port. The command output can be filtered by module ID or interface type
(management, iSCSI, etc.).
178
IBM Spectrum Control Base Edition
For example, GET /api/v1/ports/1 lists the properties of the port with
identification number 1, as illustrated below.
OK 200
{
"index": 1,
"array": "pur15m1",
"role": "iSCSI",
"ip_interface": "iSCSI_1_1",
"module" : "1:Module:1"
}
Emergency shutdown
RESTful API for IBM Spectrum Control Base Edition uses the POST command for
initiating an emergency storage system shutdown.
You can shut down a storage system in emergency mode by issuing the POST
command, followed by the arrays argument, the storage system ID and the
shutdown argument.
For example, POST /api/v1/arrays/1/shutdown shuts down the storage system
with identification number 1, issuing the OK response.
Chapter 12. RESTful API
179
180
IBM Spectrum Control Base Edition
Notices
These legal notices pertain to the information in this IBM Storage product
documentation.
This information was developed for products and services offered in the US. This
material may be available from IBM in other languages. However, you may be
required to own a copy of the product or product version in that language in order
to access it.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
USA
For license inquiries regarding double-byte character set (DBCS) information,
contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
© Copyright IBM Corp. 2013, 2016
181
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
USA
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
The performance data discussed herein is presented as derived under specific
operating conditions. Actual results may vary.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of the
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Copyright and trademark
information website (www.ibm.com/legal/us/en/copytrade.shtml).
VMware, the VMware logo, ESX, ESXi, vSphere, vCenter, and vCloud are
trademarks or registered trademarks of VMware Corporation in the United States,
other countries, or both.
Microsoft, Windows Server, Windows, and the Windows logo are trademarks or
registered trademarks of Microsoft Corporation in the United States, other
countries, or both.
182
IBM Spectrum Control Base Edition
Linux is a trademark of Linus Torvalds in the United States, other countries, or
both.
Other product and service names might be trademarks of IBM or other companies.
Notices
183
184
IBM Spectrum Control Base Edition
Index
A
access to system 141
add
storage provider 83
storage system 143
user 138
adding vROps server 80
admin commands 138
administration 133
alarm reporting 135
alert widget 118
array credentials 155
automation 2
deleting 156
deploying management package
detect problems 153
directory user 155
directory users 23
download plug-in 72
download site 11
DS8000 volumes
best practices 159
79
E
ESX server versions 159
event forwarding 156
extract files 12
B
backup 150
best practices 160, 161, 162, 163
datastores 159
distributing DS8000 volumes 159
ESXi hosts 159
C
certificate
generating 39, 139
replacing 39, 139
change password 138
check service 133
CLI commands 137
collect logs 153
command-line interface
add or remove storage system
credentials 141
add or remove storage systems 143
adding users 138
backup or restore server
configuration 150
configure directory server access 23
manage vRealize Operations
Manager 146
managing Spectrum Control
Base 137
set VASA credentials 145
switch to IBMSC user mode 137
tasks 21
compatibility 11
concept diagram 3
configuration backup 150
configuration files
modify 134
creating or mapping
LUN 94
D
datastores
best practices 159
debug mode 134
© Copyright IBM Corp. 2013, 2016
F
Fix Central
11
G
GUI 30
add storage system 47, 49
adding new users 42
adding storage service 58
adding storage space 56
adding storage system 47, 49
adding vCenter server 67
attach storage resource 60
cancel storage service delegation to
vCenter server 71
cancel storage service delegation to
vRO server 76
change user password 43
define storage resource 60
defining high-availability groups 37
delegate storage services to vCenter
server 69
deleting users 44
detach storage resources from
services 65
enter storage system credentials 45
manage storage spaces and
services 54
manage storage systems 44
manage the users 41
manage VASA access 53, 54
manage vRealize Operations
Manager 77
manage vRealize Orchestrator 71
manage vSphere Web Client 66
modify IP address or hostname 52
remove storage service 60
remove storage system 52
remove vCenter server 69
removing storage space 57
resize storage resource 64
setting VASA credentials 53
storage credentials 45
GUI (continued)
tasks 21
update vCenter server credentials 68
H
HA group 36
High-availability group
hsgsvr_config.ini 134
36
I
IBM Storage Manager 29, 33
ibmsc username 12
ibmsyslog.conf 134
Install 161
installation
Spectrum Control Base Edition
29, 33
upgrade 15
interval 134
12,
L
large-scale deployment 160
LDAP 23, 155, 164
ldap.conf 23
ldap.ini 23, 134
list
storage system 143
users 138
log files 153
LUN
create 94
M
management 21
management package 78
managing pools on vRO 75
managing systems on vROps
metrics 120
metrics scope 135
monitoring 127, 128
multipath policy 102, 159
81
O
Operations Manager 3
optional tasks 21
Orchestrator 2
Overview dashboard 113, 115, 118
P
PAK 78, 79
Performance dashboard
performance data 3
113, 118, 120
185
plug-in package
port 8440 136
port 8443 136
72, 76
Update 161
upgrade 15
user
privileges 87
roles 87
user authentication
username 155
R
register
Spectrum Control Base 83
release notes 11
remove
storage credentials 141
storage system 143
user 138
remove VASA certificate 53, 54
required tasks 21
requirements 11
resolve issues 133, 153
restore 150
Round Robin 102, 159
rpm package 12
V
S
save configuration 150
server users 138
service 7
service status 133
space 7
SPBM 6
SSL 134
SSL verification 136
start service 133
stop service 133
storage credentials 155
display 141
remove 141
set 141
storage enhancements
vSphere Web Client 87
storage monitoring 3
Storage Policy Based Management
storage resource information
viewing 89
storage system commands 143
storage volume
create 94
supported storage systems 11
system credentials 141
system update interval 135
6
VASA access 53, 54
VASA credentials 53, 145
VASA Provider server 83
vasa_config.ini 134
vCAC 2
vCenter Server 83
vCloud automation 2
vcops_config.ini 134
vendor providers 83
virtual volume 156
virtual volumes 5
VMware VASA
using storage provider 83
volume
deleting unused 104
extending 99
multipath policy enforcement 102
rename 101
unmapping from host 103
vRealize Operations Manager 3, 78, 79,
80, 81, 113, 115, 118, 120, 126, 127, 128,
135, 136
vRealize Orchestrator 2, 75, 76, 109
vRO 2, 71, 75, 76, 109
vRO plug-in 72, 76
vROps 3, 78, 79, 80, 81, 113, 115, 118,
120, 126, 127, 128, 135, 136, 160
vSphere privileges 87
vSphere Web Client 83
storage enhancements 2
vSphere Web Client enhancements 87
VVol 5, 161, 162, 163
displaying info 105
VVol service 161, 162, 163
vWC 66
vwc_config.ini 134
W
what to do first
workflows 2
T
tar.gz file 12
tasks 21
thresholds 128
time interval 134
Top 10 dashboard 113, 126
troubleshoot 153
troubleshooting 156
U
uninstall
Spectrum Control Base Edition
software 19
186
23
IBM Spectrum Control Base Edition
21
IBM®
Printed in USA
SC27-5999-17
Download PDF
Similar pages