Hitachi Virtual Storage Platform
The Hitachi Virtual Storage Platform (VSP) is a high-capacity, high-performance, large-scale, enterprise-class SAN storage system. The main advantage of the Hitachi Virtual storage platform (VSP) is its 3D scaling capability.
CloudFabrix's RDA supports integrating with Hitachi VSP’s through it's API interface to collect inventory data on-demand or on schedule basis
This document provides a list of available Hitachi VSP bots available integrated with CFX RDA Platform.
1. Prerequisites
This procedure describes how to create a CFX readonly user account and register the account to a user group with appropriate roles.
User Name: CFX
Password : xxxxxx
Setting up user accounts Hitachi storage systems
1. In the Maintenance Utility window, click Administration > User Administration.
2. In the User Groups tab, click Create User.
3. Create a new user account. Specify the User Name, Account Status, Authentication and User Group. Click Finish.
Note
Please select the User Group/Role as “Storage Administrator (View Only)”, If custom roles are created in your environment, give the custom role name which has ready only access to all the objects.
4. Confirm the settings, and then click Apply.
5. When the completion message appears, click Close.
2. Adding Hitachi VSP as Datasource/Extension in RDA Studio
Hitachi Virtual Storage Platform (VSP)or any other datasource/extension's configuration is configured in RDA's user interface. Login into RDA's user interface using a browser.
Under Notebook, click on CFXDX Python 3 box
In the Notebook command box, type Administration:Manage Bot Sources and alt (or option) + Enter to open datasource administration menu.
Click on Add menu and under Type drop down, select hitachi-vsp
Enter the below details to add Hitachi Virtual Storage Platform (VSP) as a datasource:
-
Name
-
Cluster IP (IP Address or DNS name of Hitachi Virtual Storage Platform (VSP) array cluster)
-
Username and Password
-
Port (API access port, ex: 443)
-
Protocol (http or https)
2.1 Steps to Add Hitachi VSP Credentials in RDAF Platform
Please use the below mentioned Navigation Path, after logging into the CFX Portal
- Navigation Path : Home Menu -> Configuration -> RDA Integrations -> Credentials -> Add -> Click on the Dropdown to select the Credential -> enter the data and Save
Note
Once the details are provided please click on Check Connectivity as shown in the above screenshot and once its authenticated it should display OK Status
3. Hitachi VSP Bots
3.1 @hitachi-vsp: storage-systems
This API in Hitachi VSP provides detailed information and management capabilities for storage systems. This API is typically used for querying the status, configuration, and capacity details of storage systems in a Hitachi VSP environment
Below is the API it executes while running the storage-systems bot.
Information user gets by executing the storage-systems bot
| Category | Details |
|---|---|
| Storage System Details | - Storage system name, ID, and model (e.g., VSP G Series, VSP 5000 Series). - Firmware and microcode versions. |
| Capacity Information | - Total storage capacity. - Used and free capacity. - Storage pool utilization levels. |
| Health and Status | - Overall system health (e.g., healthy, degraded, or error states). - Alerts and warnings. |
| Storage Pools | - List of storage pools. - Pool size, usage, and RAID configurations. |
| RAID Configuration | - RAID levels and associated disks. - Disk health and status. |
3.2 @hitachi-vsp: storage-summary
This API in Hitachi VSP provides a detailed summary of a specific storage instance. This API is designed to give concise, high-level insights into the state, capacity, and usage of a particular storage system.
Below is the API it executes while running the storage-summary bot.
Information user gets by executing the storage-summary bot
| Category | Details |
|---|---|
| General Storage Information | - Instance ID: Unique identifier of the storage instance. - Model: Model of the storage system. - Name: User-defined or system-assigned name for the instance. - Serial Number: Unique hardware identifier. - Firmware Version: Current version of the storage firmware. |
| Capacity Summary | - Total Capacity: Total usable capacity of the storage system. - Used Capacity: Amount of storage currently in use. - Free Capacity: Remaining storage available for allocation. - Capacity Utilization(%): Percentage of used storage. |
| Health Status | - Overall Status: Health of the storage system (e.g., Healthy, Warning, Critical). - Alerts: List of active warnings, errors, or critical issues. - Disk Status: Summary of disk health (e.g., failed, degraded, or healthy). |
| Pools Summary | - Number of Pools: Total storage pools configured. - Pool Utilization: Average and individual pool usage statistics. - Unused Pools: Pools that have not been allocated to LUNs. |
| Logical Storage | - Number of Volumes (LUNs): Total logical volumes configured. - Largest Volume: Size and details of the largest logical unit. - Volume Utilization: Usage statistics for logical storage. |
3.3 @hitachi-vsp: licenses
The API in Hitachi VSP provides detailed information about the licenses installed on a Hitachi Virtual Storage Platform. This API is typically used to monitor, validate, and manage licensing information related to the storage system and its features.
Below is the API it executes while running the licenses bot.
| Category | Details |
|---|---|
| General License Info | - License ID: Unique identifier for each license. - License Name: Name of the licensed feature or functionality. - Description: Brief description of the license's purpose. |
| License Status | - Status: Indicates whether the license is active, expired, or invalid. - Start Date: The date when the license became active. - End Date: The expiration date of the license (if applicable). - Duration: The validity period of the license. |
| Feature Details | - Features Enabled: The specific features or capabilities enabled by the license. - Capacity Limits: Any capacity restrictions tied to the license (e.g., "10TB"). - Usage: Current usage against licensed capacity (e.g., "8TB used of 10TB"). |
| License Type | - Type: Specifies the type of license (e.g., "Perpetual", "Subscription", or "Trial"). |
| Compliance | - Compliance Status: Indicates if the system is in compliance with the license terms. - Grace Period: Time remaining in a grace period if the license has expired. |
| Activation Details | - Activation Key: Key or token used to activate the license. - Activation Status: Whether the activation was successful. |
3.4 @hitachi-vsp: clprs
The v1/objects/clprs API in Hitachi Virtual Storage Platform (VSP) is used to retrieve information about Cache Logical Partitions (CLPRs) configured in the storage system. CLPRs are a feature in VSP storage systems that allow the division of cache memory into logical partitions to optimize performance for different workloads or applications.
Below is the API it executes while running the clprs bot.
| Category | Details |
|---|---|
| CLPR Details | - CLPR ID: Unique identifier for each Cache Logical Partition. - Name: Name of the CLPR (if configured). |
| Cache Allocation | - Total Cache Size: Total cache memory allocated to the CLPR. - Used Cache Size: Amount of cache currently used by the CLPR. - Free Cache Size: Remaining cache available for allocation within the CLPR. |
| Cache Utilization | - Read Cache Utilization: Percentage of read cache used. - Write Cache Utilization: Percentage of write cache used. |
| Performance Metrics | - IOPS: Input/output operations per second for the CLPR. - Throughput: Data transfer rate for the CLPR. - Hit Ratio: Cache hit ratio for read and write operations. |
| CLPR Configuration | - Resource Groups: List of resource groups or workloads associated with the CLPR. - Priority Level: Priority assigned to the CLPR (if applicable). |
| Health and Status | - Status: Indicates whether the CLPR is active, idle, or experiencing issues. - Alerts: Warnings or critical events related to the CLPR. |
3.5 @hitachi-vsp: total-capacities
@hitachi-vsp:total-capacities: The v1/objects/total-capacities/instance API in Hitachi VSP provides a summary of the total capacity information for a specific storage system instance. This API is particularly useful for monitoring and analyzing the overall storage capacity, allocation, and utilization of the system.
Below is the API it executes while running the total-capacities bot.
| Category | Details |
|---|---|
| Capacity Overview | - Total Capacity: Total physical storage capacity of the system. - Usable Capacity: Total storage capacity available for use after accounting for system overhead. - Free Capacity: Remaining storage capacity that is unallocated or available for use. |
| Usage Statistics | - Used Capacity: Amount of storage currently in use. - Capacity Utilization (%): Percentage of the total capacity that is currently used. |
| Allocation Details | - Allocated Capacity: Storage capacity that has been allocated to volumes or logical units. - Unallocated Capacity: Capacity that has not yet been assigned to volumes or logical units. |
| Snapshot and Replication | - Snapshot Capacity: Capacity used by snapshots. - Replication Capacity: Capacity allocated for replication tasks. |
| Pool Details | - Number of Pools: Total number of storage pools configured in the system. - Pool Utilization: Average utilization across all pools. |
3.6 @hitachi-vsp: drives
The v1/objects/drives API in Hitachi VSP provides detailed information about the physical drives in the storage system. This API is primarily used for monitoring, managing, and analyzing the status, performance, and attributes of drives.
Below is the API it executes while running the drives bot.
| Category | Details |
|---|---|
| Drive Identification | - Drive ID: Unique identifier for the drive. - Serial Number: Manufacturer-provided serial number. - Drive Type: Type of drive (e.g., SSD, HDD). |
| Capacity Details | - Total Capacity: Total physical capacity of the drive. - Used Capacity: Amount of capacity currently in use. - Free Capacity: Available capacity on the drive. |
| Status Information | - Drive Status: Indicates if the drive is healthy, degraded, or failed. - Error Status: Details about any errors reported by the drive. |
| Performance Metrics | - Read/Write IOPS: Input/output operations per second. - Throughput: Data transfer rate for read and write operations. - Latency: Average response time of the drive. |
| Drive Location | - Enclosure ID: ID of the enclosure housing the drive. - Slot Number: Physical slot where the drive is installed. |
| Configuration Details | - RAID Group: RAID group the drive is part of. - Pool Association: Storage pool(s) the drive contributes to. - Tier Association: Storage tier the drive belongs to. |
| Health and Lifecycle | - Power-On Hours: Total hours the drive has been powered on. - Wear Level: For SSDs, the wear level indicating remaining lifespan. - Health Status: Drive health based on diagnostics (e.g., SMART status). |
| Drive Firmware | - Firmware Version: Current firmware version installed on the drive. - Update Available: Whether a firmware update is available. |
3.7 @hitachi-vsp: virtual-storages
The v1/objects/virtual-storages API in Hitachi VSP provides detailed information about the virtual storage systems managed within the storage environment. It helps in monitoring and managing the virtualized storage instances, which are logical representations of physical storage resources.
Below is the API query it executes while running the virtual-storages bot.
| Category | Details |
|---|---|
| Virtual Storage Identification | - Virtual Storage ID: Unique identifier for the virtual storage system. - Name: Name or alias assigned to the virtual storage system. - Description: Optional description providing context about the virtual storage system. |
| Capacity Details | - Total Capacity: Total physical capacity available within the virtual storage system. - Used Capacity: Total amount of storage utilized. - Free Capacity: Available storage that is not yet allocated. |
| Status Information | - Virtual Storage Status: Operational state of the virtual storage system (e.g., active, inactive, error). - Alerts: Any warnings or issues detected for the virtual storage system. |
| Performance Metrics | - IOPS: Input/output operations per second for the virtual storage. - Throughput: Data transfer rate for the system. - Latency: Average latency across operations. |
| Replication Details | - Replication Status: Status of any replication tasks (e.g., syncing, idle). - Replication Relationships: Details about paired systems or replication targets. |
| Configuration Details | - Storage Pools: List of storage pools within the virtual storage. - Resource Allocation: Overview of resources allocated to logical units (LUNs). - Host Groups: Hosts or host groups associated with the virtual storage. |
3.8 @hitachi-vsp: parity-groups
The v1/objects/parity-group API in Hitachi VSP provides detailed information about the parity groups within the storage system. A parity group is a collection of drives in a RAID configuration that provides data protection through parity. This API helps monitor and manage the state, health, capacity, and configuration of these parity groups.
Below is the API query it executes while running the parity-groups bot.
| Category | Details |
|---|---|
| Parity Group Identification | - Parity Group ID: Unique identifier for the parity group. - Name: Name assigned to the parity group. - Description: Optional description for the parity group. |
| Capacity Details | - Total Capacity: Total capacity of the parity group. - Used Capacity: Total storage used within the parity group. - Free Capacity: Available storage within the parity group. |
| RAID Configuration | - RAID Level: The RAID level used by the parity group (e.g., RAID5, RAID6). - Number of Drives: Total number of drives in the parity group. - Drive Types: Types of drives used in the parity group (e.g., SSD, HDD). |
| Status Information | - Parity Group Status: Indicates the operational state of the parity group (e.g., active, degraded, failed). - Health Status: Overall health status based on diagnostics (e.g., good, warning, critical). |
| Drive Details | - Drive IDs: IDs of the drives in the parity group. - Drive States: States of the individual drives (e.g., online, offline, degraded). |
3.9 @hitachi-vsp: pools
The v1/objects/pools API in Hitachi VSP provides detailed information about the storage pools within the system. A storage pool is a collection of physical storage resources, such as drives, organized to manage and allocate space more effectively. This API is useful for monitoring, managing, and optimizing storage resources across the pools.
Below is the api query it executes while running the pools bot.
| Category | Details |
|---|---|
| Pool Identification | - Pool ID: Unique identifier for the storage pool. - Name: Name of the pool. - Description: A description of the pool. |
| Capacity Details | - Total Capacity: The total capacity available in the pool. - Used Capacity: The amount of space already consumed by allocated volumes. - Free Capacity: The amount of available space remaining in the pool. |
| Health & Status | - Status: The current operational state of the pool (e.g., normal, degraded, error). - Health: The health status of the pool (e.g., healthy, degraded, critical). |
| RAID Configuration | - RAID Level: The RAID level used in the pool (e.g., RAID1, RAID5, RAID6, etc.). - Number of Drives: The number of drives in the pool. - Drive Types: The types of drives in the pool (e.g., SSD, HDD). |
| Performance Metrics | - Read/Write IOPS: Input/output operations per second for the pool. - Throughput: The total data throughput (e.g., MB/s, GB/s). - Latency: The average latency for operations within the pool. |
| Virtual Storage Links | - Virtual Storage IDs: Identifiers of virtual storage systems linked to this pool. - Host Groups: Host groups that are using this storage pool. |
3.10 @hitachi-vsp: ldevs
@hitachi-vsp:ldevs: The v1/objects/ldevs API in Hitachi VSP provides detailed information about the Logical Devices (LDEV) within the system. An LDEV represents a logical storage volume presented to the host, often associated with storage pools, virtual storage systems, and other elements. This API helps monitor, manage, and retrieve configurations of the LDEVs to ensure optimal storage management.
Below is the api query it executes while running the ldevs bot.
| Category | Details |
|---|---|
| LDEV Identification | - LDEV ID: Unique identifier for the logical device (LDEV). - Name: Name assigned to the logical device. - Description: A description of the logical device (if available). |
| Capacity Details | - Total Capacity: The total capacity of the LDEV. - Used Capacity: The storage space used within the LDEV. - Free Capacity: The amount of free space remaining in the LDEV. |
| Status Information | - LDEV Status: Current operational state of the logical device (e.g., online, offline, error, degraded). - Health Status: Health status indicating whether the LDEV is healthy or experiencing issues. |
| Raid Group Information | - RAID Group ID: The identifier of the RAID group associated with the LDEV. - RAID Level: The RAID level used in the RAID group (e.g., RAID1, RAID5, RAID6). |
| Host Group Information | - Host Group ID: Identifier of the host group associated with the LDEV. - Host Group Name: Name of the host group associated with the LDEV. - Host Group Configuration: Configuration details of the host group. |
| LDEV Configuration | - RAID Configuration: The RAID configuration (e.g., RAID5, RAID1) used in the LDEV. - Data Protection: The data protection mechanisms associated with the LDEV (e.g., mirroring, parity). |
3.11 @hitachi-vsp: host-wwns
The v1/objects/host-wwns API in Hitachi VSP provides detailed information about the World Wide Names (WWNs) associated with hosts that are connected to the storage system. A WWN is a unique identifier assigned to a host’s Fibre Channel (FC) interface, enabling the identification and management of hosts within the storage network. This API is used to retrieve and manage host-initiated connections to storage devices.
Below is the api query it executes while running the host-wwns bot.
| Category | Details |
|---|---|
| WWN Identification | - WWN: World Wide Name of the host’s Fibre Channel adapter (FC). - Host ID: Unique identifier for the host. - Host Name: The name of the host connected to the storage system. |
| Host Details | - Host Group ID: The identifier of the host group to which the host belongs. - Host Group Name: Name of the host group associated with the WWN. - Host Type: The type of host (e.g., physical server, virtual machine). |
| Connection Status | - Connection Status: Indicates whether the host is currently connected or disconnected from the storage system (e.g., online, offline, error). - Connection Type: Type of connection (e.g., Fibre Channel, iSCSI, FCoE). |
| Port Information | - Port ID: Identifier for the FC port associated with the host WWN. - Port Name: Name of the FC port. - Port State: Current state of the port (e.g., online, offline). |
| Volume Access | - Access Mode: Mode in which the host has access to the volume (e.g., read-write, read-only). - Volume ID: Identifiers of volumes associated with the host WWN. |
| WWN Mapping | - LDEV ID(s): The Logical Device (LDEV) ID(s) associated with the WWN. - LDEV Name(s): The name(s) of the logical devices mapped to the host WWN. |
| Fibre Channel Information | - Fabric Name: The name of the Fibre Channel fabric to which the host is connected. - Fabric Status: Status of the fabric connection (e.g., operational, degraded). |
| WWN Availability | - Availability Status: Availability status of the WWN (e.g., available, not available). - Failure Causes: Possible reasons for any WWN connectivity issues (e.g., cable failure, port failure). |
3.12 @hitachi-vsp: host-groups
The v1/objects/host-groups API in Hitachi VSP provides detailed information about Host Groups within the storage system. A Host Group is a logical grouping of hosts that share storage resources. This API is useful for managing, configuring, and monitoring host groups in the system, ensuring that resources are properly allocated and optimized.
Below is the api query it executes while running the host-groups bot.
| Category | Details |
|---|---|
| Host Group Identification | - Host Group ID: A unique identifier for the host group. - Host Group Name: The name assigned to the host group. - Description: A description of the host group. |
| Hosts in the Group | - Host IDs: List of IDs of the hosts in the group. - Host Names: The names of the hosts included in the group. - WWNs: The World Wide Names (WWNs) of the hosts in the group. |
| Storage Association | - LDEV IDs: The Logical Device (LDEV) IDs associated with the host group. - Volume IDs: The volume IDs allocated to the host group. - Virtual Storage IDs: The virtual storage systems assigned to the host group. |
| Access Configuration | - Access Mode: The mode in which the hosts can access storage (e.g., read/write, read-only). - LUN Masking: Indicates if LUN masking is configured for the host group. |
| Host Group Status | - Status: The operational state of the host group (e.g., active, inactive, error). - Last Updated: Timestamp of the last status update. |