Products > Service Connect API Datasheet
Overview
The Service Connect API provides read-only access to the information that resides in SANscreen. SANscreen's repository is a rich collection of both device level inventory information combined with higher order service level information that details the actual storage services delivered to a host.
While storage teams may find the device level information of value for integration into provisioning, asset management and other systems, the service level information has significant value to other infrastructure groups outside of storage.
Use Cases
Likely use cases for the Service Connect API are:
- Integrate storage data into a centralized IT Dashboard to improve visibility and troubleshooting
- Integrate storage monitoring into a standard help desk network operations center (NOC)
- Chargeback reports
- Software vendors integrate the API into their own applications to provide SAN visibility
- Integration into IT ticketing systems
Supported SANscreen Objects
The API is based on SOAP and Web services and provides flexibility of using the API from almost any programming environments, including Java, Perl and others. The API currently provides information on:
- Devices: Host, HBA, Tape, Storage Arrays, Switch
- Physical connectivity between devices
- Device configurations - Volumes, mapping, masking, zones, fabrics, VSAN,
- Access Paths - path level information between hosts and volumes revealing access paths, redundancy level, volumes
- Policies and violations - Access path policies and violations of those policies
- Changes - Device and path changes
Sample Classes - Inventory
| Class |
Description |
| Host |
Represents a host/server in the SAN. |
| LogicalPort |
Represents a logical port in the SAN. |
| Node |
Represents a node in the SAN. |
| Port |
Represents a port in the SAN. |
| StorageArray |
Represents a storage array in the SAN. |
| Switch |
Represents a switch in the SAN. |
| Tape |
Represents a tape storage device in the SAN. |
| Volume |
Represents a volume in the SAN. |
| VolumeMap |
Represents the mapping of a volume to a disk storage port. |
| VolumeMask |
Adds masking between a volume (disk storage port) and a host. |
Sample Classes - Services
Class |
Description |
| Path |
Represents a path in the SAN. |
Licensing
Onaro customers running SANscreen Foundation 3.0 and later can receive a license for the API by contacting their account manager. For new customers, the API may be included in SANscreen Foundation. Independent software vendors looking to use the API should apply for the Service Connect program.
