Cisco Data Center Network Manager Guide
Advertisement
Advertisement
SMI-S and Web Services Programming
Guide, Cisco DCNM for SAN, Release
10.1(x)
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO
CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS
MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY
PRODUCTS.
Cisco Systems, Inc.
www.cisco.com
Cisco has more than 200 offices worldwide.
Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks . Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2016 Cisco Systems, Inc. All rights reserved.
78-xxxxx-xx
C O N T E N T S
New and Changed Information
15
Preface
17
Obtaining Documentation and Submitting a Service Request
1-21
Introduction to Cisco DCNM for SAN SMI-S
1-1
About the Common Information Model
1-1
About the Storage Management Initiative Specification
1-2
1-3
Understanding CIM and Unified Modeling Language Notation
1-3
1-3
1-4
About SMI-S and CIM in Cisco DCNM for SAN
1-4
Cisco DCNM SMI-S Server Support
2-1
2-1
2-2
2-2
2-3
2-8
2-10
Switch Partitioning Subprofile
2-11
2-13
2-14
2-15
2-20
2-22
2-24
Enhanced Zoning and Enhanced Zoning Control Subprofile
2-25
2-27
Configuring and Using Cisco DCNM SMI-S Server
3-1
Installing Cisco DCNM SMI-S Server
3-1
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
1
Contents
Changing the Default SMI-S Port
3-2
Performing Discovery and Performance Monitoring
3-3
Modeling a Module Using the Blade Subprofile
3-3
3-4
SMI-S Notifications
4-1
4-1
Supported Indications in SMI-S Server
4-3
Sample SMI-S Java Client
5-1
Installing Sample SMI-S Client
5-2
Services Provided by SMI-S Java Client
5-2
Examples of Developing SMI-S Client Using WBEM Solutions
5-4
Managed Object Format Files for Cisco DCNM SMI-S Server
6-1
6-1
6-1
CISCO_AdminDomainConformsToFabricProfile.mof
6-2
6-2
6-4
6-4
CISCO_ComputerSystemPackage.mof
6-5
CISCO_ComputerSystemRemoteService.mof
6-5
CISCO_ConnectivityCollection.mof
6-5
CISCO_ConnectivityCollectionInVsan.mof
6-6
CISCO_ConnectivityMemberOfCollection.mof
6-6
6-6
6-7
6-7
CISCO_DeviceSAPImplementation.mof
6-7
6-7
6-7
CISCO_ElementSoftwareIdentity.mof
6-7
CISCO_ElementStatisticalData.mof
6-8
6-8
CISCO_EndPortControlledByPortController.mof
6-9
CISCO_EndPortSAPImplementation.mof
6-9
CISCO_EndPortsInHostComputerSystem.mof
6-10
CISCO_EndPortsInStorageComputerSystem.mof
6-10
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2 78-xxxxx-xx
78-xxxxx-xx
Contents
6-10
6-11
CISCO_EthernetPortProtocolEndpoint.mof
6-11
CISCO_EthernetPortsInPhysicalComputerSystem.mof
6-11
CISCO_EthernetPortStatisticalData.mof
6-11
CISCO_EthernetPortStatistics.mof
6-12
6-14
6-15
CISCO_FabricServiceInAdminDomain.mof
6-15
6-15
6-16
CISCO_FCIPElementSettingData.mof
6-16
6-16
6-17
CISCO_FCIPProtocolEndpoint.mof
6-18
6-19
6-22
CISCO_FCLogicalSwitchCapabilities.mof
6-23
CISCO_FCLogicalSwitchSettings.mof
6-23
CISCO_FCNodeMemberOfCollection.mof
6-23
6-23
6-24
CISCO_FCPortElementCapabilities.mof
6-24
CISCO_FCPortProtocolEndPoint.mof
6-25
CISCO_FCPortSAPImplementation.mof
6-25
6-25
6-26
CISCO_FCPortsInLogicalComputerSystem.mof
6-26
CISCO_FCPortsInPhysicalComputerSystem.mof
6-26
CISCO_FCPortsInPortChannel.mof
6-27
CISCO_FCPortStatisticalData.mof
6-27
6-27
CISCO_FCSwitchCapabilities.mof
6-28
6-28
6-28
6-29
CISCO_HBASoftwareInstalledOnPlatform.mof
6-29
6-29
CISCO_HostComputerSystemsInAdminDomain.mof
6-29
6-30
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
3
Contents
4
6-30
6-30
6-30
CISCO_InstalledSoftwareIdentity.mof
6-30
CISCO_IPElementSettingData.mof
6-31
CISCO_IPEndPointStatisticalData.mof
6-31
CISCO_IPEndPointStatistics.mof
6-31
6-32
6-33
6-34
6-34
6-35
6-35
6-36
CISCO_LogicalComputerSystem.mof
6-36
CISCO_LogicalComputerSystemsInAdminDomain.mof
6-36
6-36
CISCO_LogicalFCPortForFCPort.mof
6-37
CISCO_LogicalForPhysicalComputerSystem.mof
6-38
6-38
CISCO_LogicalModulesInPhysicalComputerSystem.mof
6-38
6-38
CISCO_LogicalPortGroupInHostComputerSystem.mof
6-39
CISCO_LogicalSwitchConformsToSwitchProfile.mof
6-39
CISCO_LogicalSwitchElementCapabilities.mof
6-39
CISCO_LogicalSwitchInstalledSoftwareIdentity.mof
6-40
CISCO_LogicalSwitchSettingData.mof
6-40
CISCO_LogicalSwitchSoftwareIdentity.mof
6-40
6-40
CISCO_LogicalPortGroupInStorageComputerSystem.mof
6-41
6-41
6-42
6-43
6-43
6-44
6-44
6-44
CISCO_NameServerDatabaseChanged.mof
6-44
CISCO_PhysicalComputerSystem.mof
6-45
CISCO_PhysicalComputerSystemsInAdminDomain.mof
6-45
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
78-xxxxx-xx
Contents
6-45
CISCO_PhysicalElementEthernetPortRealizes.mof
6-45
CISCO_PhysicalElementFcPortRealizes.mof
6-46
6-46
6-47
CISCO_PhysicalPackageLogicalModuleRealizes.mof
6-47
6-47
CISCO_PlatformHostedSANAccessPoint.mof
6-49
6-49
6-50
6-50
CISCO_PortChannelsInSwitch.mof
6-51
6-51
CISCO_PortControllerInFabric.mof
6-52
CISCO_PortControllerInPlatform.mof
6-52
CISCO_PortControllerRealizes.mof
6-53
CISCO_PortControllerSoftwareIdentity.mof
6-53
6-54
6-54
6-54
CISCO_ProductPhysicalComponent.mof
6-54
6-55
CISCO_ProductSoftwareComponent.mof
6-55
6-55
CISCO_ProtocolEndPointHostComputerSystem.mof
6-55
CISCO_ProtocolEndPointLogicalComputerSystem.mof
6-56
CISCO_ProtocolEndPointStorageComputerSystem.mof
6-56
6-56
6-57
6-57
CISCO_RegisteredProfileInstances.mof
6-57
CISCO_RegisteredSubProfile.mof
6-63
6-63
CISCO_RemoteIPServiceAccessPoint.mof
6-63
CISCO_RemoteServiceAccessPoint.mof
6-63
6-64
6-64
6-64
6-64
CISCO_SAPAvailableForElement.mof
6-65
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5
Contents
6
6-65
6-65
6-66
6-66
CISCO_StatisticsCollection.mof
6-66
CISCO_StatisticsHostedCollection.mof
6-66
CISCO_StatisticsHostedCollectionInComputerSystem.mof
6-66
CISCO_StatisticsMemberOfCollection.mof
6-67
CISCO_StorageComputerSystem.mof
6-67
CISCO_StorageComputerSystemsInAdminDomain.mof
6-67
CISCO_SubProfileRequiresProfile.mof
6-68
CISCO_SubProfileSoftwareIdentity.mof
6-68
6-69
CISCO_SwitchConformsToFabricProfile.mof
6-69
CISCO_SwitchConformsToSwitchProfile.mof
6-69
CISCO_SwitchElementCapabilities.mof
6-70
CISCO_SwitchHostedFCIPAccessPoint.mof
6-70
CISCO_SwitchHostedIPAccessPoint.mof
6-70
CISCO_SwitchHostedTCPAccessPoint.mof
6-71
CISCO_SwitchInstalledSoftwareIdentity.mof
6-71
6-72
6-72
6-72
CISCO_SwitchSoftwareIdentity.mof
6-73
6-73
CISCO_TCPElementSettingData.mof
6-73
CISCO_TCPEndPointStatisticalData.mof
6-73
CISCO_TCPEndPointStatistics.mof
6-74
6-75
6-76
6-77
6-78
6-78
6-78
CISCO_UserModifiedOnSwitch.mof
6-79
6-79
6-79
6-79
CISCO_VsanComputerSystemComponent.mof
6-79
CISCO_VsanConformsToFabricProfile.mof
6-80
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Contents
78-xxxxx-xx
CISCO_VsanZoneCapabilities.mof
6-80
6-81
6-81
6-81
6-81
6-81
CISCO_ZoneAliasSettingData.mof
6-82
6-82
CISCO_ZoneCapInAdminDomain.mof
6-82
CISCO_ZoneHostedCollection.mof
6-83
CISCO_ZoneInLogicalComputerSystem.mof
6-83
CISCO_ZoneInPhysicalComputerSystem.mof
6-83
6-84
CISCO_ZoneMemberOfCollection.mof
6-84
CISCO_ZoneMemberSettingData.mof
6-84
6-85
CISCO_ZoneServiceInAdminDomain.mof
6-85
6-86
6-86
6-86
CISCO_ZoneSetInAdminDomain.mof
6-86
CISCO_ZoneSetInLogicalComputerSystem.mof
6-87
CISCO_ZoneSetInPhysicalComputerSystem.mof
6-87
6-87
6-88
6-88
Introduction to Cisco DCNM for SAN Web Services
7-1
DCNM for SAN Web Services API
8-1
8-1
8-1
8-2
8-2
8-2
8-2
requestToken
8-2
8-3
8-3
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
7
Contents
8
8-3
validateToken
8-4
8-4
8-4
8-4
8-5
8-5
8-5
8-5
8-6
8-6
8-6
8-7
8-7
8-7
8-8
8-8
8-8
8-8
8-9
8-9
8-9
8-10
8-10
8-10
8-11
8-11
8-11
8-12
8-12
8-12
8-13
8-13
8-13
8-14
8-14
8-14
8-14
8-15
8-15
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
78-xxxxx-xx
Contents
8-15
8-16
8-16
8-16
8-17
8-17
8-17
8-18
8-18
8-18
8-18
8-19
8-19
8-19
8-20
8-20
8-20
8-21
8-21
8-21
8-21
8-22
8-22
8-22
8-23
8-23
8-23
8-23
8-24
8-24
8-24
8-24
8-25
8-25
8-25
8-26
8-26
8-26
8-27
8-27
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
9
Contents
10
8-27
8-28
8-28
8-28
8-29
8-29
8-29
8-29
8-30
8-30
8-30
8-31
8-31
8-31
8-32
8-32
8-32
8-32
8-33
8-33
8-33
8-33
8-34
8-34
8-34
8-35
8-35
8-35
getIPEndPointStatisticsBySwitch
8-35
8-36
getTCPEndPointStatisticsBySwitch
8-36
8-36
8-36
8-37
8-37
8-37
8-37
8-38
8-38
8-38
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
78-xxxxx-xx
Contents
8-38
8-39
8-39
8-39
8-39
8-40
8-40
8-40
8-41
8-41
8-41
8-41
8-42
8-42
8-42
8-42
8-43
8-43
8-43
8-44
8-44
8-44
8-44
8-44
8-45
8-45
8-45
8-46
8-46
8-46
8-46
8-47
8-47
8-47
8-48
8-48
8-48
8-48
8-49
8-49
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
11
Contents
8-49
8-49
8-50
8-50
8-50
8-50
8-51
8-51
8-51
8-51
8-52
8-52
8-52
8-52
8-53
8-53
8-53
getPowerSuppliesBySwitchWwnKey
8-53
8-54
8-54
8-54
8-54
8-55
8-55
8-55
8-55
8-56
8-56
8-56
8-57
8-57
8-57
8-57
8-58
8-58
8-59
Discovery Automation Tool
9-1
Installing Discovery Automation
9-1
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
12 78-xxxxx-xx
Using the Discovery Automation Tool
9-1
B-17
B-17
B-18
B-18
B-18
B-19
Installing Command Line Storage Dumps Tool
C-31
C-31
C-31
Using Command Line Storage Dumps Tool
C-32
C-32
C-32
Contents
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
13
Contents
14
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
New and Changed Information
summarizes the new and changed features for the SMI-S and Web Services Programming Guide,
Cisco DCNM for SAN, Release 10.1(x) and indicates where they are documented. The table includes a brief description of each new feature and the release in which the change occurred.
Table 1 New and Changed Features
Feature
Command Line
Storage Dumps
Tool
Sample SMI-S
Java Client
SMI-S
Notifications
Discovery
Automation Tool
All
Description
Added information on getting dumps of storage arrays using command line.
Changed in Release Where Documented
7.1(1)
Added information on the SMI-S java client and their services.
Added information on the SMI-S notifications.
6.1(1)
6.1(1)
Added information on how to discover
DCNM-SAN, DCNM-LAN, and vCenter using the tool.
The Cisco MDS 9000 Family SMI-S
Programming Reference and the Cisco
Fabric Manager Web Services
Programming Guide were combined to create this new guide.
6.1.(1)
5.2(1)
SMI-S and Web Services
Programming guide, Cisco
DCNM for SAN
For a complete list of Cisco DCNM documentation, see the “Related Documentation” in the Preface.
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
15
New and Changed Information
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
16
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Preface
This preface describes the audience, organization, and conventions of the SMI-S and Web Services
Programming Guide, Cisco DCNM for SAN, Release 10.1(x) . It also provides information on how to obtain related documentation.
Audience
This guide is for users who are familiar with general object-oriented programming techniques and with the following items:
• Storage Management Initiative Specification (SMI-S)
•
•
•
•
Common Information Model (CIM)
Managed Object Format (MOF) files
Unified Modeling Language (UML)
Secure Socket Layer (SSL), if increased security is desired when accessing the CIM server
Organization
This guide is organized as follows:
Chapter
Chapter 1
Chapter 2
Chapter 3
Chapter 4
Chapter 5
Chapter 6
Title
Description
Provides an overview of the support provided for CIM and other standards.
Provides CLI commands to configure the CIM server, and sample scenarios for using CIM to manage your SAN.
Describes the supported profiles, indications, and
Cisco-specific extensions.
Describes the SMI-S notifications.
Provides the sample SMI-S java client and services.
Provides the text from the MOF files for the Cisco MDS 9000
Family CIM server extensions.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx 17
Preface
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Chapter
Chapter 7
Title
Description
Provides application programming interfaces (APIs) that expose DCNM-SAN core software functionalities as remote procedure calls to third-party vendors.
Chapter 8
Chapter 9
Describes the Cisco DCNM for SAN (DCNM-SAN) Web
Services (FMWS) application program interface (API).
This is a tool to discover DCNM-SAN, DCNM-LAN, and vCenter.
Appendix A
Provides a sample client program using API.
Appendix B
Provides the Perl client installation information and some sample perl client programs.
Appendix C
Provides installing and usage information of the Command
Line Storage Dumps tool.
Document Conventions
Command descriptions use these conventions: boldface font italic font
[ ]
[ x | y | z ]
Commands and keywords are in boldface.
Arguments for which you supply values are in italics.
Elements in square brackets are optional.
Optional alternative keywords are grouped in brackets and separated by vertical bars.
Screen examples use these conventions: screen font boldface screen font italic screen font
< >
[ ]
!, #
Terminal sessions and information the switch displays are in screen font.
Information you must enter is in boldface screen font.
Arguments for which you supply values are in italic screen font.
Nonprinting characters, such as passwords, are in angle brackets.
Default responses to system prompts are in square brackets.
An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.
This document uses the following conventions:
Note Means reader take note . Notes contain helpful suggestions or references to material not covered in the manual.
Caution Means reader be careful . In this situation, you might do something that could result in equipment damage or loss of data.
18
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Preface
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Related Documentation
The documentation set for the Cisco MDS 9000 Family includes the following documents. To find a document online, use the Cisco MDS NX-OS Documentation Locator at: http://www.cisco.com/en/US/docs/storage/san_switches/mds9000/roadmaps/doclocater.htm
Release Notes
•
•
•
•
Cisco MDS 9000 Family Release Notes for Cisco MDS NX-OS Releases
Cisco MDS 9000 Family Release Notes for MDS SAN-OS Releases
Cisco MDS 9000 Family Release Notes for Cisco MDS 9000 EPLD Images
Cisco DCNM Release Notes
Regulatory Compliance and Safety Information
• Regulatory Compliance and Safety Information for the Cisco MDS 9000 Family
Compatibility Information
•
•
•
Cisco Data Center Interoperability Support Matrix
Cisco MDS 9000 NX-OS Hardware and Software Compatibility Information and Feature Lists
Cisco MDS 9000 Family Switch-to-Switch Interoperability Configuration Guide
Hardware Installation
•
•
•
•
Cisco MDS 9500 Series Hardware Installation Guide
Cisco MDS 9200 Series Hardware Installation Guide
Cisco MDS 9100 Series Hardware Installation Guide
Cisco MDS 9124 and Cisco MDS 9134 Multilayer Fabric Switch Quick Start Guide
Software Installation and Upgrade
• Cisco MDS 9000 NX-OS Software Upgrade and Downgrade Guide
Cisco NX-OS
•
•
•
•
Cisco MDS 9000 Family NX-OS Licensing Guide
Cisco MDS 9000 Family NX-OS Fundamentals Configuration Guide
Cisco MDS 9000 Family NX-OS System Management Configuration Guide
Cisco MDS 9000 Family NX-OS Interfaces Configuration Guide
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx 19
Preface
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
•
•
•
•
•
•
•
•
Cisco MDS 9000 Family NX-OS Fabric Configuration Guide
Cisco MDS 9000 Family NX-OS Quality of Service Configuration Guide
Cisco MDS 9000 Family NX-OS Security Configuration Guide
Cisco MDS 9000 Family NX-OS IP Services Configuration Guide
Cisco MDS 9000 Family NX-OS Intelligent Storage Services Configuration Guide
Cisco MDS 9000 Family NX-OS High Availability and Redundancy Configuration Guide
Cisco MDS 9000 Family NX-OS Inter-VSAN Routing Configuration Guide
Cisco MDS 9000 Family Cookbook for Cisco MDS SAN-OS
Cisco DCNM for SAN
•
•
•
•
•
•
•
•
•
•
System Management Configuration Guide, Cisco DCNM for SAN
Interfaces Configuration Guide, Cisco DCNM for SAN
Fabric Configuration Guide, Cisco DCNM for SAN
Quality of Service Configuration Guide, Cisco DCNM for SAN
Security Configuration Guide, Cisco DCNM for SAN
IP Services Configuration Guide, Cisco DCNM for SAN
Intelligent Storage Services Configuration Guide, Cisco DCNM for SAN
High Availability and Redundancy Configuration Guide, Cisco DCNM for SAN
Inter-VSAN Routing Configuration Guide, Cisco DCNM for SAN
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN
Cisco DCNM
The following publications support both Cisco DCNM for LAN and DCNM for SAN, and address the new licensing model, the new installation process, and the new features of Cisco DCNM:
•
•
Cisco DCNM Fundamentals Guide, Release 6.x
Cisco DCNM Installation Guide, Release 6.x
Command-Line Interface
• Cisco MDS 9000 Family Command Reference
Intelligent Storage Networking Services Configuration Guides
•
•
•
•
Cisco MDS 9000 Family I/O Acceleration Configuration Guide
Cisco MDS 9000 Family SANTap Deployment Guide
Cisco MDS 9000 Family Data Mobility Manager Configuration Guide
Cisco MDS 9000 Family Storage Media Encryption Configuration Guide
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
20 78-xxxxx-xx
Preface
Obtaining Documentation and Submitting a Service Request
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Troubleshooting and Reference
•
•
•
•
•
Cisco DCNM Troubleshooting Guide
Cisco MDS 9000 Family and Nexus 7000 Series System Messages Reference
Cisco MDS 9000 Family SAN-OS Troubleshooting Guide
Cisco MDS 9000 Family NX-OS MIB Quick Reference
Cisco DCNM for SAN Database Schema Reference
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation .
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What’s New in Cisco Product Documentation RSS feed . The RSS feeds are a free service.
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
21
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Preface
22
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
C H A P T E R
1
Introduction to Cisco DCNM for SAN SMI-S
Cisco Data Center Network Manager (DCNM) provides an industry standard application programming interface (API) using the Storage Management Initiative Specification (SMI-S). The SMI-S facilitates managing storage area networks (SANs) in a multivendor environment.
This chapter includes the following sections:
•
•
•
About the Common Information Model, page 1-1
Understanding CIM and Unified Modeling Language Notation, page 1-3
About SMI-S and CIM in Cisco DCNM for SAN, page 1-4
About the Common Information Model
The Common Information Model (CIM) is an object-oriented information model that describes management information in a network or enterprise environment. Because it is object-oriented, CIM provides abstraction, inheritance, and dependency or association relationships between objects within the model. CIM is based on XML and is platform-independent and technology neutral. The management application developer does not need any information about how CIM was implemented on a vendor product; only the API is required to interact with a vendor product.
Note CIM is not supported in Cisco MDS NX-OS Release 5.2(1), but is supported in Cisco DCNM Release
5.2(1).
Note Cisco DCNM SMI-S Server is installed as part of the Cisco DCNM-SAN installation.
CIM uses a client/server model. The Cisco DCNM SMI-S Server can be embedded into the vendor product or can be implemented by a proxy server that provides the Cisco DCNM SMI-S Server functionality for the legacy vendor product. The CIM client is the management application that communicates to multiple Cisco DCNM SMI-S Servers to manage the SAN. The CIM client discovers
Cisco DCNM SMI-S Servers through the Service Location Protocol, version 2 (SLPv2) as defined in
RFC 2608. SLPv2 uses UDP port 427 for communication and is a discovery protocol that is separate from the CIM client/server communication path.
CIM defines the communications between the client and server in terms of technologies defined in the
WEBM Initiative.
shows the full CIM client/server communications path.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
1-1
About the Common Information Model
Figure 1-1 CIM Client/Server Communications
CIM client xmICIM encoding
CIM operations over HTTP
HTTP
TCP/IP
CIM server
Chapter 1 Introduction to Cisco DCNM for SAN SMI-S
For more information about CIM, refer to the specification available through the Distributed
Management Task Force (DMTF) website at http://www.dmtf.org.
About the Storage Management Initiative Specification
The Storage Management Initiative Specification (SMI-S) uses an object-oriented model based on CIM to define a set of objects and services that can manage elements of a SAN. By using a standardized architecture, SMI-S helps management application developers create common and extensible applications that work across multiple SAN vendor products.
exemplifies SMI-S in a multivendor SAN.
Figure 1-2 SMI-S in a Multivendor SAN
CIM client application
SMI-S API using CIM/WBEM technologies
Disk array
CIM server
Fabric switch
CIM server
Tape drive
CIM server
Fabric switch
CIM server
1-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 1 Introduction to Cisco DCNM for SAN SMI-S
Understanding CIM and Unified Modeling Language Notation
SMI-S provides a set of standard management objects collected in a profile. Several profiles are defined in SMI-S that cover common SAN elements, including switches, fabrics, and zoning. These standardized profiles ensure interoperability across products within the SAN. SMI-S also defines an automated discovery process, using SLPv2. SMI-S uses CIM defined by the DMTF as part of the WBEM.
For more information about SMI-S, refer to the Storage Networking Industry Association (SNIA) website at http://www.snia.org
.
About the WBEM Initiative
The WBEM initiative is a set of management and Internet standards developed to unify the management of enterprise computing environments.
The WBEM initiative includes:
• CIM, which provides a common format, language, and methodology for collecting and describing management data.
• The CIM-XML Encoding Specification, a standards-based method for exchanging CIM information. CIM-XML uses an xmlCIM encoded payload and HTTP as the transport mechanism.
CIM-XML consists of the following specifications:
– xmlCIM encoding, a standard way to represent CIM information in XML format.
– CIM operations over HTTP, a transportation method that describes how to pass xmlCIM encoded messages over HTTP.
For more information about the WBEM initiative, refer to the DMTF website at http://www.dmtf.org.
Understanding CIM and Unified Modeling Language Notation
SMI-S relies on object-oriented classes as defined in CIM. These classes are frequently defined using
Unified Modeling Language (UML). To understand the SMI-S and the Cisco extensions present in this document, you must have a basic understanding of CIM classes and UML.
Understanding CIM Classes
A class is a collection of properties and methods that define a type of object. As an example, a generic network device is a type of object. We can define the NetworkDevice class to describe this object. The
NetworkDevice class contains properties or attributes of a network device. Some properties for this
NetworkDevice class are IpAddress and DeviceType . The NetworkDevice class controls the network device. Methods and routines trigger actions on the network device. Example of methods are enablePort() and rebootDevice().
After defining a
NetworkDevice
class, we can define a class for just switches. Because a switch is a special type of
NetworkDevice
, we use the object-oriented concept of inheritance to define the
Switch class. We define the
Switch class as a child of the
NetworkDevice
class. This means the
Switch
class automatically has the properties and methods of its parent class. From there, we add properties and methods that are unique to a switch.
CIM defines a special type of class called an association class . An association class represents relationships between two or more classes. As an example, we define an association class to show the relationship between a
NetworkDevice
class and an
OperatingSystem
class. If there is a many-to-one or many-to-many relationship, the association class is considered an aggregation .
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
1-3
Chapter 1 Introduction to Cisco DCNM for SAN SMI-S
About SMI-S and CIM in Cisco DCNM for SAN
Refer to http://www.dmtf.org for a full explanation of CIM.
Understanding UML
UML provides a visual representation of the classes that describe a product or technology. UML contains many visual elements, but only a subset are described here. Refer to http://www.uml.org for a full explanation of UML.
shows an example section from a UML diagram for CIM classes. This diagram shows:
•
•
• blue lines for inheritance between classes green lines for aggregation between classes red lines for associations between classes
Figure 1-3 UML Example Diagram
ManagedElement
Description: string
Caption: string
Inheritance
Dependency
Association
ManagedSystemElement
Name: string
Description: string
Caption: string
Status: string
InstallDate: datetime
Component
Aggregation
(a type of association)
Methods
About SMI-S and CIM in Cisco DCNM for SAN
SMI-S defines a number of profiles that specify the managed objects used to control and monitor elements of a SAN. Each switch or director in Cisco DCNM for SAN includes an embedded Cisco
DCNM SMI-S Server. The Cisco DCNM SMI-S Server communicates with any CIM client to provide
SAN management compatible with SMI-S. The Cisco DCNM SMI-S Server includes the following standard profiles, subprofiles, and features as defined in SMI-S:
•
•
•
•
Service Location Protocol version 2 (SLPv2)
Server profile
CIM indications
Fabric profile
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
1-4
Chapter 1 Introduction to Cisco DCNM for SAN SMI-S
About SMI-S and CIM in Cisco DCNM for SAN
•
•
•
–
–
–
Zoning Control subprofile
Enhanced Zoning and Enhanced Zoning Control subprofile
FDMI subprofile
Switch profile, including the Blade subprofile and Access Point subprofile xmlCIM encoding and CIM operations over HTTP as specified by the WBEM initiative
HTTPS, which uses Secure Socket Layer (SSL)
HTTPS is optional but provides enhanced security by encrypting communications between the
Cisco DCNM SMI-S Server and the CIM client.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
1-5
About SMI-S and CIM in Cisco DCNM for SAN
Chapter 1 Introduction to Cisco DCNM for SAN SMI-S
1-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
2
Cisco DCNM SMI-S Server Support
This chapter describes the standard profiles supported by Cisco DCNM SMI-S. The Cisco DCNM SMI-S
Server also supports extensions to these profiles to support features in Cisco MDS NX-OS that are not available from the standard profiles.
This chapter includes the following sections:
•
•
•
•
•
Managing SANs Through SMI-S, page 2-1
Service Location Protocol, page 2-2
Managing SANs Through SMI-S
SANs are created in a multivendor environment. Hosts, fabric elements (switches, directors), and data storage devices are integrated from different vendors to create an interoperable storage network.
Managing these elements from different vendors is problematic to the network administrator. Each element has its own management interface that may be proprietary. A network administrator must work with these disparate management APIs to build a cohesive management application that controls and monitors the SAN.
The SMI-S addresses this management problem by creating a suite of flexible, open management API standards based on the vendor- and technology-independent CIM. Using the SMI-S APIs, collected in profiles of common management classes, a network administrator can create a simplified management application CIM client to control and monitor the disparate SAN elements that support SMI-S and CIM.
With Cisco DCNM SMI-S Servers either embedded on the SAN elements or supported by a proxy Cisco
DCNM SMI-S Server, these elements are accessible to the network administrator’s CIM client application.
SMI-S uses the Service Location Protocol version 2 (SLPv2) to discover Cisco DCNM SMI-S Servers. Once the Cisco DCNM SMI-S Servers are identified, the CIM client determines which profiles are supported on
Cisco DCNM SMI-S Servers through the Server profile. This profile is mandatory on all Cisco DCNM SMI-S
Servers.
Besides the control and monitoring support provided by profiles, the Cisco DCNM SMI-S Server also supports asynchronous delivery of events through CIM indications . Indications provide immediate notification of important occurrences such as when an interface goes down.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-1
Chapter 2 Cisco DCNM SMI-S Server Support
Service Location Protocol
Service Location Protocol
The first step in managing a network of SAN elements with Cisco DCNM SMI-S Server is discovering the location and support available on Cisco DCNM SMI-S Servers. The SLPv2 provides this discovery mechanism. A CIM client uses SLPv2 to discover Cisco DCNM SMI-S Servers, gathering generic information about what services Cisco DCNM SMI-S Servers provides and the URL where these services are located.
Cisco DCNM SMI-S Server supports SLPv2 as defined in RFC 2608.
Server Profile
Once the CIM client discovers the Cisco DCNM SMI-S Servers within the SAN, the CIM client must determine the level of support each Cisco DCNM SMI-S Server provides. The Server profile defines the capabilities of the Cisco DCNM SMI-S Server. This includes providing the namespace and all profiles and subprofiles supported by Cisco DCNM SMI-S Server.
For each supported profile, the Server profile instantiates the RegisteredProfile class. Each instance of this class gives the CIM client the profile name and unique ID that is supported by Cisco DCNM
SMI-S Server. Similarly, Cisco DCNM SMI-S Server lists all supported optional subprofiles, using the
RegisteredSubProfile class and the SubprofileRequiresProfile association class to associate the subprofile with the profile.
2-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Switch Profile
The Switch profile models the logical and physical aspects of switches. The Computer System class constitutes the center of the switch model. The switch includes discovery components including ports, port statistics, product information, software, and chassis information. It also includes configuration of the switch including switch and port state change, port speed, switch name, symbolic names, and
DomainID.
shows the switch profile from a communication perspective.
The Switch profile also supports the optional Blade subprofile (see the
“Blade Subprofile” section on page 2-8
) and the optional Access Point Subprofile (see the “Access Point Subprofile” section on page 2-10
).
shows the switch profile from a communication perspective and switch access point subprofile.
Figure 2-1 Switch Profile in Communication Perspective
CISCO_RemoteFCIPPort : CIM_RemotePort
DeviceID:StringSystemCreationClassName:
StringCreationClassName:
StringSystemName: String
CISCO_SANFCIPEndpoint :
CIM_BindsTo
CISCO_FCPort : CIM_FCPort
DeviceID:StringSystemCreationClassName:
StringCreationClassName:
StringSystemName:
String
CISCO_FCIPProtocolEndpoint :
CIM_ProtocolEndpoint
CISCO_FCPortProtocolEndPoint :
CIM_SettingData(abstract class)
CISCO_FCIPPEBasedOn:
CISCO_Component
CISCO_FCIPProfile : CIM_Profile
CreationClassName: stringName:
StringSystemCreationClassName:
StringSystemName:String
InstanceID :string=entityid_wwn
CIM_StatisticalData(abstract class)
CISCO_FCIPElementSettingData :
CISCO_ElementSettingData
CISCO_FCIPSettings :
CIM_SettingData
InstanceID :string=wwn_ifindex
CISCO_SwitchHostedFCIPAccessPoint:
CIM_HostedAccessPoint
CISCO_FCIPTCPEndpoint :
CIM_BindsToCreationClassName:
CISCO_LogicalComputerSystem :
CISCO_ComputerSystem
CISCO_IPSettings :
CIM_IPSettings
CreationClassName:
StringName:String
CISCO_SwitchHostedTCPAccessPoint:
CIM_HostedAccessPoint
CISCO_TCPProtocolEndPoint:
CIM_TCPProtocolEndPoint
CreationClassName:stringName:
StringSystemCreationClassName:String
CISCO_TCPElementSettingData :
CIM_ElementSettingData
CISCO_TCPSettings :
CIM_TCPSettings
InstanceID :string=wwn_ifindex
InstanceID :string= wwn_ifindex
CISCO_RemoteTCPPort :
CIM_RemotePort
DeviceID:StringSystem
CreationClassName: String
SystemName: String.
CISCO_SwitchHostedIPAccessPoint:
CIM_HostedAccessPoint
CISCO_RemoteIPServiceAccessPoint:
CIM_RemoteServiceAccessPoint
CreationClassName:stringName:
StringSystemCreationClassName:
StringSystemName:String
CISCO_TCPEndPointStatistics:
CISCO_TCPEndPointStatisticalData
CISCO_SANTCPEndpoint :
CIM_BindsTo
CISCO_TCPIPEndpoint :
CIM_BindsTo
CISCO_IPProtocolEndpoint:
CIM_IPProtocolEndPoint
CISCO_IPElementSettingData :
CIM_ElementSettingData
CISCO_SANIPEndpoint :
CIM_BindsTo
CreationClassName: stringName:
StringSystemCreationClassName:
StringSystemName:String
CISCO_IPEthernetEndpoint :
CIM_BindsTo
CISCO_IPEndPointStatisticalData :
CIM_ElementStatisticalData
CISCO_TCPEndPointStatistics:
CISCO_TCPEndPointStatistics
CISCO_IPEndPointStatistics :
CIM_IPEndpointStatistics
InstanceID :string=wwn_ifindex
CISCO_PhysicalComputerSystem:
CISCO_ComputerSystem
CIM_RemoteService
AccessPoint (abstract class)
CISCO_RemoteServiceAccessPoint :
CIM_RemoteServiceAccessPoint
CreationClassName:stringName:
StringSystemCreationClassName:
StringSystemName:String
CreationClassName:StringName:
String
CISCO_SAPAvailableForElement :
CIM_SAPAvailableForElement
CISCO_ComputerSystemRemoteService :
CISCO_HostedAccessPoint
CISCO_LANEndpoint :
CIM_ProtocolEndpoint
CreationClassName: stringName: StringSystemCreationClassName:
String
CISCO_EthernetPortProtocolEndpoint :
CIM_DeviceSAPImplementation
CISCO_EthernetPort : CIM_EthernetPort
CreationClassName:stringName:
StringSystemCreationClassName:
StringSystemName:
String
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-3
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Figure 2-2 Switch Profile in Configuration Perspective and Switch Access Point Subprofile
CISCO_Product : CIM_Product
CISCO_FCPortCapabilities :
CIM_FCPortCapabilities
CISCO_FCPortElementCapabilities :
CISCO_ElementCapabilities
IdentifyingNumber:
StringName:String
Vendor:String
Version:String
InstanceID :string=wwn_ifindex
CISCO_ProductPhysicalComponent :
CIM_ProductPhysicalComponent
CISCO_PhysicalPackage :
CIM_PhysicalPackage
CISCO_FCPortSettings
InstanceID :string=w wn_ifindex
Setportspeed setporttype
CISCO_FCPortSettingData :
CISCO_ElementSettingData
CreationClassName:
StringTag:String
CISCO_FCSwitchSettings
CISCO_ComputerSystemPackage :
CIM_ComputerSystemPackage
InstanceID :string=wwn
CISCO_SwitchSettingData:
CIM_ElementSettingData
CISCO_PhysicalComputerSystem:
CISCO_ComputerSystem
CreationClassName:String
Name :String
CISCO_SwitchElementCapabilities :
CIM_ElementCapabilities
Set switch name
CISCO_FCSwitchCapabilities
CISCO_FCPortStatistics
InstanceID :string=wwn_ifindex
CISCO_FCPortsInPhysical
ComputerSystem:
CISCO_SystemDevice
CISCO_FCPortStatisticalData:
CISCO_ElementStatisticalData
CISCO_FCPort : CIM_FCPort
DeviceID:String
CreationClassName:String
SystemCreationClassName:String
SystemName:String
Set _portname
Enableport disableport
InstanceID :string=wwn-
CISCO_StatisticsHostedCollection :
CISCO_HostedCollection
CISCO_StatisticsMemberOfCollection :
CIM_MemberOfCollection
CISCO_StatisticsCollection :
CIM_StatisticsCollection
InstanceID : string=fabricid+name
CISCO_SwitchInstalledSoftwareIdentity:
CIM_InstalledSoftwareIdentity
CISCO_EthernetPortsInPhysical
ComputerSystem
CISCO_FCPortsInPortChannel :
CIM_MemberOfCollection
CISCO_SwitchSoftwareIdentity:
CIM_SoftwareIdentity
InstanceID :string = wwn
CISCO_EthernetPort
DeviceID:StringSystemCreation
ClassName: StringCreationClassName:
StringSystemName: String
CISCO_PortChannel :
CIM_RedundancySet
InstanceID : string=wwn_ifindex
CISCO_EthernetPortStatisticalData
CISCO_EthernetPortStatistics :
CIM_EthernetPortStatistics
InstanceID : string=wwn_ifindex
CISCO_PortChannelsInSwitch : CIM_HostedCollection
Table 2-1 shows how to use the classes and association classes of Switch profile.
Table 2-1 CIM Elements for Switch Profile
Class How Used
CISCO_PhysicalComputerSystem:CISCO_ComputerSystem Identifies the switch, with the Dedicated property set to
Switch.
CISCO_ComputerSystemPackage:CIM_ComputerSystemPac kage
Associates
PhysicalPackage
to the
ComputerSystem
(Switch).
CISCO_SwitchElementCapabilities:CIM_ElementCapabilitie s
Associates
FCSwitchCapabilities
to the
ComputerSystem
(Switch).
2-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Table 2-1 CIM Elements for Switch Profile (continued)
Class
CISCO_SwitchInstalledSoftwareIdentity:CIM_InstalledSoftw areIdentity
CISCO_SwitchSettingData: CIM_ElementSettingData
CISCO_FCPortSettingData: CISCO_ElementSettingData
CISCO_FCPortElementCapabilities:CISCO_ElementCapabili ties
CISCO_FCPortStatisticalData:CISCO_ElementStatisticalDat a
CISCO_StatisticsMemberOfCollection:CIM_MemberOfColle ction
How Used
Associates the switch and its software identity.
Associates
FCSwitchSettings
to
ComputerSystem
.
Associates
FCPortSettings
to
FCPort
.
Associates the
CISCO_FCPort
and
CISCO_FCPortCapabilities
.
Associates the
FCPortStatistics
to the
FCPort
.
Associates the
NetworkPortStatistics
(fcportstatistics) to the
StatisticsCollection
.
CISCO_TCPProtocolEndPoint:CIM_TCPProtocolEndPoint
CISCO_FCIPTCPEndpoint:CIM_BindsTo
CISCO_FCIPProtocolEndpoint :CIM_ProtocolEndpoint
CISCO_FCIPElementSettingData:CISCO_ElementSettingDat a
CISCO_FCPortProtocolEndPoint:CIM_DeviceSAPImplemen tation
A protocol endpoint that is dedicated to running TCP.
Associates the
CISCO_FCIPProtocolEndpoint
and
CISCO_TCPProtocolEndPoint
.
CISCO_SANTCPEndpoint:CIM_BindsTo Associates the
CISCO_IPProtocolEndpoint
and
CISCO_TCPProtocolEndPoint
.
CISCO_TCPElementSettingData:CIM_ElementSettingData Associates the CISCO_IPProtocolEndpoint and
CISCO_IPSettings .
CISCO_FCIPPEBasedOn:CISCO_Component Associates the membership relationships between a fcipprofile and the fcip protocol endpoints within that switch.
A protocol endpoint that is dedicated to running fcipport.
Associates the
CISCO_FCIPProtocolEndpoint
and
CISCO_FCIPSettings
.
Associates the CISCO_FcPort with CISCO_LANEndpoint .
CISCO_EthernetPortProtocolEndpoint:CIM_DeviceSAPImpl ementation
CISCO_PortChannel:CIM_RedundancySet
Associates
CISCO_EthernetPort
with
CISCO_LANEndpoint
.
Displays port aggregation for Fibre Channel trunking.
CISCO_PortChannelsInSwitch :CIM_HostedCollection Aggregates the PortChannels in switch.
CISCO_FCPortsInPortChannel :CIM_MemberOfCollection Aggregates the fcports
for port channeling (Trunking).
CISCO_IPProtocolEndpoint: CIM_IPProtocolEndPoint A protocol end point that is dedicated to running IP.
CISCO_LANEndpoint:CIM_ProtocolEndpoint
CISCO_EthernetPortProtocolEndpoint:CIM_DeviceSAPImpl ementation
A communication endpoint which, when its associated interface device is connected to a LAN, may send and receive data frames. LAN Endpoints include Ethernet,
Token Ring and FDDI interfaces.
Associates a
CISCO_EthernetPort
with
CISCO_LANEndpoint
.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-5
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Table 2-1 CIM Elements for Switch Profile (continued)
Class
CISCO_SANFCIPEndpoint:CIM_BindsTo
CISCO_SANIPEndpoint : CIM_BindsTo
CISCO_IPEthernetEndpoint:CIM_BindsTo
CISCO_TCPIPEndpoint:CIM_BindsTo
CISCO_IPElementSettingData:CIM_ElementSettingData
CISCO_Product:CIM_Product
How Used
Associates between
CISCO_FCIPProtocolEndpoint
and
CISCO_ProtocolEndPoint
.
Associates between
CISCO_IPProtocolEndpoint
and
CISCO_RemoteFCIPServiceAccessPoint
.
Associates between
CISCO_IPProtocollEndpoint
and
CISCO_LANEndPoint
.
Associates between CISCO_IPProtocolEndpoint and
CISCO_TCPProtocolEndPoint .
Associates between
CISCO_IPProtocolEndpoint
and
CISCO_IPSettings
.
CISCO_Product
is a concrete class that aggregates
PhysicalElements, software (SoftwareIdentity and
SoftwareFeatures), services and/or other products, and is acquired as a unit.
Identifies Fibre Channel switch port.
CISCO_FCPort:CIM_FCPort
CISCO_logicalfcport:CIM_FCPort
CISCO_FCSwitchSettings:CIM_FCSwitchSettings
CISCO_FCSwitchCapabilities:CIM_FCSwitchCapabilities
CISCO_FCPortSettings:CIM_FCPortSettings
CISCO_FCPortCapabilities:CIM_FCPortCapabilities
CISCO_EthernetPort:CIM_EthernetPort
Identifies logical aspects of the port link and the data layers.
Identifies Fibre Channel switch settings.
Identifies Fibre Channel switch capabilities.
Identifies Fibre Channel port settings.
Defines configuration options supported by the ports.
Identifies Ethernet port.
CISCO_EthernetPortStatistics:CIM_EthernetPortStatistics
CISCO_FCPortStatistics:CIM_FCPortStatistics
CISCO_EthernetPortsInPhysicalComputerSystem:CISCO_Sy stemDevice
CISCO_FCPortsInLogicalComputerSystem:CISCO_SystemD evice
Identifies Ethernet port statistics.
Identifies Fibre Channel port statistics.
CISCO_StatisticsCollection :CIM_StatisticsCollection Collection to aggregate Fibre Channel port statistics to
Fibre Channel switch.
Associates switch and its software identity.
CISCO_SwitchSoftwareIdentity:CIM_SoftwareIdentity
CISCO_StatisticsHostedCollection:CISCO_HostedCollection Associates the statistics collection to the computersystem representing the switch.
CISCO_EndPortsInHostComputerSystem:CISCO_SystemDe vice
Identifies end ports in host device.
Identifies Ethernet port in switch.
Identifies logical Fibre Channel ports in logical computer system in VSAN.
Aggregates the statistics data for TCP end point.
CISCO_TCPEndPointStatisticalData:
CIM_ElementStatisticalData
CISCO_IPEndPointStatisticalData:
CIM_ElementStatisticalData
Aggregates the statistics data for IP end point.
CISCO_EthernetPortStatisticalData:
CISCO_ElementStatisticalData
Aggregates the statistics data for Ethernet end point.
2-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Table 2-1 CIM Elements for Switch Profile (continued)
Class
CISCO_TCPSettings:CIM_TCPSettings Defines TCP transport layer global settings.
CISCO_TCPEndPointStatistics:CIM_TCPEndpointStatistics Defines the statistics for the TCP end point.
CISCO_IPSettings:CIM_IPSettings
How Used
CISCO_IPEndPointStatistics:CIM_IPEndpointStatistics
Defines the operational settings for an IP implementation that are configured on a system-wide basis.
Records the statistics for an CIM_IPProtocolEndpoint.
shows the services supported by the switch profile.
Table 2-2
Device Name
Enable Fcport
Disable fcport
Setportspeed
Setporttype
Setswitchname
Setportname
Switch Profile Services
Description
Describes how to enable a port on a Fibre Channel switch.
Describes how to disable a port on a Fibre Channel switch.
Describes how to modify the speed of a port on a Fibre Channel switch.
Describes how to modify the port type on a Fibre Channel switch.
Describes how to modify the name of a Fibre Channel switch.
Describes how to modify the name of a port on a Fibre Channel switch.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-7
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Blade Subprofile
This subprofile describes how blades in a director class switch can be discovered and managed.
The CIM client uses the optional Blade subprofile to model the physical and logical aspects of a supervisor module, switching module, or services module in a switch. Combining the Blade subprofile with the Switch profile, the CIM client gains a chassis-level view into the switch, associating ports to modules and modules to a switch.
shows the switch blade subprofile.
Figure 2-3 Switch Blade Subprofile
CISCO_FabricServiceInVsan
CISCO_PortControllerInFabric
CISCO_FabricService:CIM_Service
CreationClass name:String
Name:String
SystemCreationClassName:String
SystemName:String
ZoneSetDistribute
CISCO_PortController:CIM_PortController
CreationClassName:String
DeviceID:String
SystemCreationClassName:String
CISCO_ConnectivityCollectionInVsan
CISCO_ConnectivityCollection:CIM_
ConnectivityCollection
InstanceID:String= VsanID_PWwn
CISCO_VsanZoneCapabilities
CISCO_ZoneCapabilities:
CIM_ZoneCapabilities
For Vsan:
InstanceID:String= VsanID_PWwn
For AdminDomain:
InstanceID:String= FabricSeedSwWwn
CISCO_AdminDomain:CIM_AdminDomain
CreationClassName:String
Name:String
CISCO_ContainedDomain
CISCO_Vsan:CIM_AdminDomain
CreationClassName:String
Name:String
CISCO_LogicalComputerSystem:CISCO_
ComputerSystem
CISCO_VsanComputerSystemComponent
CreationClassName:StringName:String
CISCO_ZoneAliasInVsan
CISCO_ZoneAlias:CIM_
NamedAddressCollection
InstanceID :String =VsanID_PWwn _ swwn_ AliasName
CISCO_ZoneInVsan
CISCO_ZoneServiceInVsan
CISCO_Zone:CIM_Zone
For Active Zone:
InstanceID : String = VsanID_PWwn_Zone name_
ActiveStatus
For Inactive Zone :
InstanceID : String = VsanID_PWwn_Zone name_
ActiveStatus_Wwn
CISCO_ZoneService:CIM_ZoneService
CreationClassName:String
Name: String SystemCreationClassName:String
SystemName:String
CreateZoneAlias, AddZoneAlias, CreateZoneSet,
CreateZone CreateZoneMembershipSettingData
2-8
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
shows how to use the classes and association classes of Blade subprofile.
Table 2-3 CIM Elements for Blade Subprofile
Class
CISCO_LogicalModule:C
IM_LogicalModule
CISCO_ModuleFcPort:
CISCO_ModulePort
CISCO_ModuleEthernet
Port:CISCO_ModulePort
CISCO_ProductPhysical
Component:CIM_Produc tPhysicalComponent
CISCO_LogicalModules
InPhysicalComputerSyst em:CISCO_SystemDevi ce
CISCO_PhysicalPackage
LogicalModuleRealizes
:CISCO_Realizes
CISCO_PhysicalPackage
:CIM_PhysicalPackage
CISCO_LogicalModules
InPhysicalComputerSyst em:CISCO_SystemDevi ce
CISCO_EthernetPortsIn
PhysicalComputerSyste m:CISCO_SystemDevic e
How Used
Identifies a blade, supervisor module, switching module, or services module as an aggregation point for the switch ports.
Associates the logical module to the Fibre Channel port.
Associates the logical module to the Ethernet port.
Associates the physical element with product.
Associates
Associates
CISCO_PhysicalComputerSystem
CISCO_PhysicalPackage
Associates the physical package within which the logical module is stored as rack.
Associates the logical module to the switch.
Associates Ethernet ports in
and
and blade
PhysicalComputerSystem
.
.
CISCO_LogicalModule
CISCO_FCPortsInPhysic alComputerSystem:CISC
O_SystemDevice
Associates fcports
in
PhysicalComputerSystem
.
Associates
Ethernetports
in
PhysicalElement
.
CISCO_PhysicalElement
EthernetPortRealizes
:CISCO_Realizes
CISCO_PhysicalElement
FcPortRealizes:CISCO_
Realizes
Associates
Fcports
in
PhysicalElement.
.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-9
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Access Point Subprofile
The CIM client uses the Access Point subprofile to return the URL to access the switch and install or launch Cisco DCNM-SAN or Device Manager. If Cisco DCNM-SAN or Device Manager have not been installed, then the URL gives the option to install them. If Cisco DCNM-SAN or Device Manager have been installed, then the URL gives the option to launch either of them.
For Access Point subprofile, see
.
Table 2-4 shows how to use the classes and association classes of Access Point subprofile.
Table 2-4 CIM Elements for Access Point Subprofile
Class
CISCO_RemoteServiceAcces sPoint:CIM_RemoteService
AccessPoint
How Used
A
ServiceAccessPoint
for management tools. Returns the URL for the switch that can be used to install or launch Cisco DCNM-SAN or Device
Manager.
CISCO_RemoteIPServiceAcc essPoint:CIM_RemoteServi ceAccessPoint
CISCO_SANIPEndpoint:CIM_
BindsTo
A ServiceAccessPoint for management tools. Returns the URL for the switch that can be used to install or launch Cisco DCNM-SAN or Device
Manager.
Associates
CISCO_IPProtocolEndpoint
and
CISCO_RemoteFCIPServiceAccessPoint
.
Associates
CISCO_PhysicalComputerSystem
and
CISCO_RemoteServiceAccessPoint
.
CISCO_ComputerSystemR emoteService:CISCO_Host edAccessPoint
CISCO_SAPAvailableForEl ement:CIM_SAPAvailableF orElement
CISCO_RemoteFCIPPort:C
IM_RemotePort
CISCO_SANFCIPEndpoint
:CIM_BindsTo
CISCO_RemoteTCPPort:CI
M_RemotePort
Associates between
CISCO_PhysicalComputerSystem
and
CISCO_RemoteServiceAccessPoint
.
CISCO_SAPAvailableForElement conveys the semantics of a Service Access Point that is available for a
ManagedElement.
Adds port information to the access data (such as IP address) that is specified in and inherited from RemoteServiceAccessPoint .
Associates between
CISCO_FCIPProtocolEndpoint
and
CISCO_RemoteFCIPPort
.
Adds port information to the access data (such as IP address) that is specified in and inherited from RemoteServiceAccessPoint.
2-10
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Switch Partitioning Subprofile
The Switch Partitioning subprofile is used when a switch is implemented for multiple instances of a profile. The instances of the profile can be a mix of Switch profile and a different profile or a Switch
Profile and a Extender Profile. The switch representing the entire set of systems is called the Partitioning
System and the system that it is hosting is called the Partitioned System. For virtual fabrics, ANSI T11 calls the partitioning system the Core Switch and the partitioned system the Virtual Switch.
shows the switch partitioning subprofile.
Figure 2-4 Switch Partitioning Subprofile
CISCO_PhysicalHBA
CIM_PhysicalPackage
CISCO_ProductPhysicalHBA:
CIM_ProductPhysicalComponent
CISCO_HBAProduct:
CIM_Product
Tag:String
IdentifyingNumber:String
Name:String
Vendor:String
Version:String
CISCO_PlatformPackage:
CIM_ComputerSystemPackage
CISCO_PortControllerRealizes:
CIM_Realizes
CISCO_Platform
CreationClassName:String
Name:String
CISCO_HBASoftware
Installed :
OnPlatformCIM_
InstalledSoftwareIdentity
:
CISCO_Port
ControllerIn
Platform: CIM_
SystemDevice
CISCO_PortController
CIM_PortController
:
CreationClassName:String
DeviceID:String
SystemCreationClassName:String
SystemName:String
CISCO_Port
ControllerIn
Fabric:
CIM_System
Device
CISCO_PortController
SoftwareIdentityCIM_
ElementSoftwareIdentity
CISCO_Vsan:
CIM_AdminDomain
CreationClassName
Name
CISCO_PortControllerSoftwareIdentity
CIM_ElementSoftwareIdentity
CISCO_HBASoftwareIdentity
CIM_SoftwareIdentity
CISCO_HBASoftwareIdentity
CIM_SoftwareIdentity CIM_SoftwareIdentity
InstanceID:DRIVER_KEY\WWN
InstanceID:FIRMWARE_KEY\WWN
InstanceID:ROM_KEY\WWN
CISCO_LogicalPortGroupInHost
ComputerSystem:
CISCO_HostedCollection
CISCO_LogicalPortGroup
CIM_LogicalPortGroup
InstanceID:WWN
CISCO_FCNodeMemberOfCollection:
CIM_MemberOfCollection
CISCO_FCPort: CIM_FCPort
DeviceID:String
CreationClassName:String
SystemCreationClassName:String
SystemName:String
CISCO_EndPort
Controlled
ByPortController
CIM_ControlledBy
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-11
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Table 2-5 shows how to use the classes and association classes of Switch Partitioning subprofile.
Table 2-5 CIM Elements for FabricSwitchPartitioning
Class
CISCO_PhysicalComputerSystem:CISCO_ComputerSystem
CISCO_LogicalComputerSystem:CISCO_ComputerSystem
How Used
The partitioning computer system (core switch).
CISCO_LogicalComputerSystemsInAdminDomain:CISCO_Co mponent
CISCO_LogicalForPhysicalComputerSystem:CISCO_HostedD ependency
CISCO_LogicalSwitchElementCapabilities:CISCO_ElementCa pabilities
The partitioned computer system that acts like switch
(virtual switch).
Associates
CISCO_AdminDomain
CISCO_LogicalComputerSystem
and
.
Associates the partitioning computer system and partitioned computer system.
Represents the association between managed elements and their capabilities.
CISCO_LogicalSwitchInstalledSoftwareIdentity :
CISCO_InstalledSoftwareIdentity
CISCO_LogicalSwitchSoftwareIdentity:CISCO_SoftwareIdenti ty
Associates
CISCO_LogicalComputerSystem
CISCO_LogicalSwitchSoftwareIdentity
Software details of the logical switch.
.
and
CISCO_LogicalSwitchSettingData:CISCO_ElementSettingDat a
CISCO_FCLogicalSwitchSettings:CIM_FCSwitchSettings
CISCO_ProtocolEndPointLogicalComputerSystem
Associates CISCO_LogicalComputerSystem and
CISCO_FCLogicalSwitchSettings .
Depicts the switch settings class.
Associates
CISCO_LogicalComputerSystem
and
CISCO_ProtocolEndPoint
.
CISCO_SwitchHostedFCIPAccessPoint:CIM_HostedAccessPoi nt
Associates
CISCO_LogicalComputerSystem
and
CISCO_FCIPProtocolEndPoint
.
CISCO_SwitchHostedIPAccessPoint: CIM_HostedAccessPoint Associates CISCO_LogicalComputerSystem and
CISCO_IPProtocolEndPoint .
CISCO_SwitchHostedTCPAccessPoint:
CIM_HostedAccessPoint
Associates
CISCO_LogicalComputerSystem
CISCO_TCPProtocolEndPoint
.
and
CISCO_VsanComputerSystemComponent :
CISCO_Component
CISCO_ZoneInLogicalComputerSystem
:CISCO_HostedCollection
Associates
CISCO_Vsan
Associates
CISCO_Zone
CISCO_LogicalComputerSystem
.
CISCO_LogicalComputerSystem
.
and
and
CISCO_ZoneSetInLogicalComputerSystem :
CISCO_HostedCollection
CISCO_FCPortsInLogicalComputerSystem:CISCO_SystemDe vice
CISCO_HostComputerSystem : CISCO_ComputerSystem
CISCO_EndPortsInHostComputerSystem:CISCO_SystemDevi ce
CISCO_HostComputerSystemsInAdminDomain:CISCO_Comp onent
Associates
Associates
CISCO_LogicalComputerSystem
CISCO_ZoneSet .
CISCO_LogicalComputerSystem
CISCO_LogicalFCPort
.
and
and
The partitioned computer system which acts like the host
(the host computer).
Associates
CISCO_HostComputerSystem
and
CISCO_EndPort
.
Associates CISCO_HostComputerSystem and
CISCO_admindomain .
2-12
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Table 2-5 CIM Elements for FabricSwitchPartitioning (continued)
Class
CISCO_LogicalPortGroupInHostComputerSystem:CISCO_Hos tedCollection
CISCO_ProtocolEndPointHostComputerSystem:CISCO_Hoste dAccessPoint
CISCO_EndPort:CIM_FCPort
CISCO_EndPortControlledByPortController:CIM_ControlledB y
CISCO_EndPortSAPImplementation:CISCO_DeviceSAPImple mentation
CISCO_FCNodeMemberOfCollection:CIM_MemberOfCollecti on
CISCO_LogicalFCPort:CIM_FCPort
How Used
Associates
CISCO_HostComputerSystem
and
CISCO_LogicalPortGroup
.
Associates
CISCO_HostComputerSystem
CISCO_ProtocolEndPoint
.
and
Identifies the switch port that connects to the host.
This association represents the relationship between an end port and CIM_PortControllerclass .
This association represents the relationship between an end port and
CISCO_ProtocolEndPoint
.
This association represents the relationship between an end port and
CISCO_LogicalPortGroup
.
Fibre Channel port in the logical computer system.
CISCO_FCPortSAPImplementation:CISCO_DeviceSAPImple mentation
CISCO_FCPortsInLogicalComputerSystem:CISCO_SystemDe vice
Associates
Associates
Cisco_Logicalfcport
CISCO_ProtocolEndPoint .
Cisco_logicalfcport
CISCO_LogicalComputerSystem
.
and
and
CISCO_LogicalFCPortForFCPort:CISCO_HostedDependency Associates
Cisco_logicalfcport
and
CISCO_FCPort
.
Fan Profile
The fan profile describes the fan management in the switch.This profile includes classes which model for fan capabilities, fan relationship with switches, and its status.
displays the fan profile.
Figure 2-5 Fan Profile
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-13
Chapter 2 Cisco DCNM SMI-S Server Support
Switch Profile
Power Supply Profile
The power profile describes the power supply management in the switch.This profile includes classes which model for power supply capabilities, power supply relationship with switches, and its status.
displays the power supply profile.
Figure 2-6 Power Supply Profile
Table 2-6 shows how to use the classes and association classes of the Fan and Power Supply profile.
Table 2-6 CIM Elements for Fan and Power Supply Profile
Class
CISCO_Fan::CIM_Fan
CISCO_FanCapabilities::CIM_Enabled
LogicalElementCapabilities
CISCO_FanElementCapabilities::CISCO_Eleme ntCapabilties
CISCO_FansInPhysicalComputerSystem::CISC
O_SystemDevice
CISCO_PowerSupply::CIM_PowerSupply
How Used
Represents the fan in the physical switch.
Represents the capabilities of the fan.
Associates between the fan and its capabilities.
CISCO_
PowerSupplyCapabilities::CIM_Enabled
LogicalElementCapabilities
CISCO_ PowerSupplyElementCapabilities::
CISCO_ElementCapabilties
CISCO_PowerSuppliesInPhysicalComputerSyste m::CISCO_SystemDevice
Associates between the fan and
PhysicalComputerSystem.
Represents the Power Supply in the physical switch.
Represents the capabilities of PowerSupply.
Associates between the PowerSupply and its capabilities.
Associates between the PowerSupply andthe
PhysicalComputerSystem.
2-14
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Fabric Profile
A fabric is composed of one or more switches and network elements interconnected in a SAN. The Fabric profile models the physical and logical aspects of the fabric containing the SAN switches listed by the
Switch profile.
The SAN and fabrics are represented in CIM by the AdminDomain. SAN contains one or more fabrics, which are modeled as AdminDomains. For Fibre Channel fabrics, the identifier (AdminDomain.Name) is the fabric WWN which is the switch name of the principal switch. The AdminDomain for the Fibre
Channel fabric has a NameFormat of WWN. Fabrics can contain one or more virtual SANs (VSANs).
Figure 2-7 shows the fabric profile for zone sets.
Figure 2-8 shows the fabric profile for the host
computer system.
shows the fabric profile for storage computer system. Figure 2-10
shows the fabric profile for port.
Figure 2-7 Fabric Profile for Zonest
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-15
Fabric Profile
Figure 2-8 Fabric Profile for Host Computer System
Chapter 2 Cisco DCNM SMI-S Server Support
Figure 2-9 Fabric Profile for Storage Computer System
2-16
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Figure 2-10 Fabric Profile for Port
Primary
Site
1
2
4
TCP/IP WAN
3
Remote
Site
Fabric Profile
shows how to use the classes and association classes of the Fabric profile.
Table 2-7 CIM Elements for Fabric
Class
CISCO_ActiveConnection
:CIM_ActiveConnection
CISCO_AdminDomain:CIM_AdminDomain
CISCO_FCIPPEBasedOn:CISCO_Component
How Used
Associates a connection that is currently communicating or is configured to communicate between two ServiceAccessPoints.
AdminDomain representing the SAN.
Establishes membership relationships between a FCIP profile and the
FCIP protocol end points within a switch.
Associates CISCO_AdminDomain and CISCO_HostComputerSystem .
CISCO_HostComputerSystemsInAdminDomain:CIS
CO_Component
CISCO_PhysicalComputerSystemsInAdminDoma in:CISCO_Component
Associates
CISCO_AdminDomain
and
CISCO_PhysicalComputerSystem
.
CISCO_LogicalComputerSystemsInAdminDomai n:CISCO_Component
Associates
Cisco_LogicalComputerSystem
and
Cisco_AdminDomain
.
CISCO_ConnectivityCollection:CIM_Connectivit yCollection
Collects the protocol endpoints of the fabric.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-17
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Table 2-7 CIM Elements for Fabric (continued)
Class
CISCO_ContainedDomain
:CIM_ContainedDomain
How Used
Associates a fabric (Cisco_Vsan) to a SAN (CISCO_AdminDomain).
CISCO_VsanZoneCapabilities:CISCO_ElementC apabilities
CISCO_EthernetPortProtocolEndpoint:CIM_Devi ceSAPImplementation
Represents zone capabilities in the VSAN.
Associates the Ethernet port to the LAN end point.
CISCO_FCPortProtocolEndPoint:CIM_DeviceSA
PImplementation
CISCO_ZoneInPhysicalComputerSystem:CISCO
_HostedCollection
Associates the Fibre Channel port to the FCIP end point.
Represents active and local zones of the switch. Active zones in all
VSAN in which the switch is participating are considered. Local zones in the particular switch is represented.
CISCO_ZoneInLogicalComputerSystem:CISCO_
HostedCollection
CISCO_ZoneAliasInVsan
:CISCO_ZoneHostedCollection
CISCO_ZoneInVsan :
CISCO_ZoneHostedCollection
CISCO_LogicalPortGroup
:CIM_LogicalPortGroup
Associates zone (active and inactive) and
CISCO_logicalcomputersystem
.
Represents the zone alias in the VSAN.
Displays the active zones in VSAN and the local zones in switches.
Collection of one or more ports that are logically grouped for administrative and discovery or topology purposes. Logical port groups define port collections for access control or for use in routing policy or other management tasks.
Associates
CISCO_LogicalPortGroup
with endport.
CISCO_FCNodeMemberOfCollection:CIM_Mem berOfCollection
CISCO_ZoneAliasForZone
:CISCO_ZoneMemberOfCollection
CISCO_ZonesInZoneSet:CISCO_ZoneMemberO fCollection
CISCO_ZoneSetInPhysicalComputerSystem:CIS
CO_HostedCollection
Associates
Cisco_zonealias
and
Cisco_zone
Represents the zones present in the zone set.
.
Displays the active and local zone sets in all the VSANs in which the switch is participating.
Displays the active zone set in the VSAN. Displays the local zone set in all the switches present in the VSAN.
CISCO_ZoneSetInVsan:CISCO_ZoneHostedColl ection
CISCO_ZoneSetInAdminDomain:CISCO_ZoneH ostedCollection
CISCO_ZoneSetInLogicalComputerSystem:CISC
O_HostedCollection
CISCO_Zone:CIM_Zone
CISCO_ZoneSet:CIM_ZoneSet
Displays the zone set in admin domain which is the zone set present in the default VSAN (vsan 1).
Displays the active and local zone sets in the VSAN (logical switch) in which the switch is participating.
A zone is a group of ports, end points, nodes, zones, and namedAddressCollections that are managed collectively by the fabric. A zone indicates a set of members that are participating together in the fabric.
ZoneSet is a group of zones that are managed collectively by the fabric.
The zones are under enforcement by the fabric, only if the zone set is set to active. It displays all the active and local zone sets throughout the fabric. At any time, only one zone set is active in a VSAN.
2-18
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Table 2-7 CIM Elements for Fabric (continued)
Class How Used
CISCO_ZoneCapabilities :CIM_ZoneCapabilities Exposes the capabilities for zoning of an AdminDomain.
CISCO_ZoneMemberSettingData:CIM_ZoneMe mbershipSettingData
CISCO_ZoneSettingData
:CISCO_ElementSettingData
CISCO_FabricServiceInVsan:CISCO_HostedSer vice
CISCO_FabricService:CIM_Servic
Provides the identification criteria for possible zone and zone alias members. Thirteen different zone members are supported.
Displays the zone member setting data of the selected zone instance, depending on whether it is an active or local instance.
Associates Cisco_FabricService and Cisco_VSAN
Allows all of the fabric configuration changes.
.
Association between
Cisco_FabricService
and
Cisco_AdminDomain
.
CISCO_FabricServiceInAdminDomain:CISCO_
HostedService
CISCO_StorageComputerSystem:CISCO_Compu terSystem
Represents target in the fabric.
CISCO_EndPort:CIM_FcPort Identifies the switch port that connects to the host.
CISCO_ProtocolEndPoint:CIMProtocolEndPoint A communication point from which data can be sent or received.
ProtocolEndpoints link system or computer interfaces to
LogicalNetworks.
CISCO_StorageComputerSystemsInAdminDomai n :CISCO_Component
Associates CISCO_AdminDomain and
CISCO_StorageComputerSystem
.
Associates
CISCO_StorageComputerSystem
and
CISCO_EndPort
.
CISCO_EndPortsInStorageComputerSystem:CIS
CO_SystemDevice
CISCO_ProtocolEndPointStorageComputerSyste m:CISCO_HostedAccessPoint
CISCO_FcNodeMemberOfCollection:CIM_Mem berOfCollection
CISCO_EndPortSAPImplementation:CISCO_De viceSAPImplementation
Associates
Associates
Asscoiates
CISCO_StorageComputerSystem
CISCO_ProtocolEndpoint
CISCO_EndPort
.
CISCO_LogicalPortGroup
and
and
CISCO_EndPort
to the protocol end point.
.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-19
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
N Port Virtualizer Profile
N port virtualization (NPV) reduces the number of Fibre Channel domain IDs in DCNM-SAN. Switches operating in NPV mode are not part of the fabric and pass traffic between NPV core switch links and end devices and eliminates the domain IDs for these edge switches.
NPV integrates all locally connected N ports into one or more external NP links, which shares the domain ID of the NPV core switch among multiple NPV switches. NPV also allows multiple devices to add to the same port on the NPV core switch, which reduces the need for more ports on the core.
Figure 2-11 N Port Virtualizer Profile
Table 2-8 shows how to use the classes and association classes of the N Port Virtualizer profile.
Table 2-8 CIM Elements for N Port Virtualizer Profile
Class
CISCO_PhysicalComputerSystemsInAdminDomain
: CISCO_Component
How Used
Aggregates N Port Virtualizers in the
AdminDomain
that represents the fabric.
(N Port Virtualizer to Fabric)
CISCO_PhysicalComputerSystem:CISCO_Computer
System
The computer system representing the N Port Virtualizer.
(N PortVirtualizer)
CISCO_PhysicalComputerSystem:CISCO_Computer
SystemPackage (N Port Virtualizer to
Physical Package)
This class is required if the Switch profile is implemented. Associates
PhysicalPackage
to the
ComputerSystem
(N Port Virtualizer).
CISCO_FCPortSAPImplementation:CISCO_DeviceS
APImplementation
Associates the N Port Virtualizer Gateway FC port to its
ProtocolEndpoint
.
(ProtocolEndpoint to Gateway FCPort)
2-20
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Table 2-8 CIM Elements for N Port Virtualizer Profile (continued)
Class
CISCO_FCPortSAPImplementation:CISCO_Devi ceSAPImplementation
(ProtocolEndpoint to NPIV FCPort)
CISCO_ActiveConnection:
CIM_ActiveConnection(Gateway)
How Used
Associates the N Port Virtualizer NPIV FC port to its
ProtocolEndpoint
.
CISCO_ActiveConnection:
CIM_ActiveConnection(N Port Virtualiztion)
CISCO_FCPort: CIM_FCPort (Fabric NPIV)
CISCO_FCPort: CIM_FCPort (Gateway)
The association between ProtocolEndpoints representing the links between Fibre Channel switch ports and N Port Virtualizer gateway ports that are used to create active connections between platform and switch ports.
The association between
ProtocolEndpoints
representing the links between Fibre Channel platform ports and switch ports that are created through an N Port Virtualizer.
NPIV Fibre Channel ports of the N Port Virtualizer.
A Fibre Channel port of the N Port Virtualizer that is used to connect to the switch.
Associates the ProtocolEndpoint to the N Port Virtualizer
ComputerSystem .
Class
CISCO_ProtocolEndPointLogicalComputerSyste m
:CISCO_HostedAccessPoint
(N Port Virtualizer System to protocolEndpoint)
CISCO_LogicalIdentity: CIM_LogicalIdentity Associates
ProtocolEndpoints
of N Port Virtualizer NPIV FC ports to
ProtocolEnpoints
of Switch FC ports.
The endpoint of a link (
ActiveConnection
) on the N Port Virtualizer.
CISCO_ProtocolEndPoint:CIMProtocolEndPoint(
N Port Virtualizer)
CISCO_FCPortsInPhysicalComputerSystemexten ds CISCO_SystemDevice
(Gateway FCPort to Gateway System)
Associates N Port Virtualizer Gateway FC ports to the
ComputerSystem
(N Port Virtualizer).
CISCO_FCPortsInPhysicalComputerSystemexten ds CISCO_SystemDevice(N Port Virtualizer NPIV
FCPort to Gateway System
Associates N Port Virtualizer NPIV FC ports to the ComputerSystem (N
Port Virtualizer).
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-21
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
FDMI Profile
The Fabric Device Management Interface (FDMI) manages host bus adapters (HBA) through the fabric and complements data in the Fabric Profile. It allows any entity in the fabric to expose the HBA information through the SMI without having an agent resident on the host containing the HBA. The
Fabric Profile only addresses HBA type devices. The HBA Management Interface defined by FDMI is a subset of the interface defined by the Fibre Channel HBA API specification.
shows the FDMI subprofile instance diagram. The classes are defined in CISCO_HBA.mof.
If the FDMI- enabled HBA supports the Host name, then CISCO_PortController associates to a platform through CISCO_PortControllerInPlatform. If the FDMI-enabled HBA does not support the host name, then CISCO_PortController associates to a fabric through CISCO_PortControllerInFabric.
Figure 2-12 FDMI Subprofile
CISCO_PhysicalHBA
CIM_PhysicalPackage
CISCO_ProductPhysicalHBA:
CIM_ProductPhysicalComponent
CISCO_HBAProduct:
CIM_Product
Tag:String
IdentifyingNumber:String
Name:String
Vendor:String
Version:String
CISCO_PlatformPackage:
CIM_ComputerSystemPackage
CISCO_PortControllerRealizes:
CIM_Realizes
CISCO_Platform
CreationClassName:String
Name:String
CISCO_HBASoftware
Installed :
OnPlatformCIM_
InstalledSoftwareIdentity
CISCO_Port
:
ControllerIn
Platform: CIM_
SystemDevice
CISCO_PortController
CIM_PortController
:
CreationClassName:String
DeviceID:String
SystemCreationClassName:String
SystemName:String
CISCO_Port
ControllerIn
Fabric:
CIM_System
Device
CISCO_PortController
SoftwareIdentityCIM_
ElementSoftwareIdentity
CISCO_Vsan:
CIM_AdminDomain
CreationClassName
Name
CIM_ElementSoftwareIdentity
CISCO_HBASoftwareIdentity
CIM_SoftwareIdentity
CISCO_HBASoftwareIdentity
CIM_SoftwareIdentity CIM_SoftwareIdentity
InstanceID:DRIVER_KEY\WWN InstanceID:FIRMWARE_KEY\WWN InstanceID:ROM_KEY\WWN
CISCO_LogicalPortGroupInHost
ComputerSystem:
CISCO_HostedCollection
CISCO_LogicalPortGroup
CIM_LogicalPortGroup
InstanceID:WWN
CISCO_FCNodeMemberOfCollection:
CIM_MemberOfCollection
CISCO_FCPort: CIM_FCPort
DeviceID:String
CreationClassName:String
SystemCreationClassName:String
SystemName:String
CISCO_EndPort
Controlled
ByPortController
CIM_ControlledBy
2-22
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
shows how to use the classes and association classes of the FDMI subprofile.
Table 2-9 CIM Elements for FDMI
Class
CISCO_Platform:CIM_ComputerSystem
How Used
Represents a fabric-connected entity, containing one or more Node objects, that has registered with a fabric's Management Server service.
This class also represents the HBA host.
Allows identification of the platform on which HBA driver is installed.
CISCO_HBASoftwareInstalledOnPlatform:CIM_I nstalledSoftwareIdentity
CISCO_PlatformHostedSANAccessPoint:CIM_Hos tedAccessPoint
Associates a
ProtocolEndPoint
and the platform provided. Each platform can host many
ProtocolEndPoints
.
Denotes one or more physical HBAs that recognizes a platform.
CISCO_PlatformPackage:CIM_ComputerSystemPa ckage
CISCO_PortController:CIM_PortController Represents the port controller of an FDMI-enabled HBA.
CISCO_PortControllerInPlatform:CIM_SystemDe vice
CISCO_EndPortControlledByPortController:CIM
_ControlledBy
CISCO_PortControllerSoftwareIdentity:CIM_Ele mentSoftwareIdentity
CISCO_EndPort:CIM_FCPort
PortController is a logical device corresponding to a hardware network port controller. Port controllers provide various features depending on their types and versions.
Defines a SystemSpecificCollection in the context of a scoping system. The node registered in the platform database must also be registered in the Name Server.
Represents the relationship between a
Cim_Portcontroller
, which depicts the control services of the port to
CIM_EndPort
.
Associates any software that is associated with the port controller.
CISCO_EndPortsInHostComputerSystem:CISCO
_SystemDevice
CISCO_FCNodeMemberOfCollection:CIM_Mem berOfCollection
CISCO_LogicalPortGroup:CIM_LogicalPortGrou p
CISCO_PhysicalHBA:CIM_PhysicalPackage
CISCO_PortControllerRealizes:CIM_Realizes
Models the switch FC port that connects to the host.
Identifies end ports in host device.
Associates FCPort (end port) to the
LogicalPortGroup
.
A collection of one or more ports that are logically grouped for administrative and discovery or topology purposes. LogicalPortGroups define port collections for access control, or for use in routing policy or other management tasks.
CISCO_LogicalPortGroupInHostComputerSystem
:CISCO_HostedCollection
Associates the
LogicalPortGroup
(Fibre Channel node) to the hosting system.
Represents an FDMI-enabled physical HBA card attached to a switch.
Defines the mapping between devices and the physical elements that implement them.
Associates
HBAproduct
with physicalHBA
.
CISCO_ProductPhysicalHBA:
CIM_ProductPhysicalComponent
CISCO_PortControllerInFabric:CIM_SystemDevi ce
CISCO_HBAProduct:CIM_Product
Defines a SystemSpecificCollection in the context of a scoping system.
This association is created if within
CISCO_Platform
.
CISCO_PortController
cannot be scoped
Represents product information of an FDMI-enabled physical HBA card attached to a switch.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-23
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Virtual Fabrics Subprofile
Fibre Channel SANs can logically separate the hardware into multiple fabrics and keep them physically interconnected. The term for this technology is defined by ANSI T11 as virtual fabrics. ANSI T11 identifies the hardware as core switches.
To be consistent with more DMTF schematics, the Virtual Fabrics subprofile names the partitioning systems. ANSI T11 identifies the switching construct that resides in the partitioning system as the virtual switch. The Fabric profile provides the option to discover virtual fabrics and virtual switches. The
Virtual Fabrics subprofile provides the option to discover the underlying partitioning system. The Switch
Partitioning subprofile provides the method to configure the partitioning system.
virtual fabrics subprofile.
Figure 2-13 Virtual Fabrics Subprofile
CISCO_FabricServiceInVsan
CISCO_PortControllerInFabric
CISCO_FabricService:CIM_Service
CreationClass name:String
Name:String
SystemCreationClassName:String
SystemName:String
ZoneSetDistribute
CISCO_PortController:CIM_PortController
CreationClassName:String
DeviceID:String
SystemCreationClassName:String
CISCO_ConnectivityCollectionInVsan
CISCO_ConnectivityCollection:CIM_
ConnectivityCollection
InstanceID:String= VsanID_PWwn
CISCO_VsanZoneCapabilities
CISCO_ZoneCapabilities:
CIM_ZoneCapabilities
For Vsan:
InstanceID:String= VsanID_PWwn
For AdminDomain:
InstanceID:String= FabricSeedSwWwn
CISCO_AdminDomain:CIM_AdminDomain
CreationClassName:String
Name:String
CISCO_Vsan:CIM_AdminDomain
CISCO_ContainedDomain
CreationClassName:String
Name:String
CISCO_LogicalComputerSystem:CISCO_
ComputerSystem
CISCO_VsanComputerSystemComponent
CreationClassName:StringName:String
CISCO_ZoneAliasInVsan
CISCO_ZoneAlias:CIM_
NamedAddressCollection
InstanceID :String =VsanID_PWwn _ swwn_ AliasName
CISCO_ZoneInVsan
CISCO_ZoneServiceInVsan
CISCO_Zone:CIM_Zone
For Active Zone:
InstanceID : String = VsanID_PWwn_Zone name_
ActiveStatus
For Inactive Zone :
InstanceID : String = VsanID_PWwn_Zone name_
ActiveStatus_Wwn
CISCO_ZoneService:CIM_ZoneService
CreationClassName:String
Name: String SystemCreationClassName:String
SystemName:String
CreateZoneAlias, AddZoneAlias, CreateZoneSet,
CreateZone, CreateZoneMembershipSettingData,
AddZone, AddZoneMembershipSettingData,
ActivateZoneSet
2-24
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
shows how to use the classes and association classes of theVirtual Fabrics subprofile.
Table 2-10 CIM Elements for Virtual Fabrics
Class
CISCO_Vsan:CIM_AdminDomain
How Used
AdminDomain representing the SAN.
CISCO_ConnectivityCollectionInVsan:CISCO_Ho stedCollection
Associates
Cisco_vsan
and
CISCO_ConnectivityCollection
.
CISCO_ContainedDomain:CISCO_HostedCollectio n
Associates
Cisco_vsan
and
Cisco_admindomain
.
CISCO_FabricServiceInVsan
:CISCO_HostedService
Associates Cisco_vsan and CISCO_FabricService .
CISCO_PortControllerInFabric:CIM_SystemDevi ce
CISCO_VsanComputerSystemComponent:CISCO
_Component
Associates
Associates
Cisco_vsan
Cisco_vsan
and
and
CISCO_PortController
.
CISCO_LogicalComputerSystem
.
CISCO_VsanZoneCapabilities:CISCO_ElementCa pabilities
Represents the association between
ManagedElements
and their capabilities.
Associates Cisco_vsan and CISCO_ZoneAlias .
CISCO_ZoneAliasInVsan:CISCO_ZoneHostedCo llection
CISCO_ZoneInVsan:CISCO_ZoneHostedCollecti on
Associates
Cisco_vsan
and
CISCO_Zone
.
CISCO_ZoneServiceInVsan:CISCO_HostedServic e
Associates
Cisco_vsan
and
CISCO_ZoneService
.
CISCO_ZoneSetInVsan:CISCO_ZoneHostedColle ction
Associates
Cisco_vsan
and
CISCO_ZoneSet
.
Enhanced Zoning and Enhanced Zoning Control Subprofile
This profile describes the additional zoning functions for enhanced zoning. Sessions are normally part of enhanced zoning, but are included in the base fabric profile to address the various types of zoning operations into a single object model.
shows a enhanced zoning and enhanced zoning control.
shows how to use the classes and association classes of Enhanced Zoning and Enhanced
Zoning Control subprofile.
Table 2-11 CIM Elements for Enhanced Zoning and Enhanced Zoning Control
Class
CISCO_ZoneAliasSettingData:CISCO_ElementSettingData
CISCO_ZoneAliasInVsan:CISCO_ZoneHostedCollection
CISCO_ZoneAliasForZone:CISCO_ZoneMemberOfCollection
CISCO_ZoneAlias:CIM_NamedAddressCollection
CISCO_ZoneService:CIM_ZoneService
How Used
Associates
ZoneMembershipSettingData
to
ZoneAlias
.
Associates the zone alias to the
AdminDomain
.
Associates the zone alias with zone.
Depicts zone alias.
Allows all of the zoning configuration changes.
Extrinsic methods for this subprofile are as follows:
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-25
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Figure 2-14
• CreateZoneAlias—Creates a ZoneAlias in the principal switch of the selected VSAN.
• AddZoneAlias—Adds the ZoneAlias to the zone.
Intrinsic methods for this subprofile are as follows:
• Delete zonealias—Deletes a zone alias.
Enhanced Zoning and Enhanced Zoning Control
CISCO_ZoneService:CIM_ZoneService
CreationClassName:String
Name: String SystemCreationClassName:String SystemName:String
CreateZoneAlias, AddZoneAlias, CreateZoneSet, CreateZone,
CreateZoneMembershipSettingData,
AddZone, AddZoneMembershipSettingData, ActivateZoneSet
CISCO_ZoneServiceInAdminDomain
CISCO_Admin
Domain:CIM_
AdminDomain
CreationClass
Name:String
Name:String
CISCO_Contained
Domain
CISCO_ZoneServiceInVsan
CISCO_Vsan:
CIM_AdminDo main
CISCO_ZoneAlias
InVsan
CISCO_Zone
Alias:CIM_Named
AddressCollection
CISCO_ZoneAlias
SettingData
CreationClass
Name:String
Name:String
InstanceID:String =
VsanID_PWwn_ swwn_ AliasName
CISCO_Zone
MemberSettingData:
CIM_Zone
Membership
InstanceID: String=
VsanID_PWwn_
Zonename_ zonemembertype_ zonememberid_ vactivestatus
CISCO_ZoneAliasForZone
CISCO_Zone:CIM_Zone
For Active
Zone:
InstanceID: String= vsanID_PWwn_
Zonename_
ActiveStatus
For Inactive
Zone :
InstanceID: String=
VsanID_PWwn_
Zonename_
2-26
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 2 Cisco DCNM SMI-S Server Support
Fabric Profile
Zone Control Subprofile
This profile includes extrinsic methods for creating zone sets, zones, and zone members (see
Figure 2-14 ) and adding zones to zone sets and zone members to zones. SMI-S also defines intrinsic
methods for the removing of zone members from zones and zone aliases, zones from zone sets, and deleting zone members, zones, and zone sets.
shows how to use the classes and association classes of the Zone Control subprofile.
Table 2-12 CIM Elements for Zone Control
Class
CISCO_ZoneServiceInAdminD omain:CISCO_HostedService
How Used
Associates the
ZoneService
to the
AdminDomain
representing the fabric.
CISCO_ZoneServiceInVsan:C
ISCO_HostedService
Associates the
ZoneService
and the associated VSAN.
CISCO_ZoneService:CIM_Zon eService
Allows for all of the zoning configuration changes.
Extrinsic methods for this subprofile are as follows:
• CreateZoneSet—The method creates a zone set in the principal switch of the selected VSAN.
•
•
CreateZone—The method creates a zone in the principal switch of the selected VSAN.
CreateZoneMembershipSettingData—The method creates a zone member and adds it to the specified zone or zone alias depending on the value of the input parameter systemSpecificCollection.
•
•
AddZone—This method adds a zone to a zone set on the principal switch of the selected VSAN.
AddZoneMembershipSettingData—The method adds the zone member to the specified zone or zone alias depending on the value of the input parameter systemSpecificCollection.
• ActivateZoneSet—This method enables the activation of a zone set.
Intrinsic methods for this subprofile are as follows:
•
•
•
Delete zoneset—Deletes a zone set.
Delete zone—Deletes a zone.
Delete Zonemember—Deletes a zone member.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
2-27
Fabric Profile
Chapter 2 Cisco DCNM SMI-S Server Support
2-28
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
3
Configuring and Using Cisco DCNM SMI-S
Server
This chapter provides the steps to configure Cisco DCNM SMI-S Server in Cisco DCNM products and provides some sample scenarios for using CIM objects to manage your SAN. This chapter includes the following sections:
•
•
Installing Cisco DCNM SMI-S Server, page 3-1
Performing Discovery and Performance Monitoring, page 3-3
•
•
Modeling a Module Using the Blade Subprofile, page 3-3
Note For information about CLI commands, refer to the Cisco MDS 9000 Family Command Reference .
Installing Cisco DCNM SMI-S Server
Cisco DCNM SMI-S Server is installed as part of the Cisco DCNM installation. You can use Cisco
DCNM-SAN installed locally to discover the SAN fabric. For more information on discovering the fabric using Cisco DCNM-SAN client, see the Cisco DCNM Fundamentals Guide .
Figure 3-1 displays the SMI-S installation.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
3-1
Installing Cisco DCNM SMI-S Server
Figure 3-1 Cisco DCNM SMI-S Installation
Chapter 3 Configuring and Using Cisco DCNM SMI-S Server
Note All the platforms supported by Cisco DCNM are supported by SMI-S Server. SMI-S Server is configured as a startup service.
Changing the Default SMI-S Port
To change the default SMI-S port, follow these steps:
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Stop the Cisco SMI-S agent service.
Rename <installdir>/dcm/smis/server/jserver/bin/tcppe.properties.0
file to
<installdir>/dcm/smis/server/jserver/bin/tcppe.properties.
Edit <installdir>/dcm/smis/server/jserver/bin/tcppe.properties
file to change the port by updating the property cim-xml.http.portnumber
or cim-xml.https.portnumber, depending on whether DCNM is installed with http or https. Only one of this property is present in the file.
Save the file and close it.
Restart the Cisco SMI-S Agent service.
SMI-S provider will use the port number assigned to the property above.
3-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 3 Configuring and Using Cisco DCNM SMI-S Server
Performing Discovery and Performance Monitoring
Performing Discovery and Performance Monitoring
You can use the Fabric and Switch profiles to implement discovery and performance monitoring. See the
“Fan Profile” section on page 2-13
and the
“FDMI Profile” section on page 2-22 for more information
on these profiles.
Discovery provides information about the physical and logical entities within the SAN. This information changes dynamically as SAN entities are added, moved, or removed. Discovery also includes the discovery of object classes as well as related association classes, properties, and return status codes that are provided by servers in the managed environment.
shows how to perform discovery by using the intrinsic methods defined by CIM. Use these methods to retrieve information about the switch and fabric.
Table 3-1 Performing Discovery
Method enumerateInstances()
How Used
Enumerates instances of a CIM class.
enumerateInstanceNames() Enumerates names of instances of a CIM class.
getInstance() Gets a CIM instance.
associators() associatorName() references() referenceName()
Enumerates associators of a CIM object.
Enumerates names of associators of a CIM object.
Enumerates references to a CIM object.
Enumerates names of references to a CIM object.
The target of these methods is the location of Cisco DCNM SMI-S Server, which is identified by the switch IP address.
Performance monitoring provides the status and statistics for the local ports. Only ports on the local switch can be monitored. You can retrieve statistics from the properties of the FCPortStatistics class for FCPort class instances on Cisco DCNM SMI-S Server.
Note The namespace of Cisco DCNM SMI-S Server is cimv2.
Modeling a Module Using the Blade Subprofile
You can use the Blade subprofile to model a supervisor module, switching module, or services module within a switch.
Table 3-2 shows how to use the association classes in this subprofile to map ports to
modules and modules to switches.
Table 3-2 Using the Blade Subprofile Association Classes
Class
Realizes
ModulePort
How Used
Associates the
LogicalModule
class to the
PhysicalPackage class. Use this class to map modules to the switch.
Associates the FCPort class to the LogicalModule class. Use this class to map individual ports to modules within the switch.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
3-3
Chapter 3 Configuring and Using Cisco DCNM SMI-S Server
Configuring Zoning
See the
“Blade Subprofile” section on page 2-8
for more information about the Blade subprofile.
Configuring Zoning
The zoning model in the SMI-S uses extrinsic and intrinsic methods to manage zoning within the SAN fabric. Extrinsic methods are methods specific to a particular class. Intrinsic methods are methods inherited from the CIM and present in every applicable class.
To create a zone member (referred to as ZoneMembershipSettingData ), zone, zone alias, or zone set, use invokeMethod( operand ) . The operand can be one of the extrinsic methods from the zoning subprofiles as shown in
Table 3-3 Zoning Extrinsic Methods
Extrinsic Method
CreateZoneMembershipSettingData()
CreateZone()
CreateZoneAlias()
CreateZoneSet()
AddZone()
AddZoneMembershipSettingData()
AddZoneAlias()
ActivateZoneSet ()
ZoneSetDistribute()
CreatDeviceAlias()
How Used
Creates a
ZoneMembershipSettingData and adds it to the specified
Zone
or
NamedAddressCollection
. The
ConnectivityMemberID
is dependent upon the
ConnectivityMemberType
.
Creates a Zone and associates it to AdminDomain where the
ZoneService is hosted.
Creates a
ZoneAlias
and associates it to
AdminDomain
where the
ZoneService
is hosted.
Creates a
ZoneSet and associates it to the
AdminDomain where the
ZoneService
is hosted.
Adds the
Zone
to the specified
ZoneSet
. Adding a
Zone
to a
ZoneSet
extends the zone enforcement definition of the
ZoneSet
to include the members of that
Zone
. If adding the
Zone is successful, the
Zone
should be associated to the
ZoneSet by
MemberOfCollection
.
Adds ZoneMembershipSettingData to the Zone or
NamedAddessCollection .
Adds the
Zone Alias to the
Zone
.
Sets the
ZoneSet
to active.
Distributes the full
ZoneSet
along with active zone set per
VSAN in the fabric.
Creates a device alias with the given device alias name and
PWWN.
Use the
DeleteInstance( instance_name )
intrinsic method to remove a zoning item from a collection or to delete the zoning item entirely. The
DeleteInstance()
method requires a reference to one of the instances shown in
.
3-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 3 Configuring and Using Cisco DCNM SMI-S Server
Configuring Zoning
Table 3-4
CIM_ZoneAlias
Deleting Zoning Entities
Class
CIM_ElementSettingData
CIM_MemberOfCollection
CIM_ZoneMembershipSettingData
CIM_Zone
How Used
Removes a zone member from a zone or zone alias. Use deleteInstance()
to delete the instance of
ElementSettingData that associates the zone member to the zone.
Removes a zone or zone alias from a zone set. Use deleteInstance() to delete the instance of MemberOfCollection that associates the zone or zone alias to the zone set.
Deletes a zone member. This automatically removes it from any zone or zone alias.
Deletes a zone.
Deletes a zone alias.
CIM_ZoneSet
RemoveDeviceAlias()
Deletes a zone set.
Removes the device alias with the given device alias name.
See the
“Zone Control Subprofile” section on page 2-27
and the
Zoning Control Subprofile” section on page 2-25 for information about the zoning subprofiles.
Note For more information about SMI-S, refer to the SNIA website at http://www.snia.org
. For more information about CIM, refer to the DMTF website at http://www.dmtf.org.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
3-5
Configuring Zoning
Chapter 3 Configuring and Using Cisco DCNM SMI-S Server
3-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
4
SMI-S Notifications
This chapter includes the following sections:
•
•
Supported Indications in SMI-S Server, page 4-3
WBEM Server
WBEM server provides the interfaces to allow operators to specify the faults that needs to be notified.
The CIM classes used to establish this monitoring are included in Event Common model.
Event Common Model
The following are the components of the event common model:
• Indication Provider—Detects the traps and passes to the WBEM (CIMOM) server s indication. An indication is an instance of a class derived from the CIM_Indication.
•
•
Filters—A predefined pattern checked by CIMOM against indications. Filters are instances of classes derived from CIM_Indication filter.
Subscriptio—WBEM server consults the subscription to see if any operator is interested in being notified about indication. Subscriptions are instances of associations derived from
CIM_IndicationSubscriptions.
•
•
Handlers— WBEM server sends notifications to them. Handlers are defined in instances of classes derived from CIM_IndicationHandler.
Listenersq—Represents the SMI-S clients and receive indications.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
4-1
Chapter 4 SMI-S Notifications
Figure 4-1 Architecture of the Event Common Model
WBEM Client WBEM S erver
Li s tener
Cre a te H a ndler
Cre a te filter
Cre a te subs cription
H a ndler
Export indic a tion
Export indic a tion cre a te in s t a nce of indic a tion cre a te in s t a nce of indic a tion
Extern a l Event
Extern a l Event
Figure 4-2 Event Handling Mechanism in WBEM Server
CIM -XML
S MI S client subs cri b ed subs cri b ed
S MI S client subs cri b ed
CIMOM Event a d a pter
S MI S Provider (1…n)
JM S me ssa ging mech a ni s m
CI S CO DCNM
Intern a l tr a p
S NMP tr a p
MD S s witch MD S s witch
SNMP traps are sent asynchronously from the end devices like switches for changes in the ports, VSAN, and zone which are managed by CISCO DCNM. The SNMP traps are received and processed in the
Cisco DCNM module. There can be internal traps generated in Cisco DCNM as a part of the
4-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 4 SMI-S Notifications intercommunication between the FM modules. All the traps are sent to SMI-S module through JMS messaging mechanism. SMI-S provider receives the events and formats it as per indication provider schema and forwards it to the CIMOM. CIMOM sends the indication to the SMI-S client which are subscribed for interested indication.
Supported Indications in SMI-S Server
The supported events are either CIM_InstIndication or CIM_AlertIndication type.
• CIM_InstIndication—Describes events for creation, deletion, and modification of instances . These are also known as Life cycle events.
The Subscription format of CIM_InstIndication is: wbemclient -s https://localhost/cimv2 -u username -p password -f "SELECT * from
CIM_InstDeletion WHERE sourceInstance ISA CISCO_endport"
•
The supported events are:
– CISCO_PortAdded
–
–
CISCO_PortRemoved
CISCO_SwitchAdded
– CISCO_SwitchRemoved
CIM_AlertIndication—used for all external events.
For example, Poweralert ,tempalert, link up, and link down.
The subscription format of CIM_AlertIndication is: wbemclient -s https://localhost/cimv2 -u username -p password -f "SELECT * FROM
CISCO_LinkDown"
The supported events are:
–
–
–
–
CISCO_FanAlert
CISCO_LinkDown
CISCO_LinkUp
CISCO_PowerAlert
–
–
–
–
–
–
–
–
CISCO_TempAlert
CISCO_MediaFRUChanged
CISCO_MediaFRUInserted
CISCO_MediaFRURemoved
CISCO_ZoneAlert
CISCO_ZoneSetAlert
CISCO_NameServerDatabaseChange
CISCO_UserAdded
–
–
–
–
CISCO_UserLoginFailed
CISCO_UserModified
CISCO_UserRemoved
CISCO_VsanChanged
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
4-3
4-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 4 SMI-S Notifications
Sample SMI-S Java Client
C H A P T E R
5
This chapter describes the Sample SMI-S java client developed using JSR 48 specifications. JSR 48 is a set of java WBEM Service APIs and reference implementation for WBEM. WBEM is an initiative from the DMTF that unifies systems management and instrumentation.
The SMI-S java client uses the client and listener packages provided by the JSR 48 specifications, which consists of classes and interfaces for developing WBEM Clients and WBEM Event Listeners. The
WBEMClient interface in the client package is used to invoke WBEM operations against a WBEM
Server. A WBEMClient implementation can be retrieved from the WBEMClientFactory by specifying the protocol to be used. IndicationListener is implemented by the code that wants to create a listener for indications. The WBEMListener interface is used to add or remove WBEM Indication Listeners.
The SMI-S java client uses the Cisco DCNM SMI-S external agent for managing and monitoring Cisco
DCNM for SAN.
You can perform the following tasks from the services provided by the SMI-S client tool:
• List Zonesets, Zones, and Zonemembers in VSAN
– Obtain VSANs using enumerateInstanceNames API in WBEMClient.
•
•
•
•
– Obtain Zonesets, Zones, and Zonemembers using associatorInstances API in WBEMClient on
VSAN.
List Zones in Zoneset
–
–
–
Get VSANs using enumerateInstanceNames API in WBEMClient.
Get zonesets in selected VSAN using associatorInstances.
– Get zones in selected zoneset.
List Zonemembers in Zone
– Get VSANs using enumerateInstanceNames API in WBEMClient.
Get Zones in selected VSAN using associatorInstances.
– Get Zonemembers in selected zone.
Create new ZoneSet and Zones in fabric
–
–
Get VSANs using enumerateInstanceNames API in WBEMClient.
Get Zoneservice of the selected VSAN using associatorInstances.
– Invoke the method createzoneset in Zoneservice class with zoneset and zone name.
Add existing Zone to existing Zoneset in fabric
– Get VSANs using enumerateInstanceNames API in WBEMClient.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5-1
Chapter 5 Sample SMI-S Java Client
Installing Sample SMI-S Client
•
•
– Get Zoneservice of the selected VSAN using associatorInstances.
– Invoke the method addzone in Zoneservice class with existing zoneset and zone information.
Add Zonemember to existing Zone in fabric
–
–
Get VSANs using enumerateInstanceNames API in WBEMClient.
Get Zoneservice of the selected VSAN using associatorInstances.
– Invoke the method CreateZoneMembershipSettingData in Zoneservice class with existing zone and new zonemember information.
Activate and Deactivate a Zoneset in fabric
–
–
Get VSANs using enumerateInstanceNames API in WBEMClient.
Get Zoneservice of the selected VSAN using associatorInstances.
– Invoke the method ActivateZoneSet in Zoneservice class with existing zoneset for activation or deactivating the zoneset.
Installing Sample SMI-S Client
Note Cisco SMI-S Client is packaged with DCNM SMI-S Server.
When you choose Cisco DCNM with SMI-S Sever during installation, SMI-S Client is also available.
For more information, see the
“Installing Cisco DCNM SMI-S Server” section on page 3-1
.
• On Microsoft Windows, by default, Cisco DCNM is installed at C:\Program Files\Cisco Systems.
•
•
•
On a UNIX (Solaris or Linux) machine, Cisco DCNM is installed at /usr/local/cisco/dcm or
$HOME/dcm.
The SMI-S Client is available at <DCNM install dir> dcm/smis/client.
The batch files to compile and execute SMI-S Client and SMI-S Indication Client are available at
<DCNM install dir>/dcm/smis/client/bin .
•
•
•
•
The wbem jars are available at < DCNM install dir >/SmisClient/lib .
The source files of SMI-S Client and SMI-S Indication Client are available at <DCNM install dir> /dcm/smis/client/src and the corresponding class files are available at <DCNM install dir> /dcm/smis/client/build.
The configuration file used to retrieve Cisco DCNM credentials to access DCNM SMI-S agent are available at <DCNM install dir> /SmisClient/conf.
You can choose the type of indication to be subscribed in the filter.properties config file.
Services Provided by SMI-S Java Client
The following NMS services are supported:
• List Switches
• List Hosts
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5-2
Chapter 5 Sample SMI-S Java Client
Services Provided by SMI-S Java Client
•
•
List Targets
List VSANs in fabric
List Switches in VSAN •
•
•
Enumerate the Instance of Any CIM class
Enumerate the names of Any CIM class
• Execute Zone Operations
provides the details of the SMI-S java client services.
Table 5-1 Services Provided by SMI-S Java Client
Services Name
List Switches
List Hosts
List Target
List VSANs in Fabric
List Switches in the VSAN
Enumerate the Names of any CIM Class
Enumerate the Instance of any CIM Class
Execute Zone Operations
Subscription of the Event Listener
Description
This service lists the VSANs present in the fabric.
You need to select the VSAN to see the list of switches. The tool uses the enumerateInstances
API in Interface WBEMClient.
This service lists the hosts present in the fabric and also lists the endports present in the host. The tool uses the enumerateInstances API in Interface
WBEMClient and an associatorInstances to get the host associated to the end ports.
This service lists the targets present in the fabric and also lists the end ports present in the target.
The tool uses the enumerateInstances API in
Interface WBEMClient and an associatorInstances to get the target associated to the end ports.
This service lists all of the VSANs present in the fabric and their properties. For example, the status, WWN, VSAN ID, and temporary name of the VSAN. The tool uses the enumerateInstances
API in the Interface WBEMClient.
This service lists all the VSANs that are up and active in the fabric. Once you select it, the logical computer systems (logical switches) present in that VSAN are displayed. It also gives information of the physical switch each logical switch is hosted on.
This option allows you to select a CIM class of your choice to view CIMObjectPath names for a specified CIM class.
This option allows you to select a CIM class of your choice to view instances of a specified CIM class.
This option lists the bunch of zone services supported by the Cisco SMI-S client tool.
SMI-S Indication client can be used to subscribe to events.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5-3
Chapter 5 Sample SMI-S Java Client
Examples of Developing SMI-S Client Using WBEM Solutions
Examples of Developing SMI-S Client Using WBEM Solutions
The following example shows how to obtain WBEMclient with the specified protocol from
WBEMClientFactory:
/*
* WBEMClient handle
*/
WBEMClient clientObj = null;
/*
* The host to connect to. In the form of a WBEM URL. Make sure the WBEM
* Server is running before trying this example.
*/
String host = "http://localhost:5988/cimv2";
try {
/*
* Create an object path using the host variable.
*/
CIMObjectPath cns = new CIMObjectPath(host);
/*
* Create the principal - used for authentication/authorization
*/
UserPrincipal up = new UserPrincipal(username);
/*
* Create the credential - used for authentication/authorization
*/
PasswordCredential pc = new PasswordCredential(password);
/*
* Add the principal and credential to the subject.
*/
Subject s = new Subject();
s.getPrincipals().add(up);
s.getPrivateCredentials().add(pc);
/*
* Create a CIM client connection using the either CIM-XML or
* WS-Management protocol
*/
clientObj = WBEMClientFactory.getClient("CIM-XML");
clientObj.initialize(cns, s, null);
} catch (WBEMException e)
The following example shows using the enumerateInstanceNames API in WBEMClient:
// get wbem client obj with specified protocol
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
// pass the CIM class & name space
CIMObjectPath cop = new CIMObjectPath(className, namespace);
CloseableIterator<CIMObjectPath> ei = wbclient.enumerateInstanceNames(cop);
The following example shows using the enumerateInstances API in WBEMClient:
// get wbem client obj with specified protocol
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5-4
Chapter 5 Sample SMI-S Java Client
Examples of Developing SMI-S Client Using WBEM Solutions
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
// pass the CIM class
CloseableIterator<CIMInstance> ei = wbclient. enumerateInstances(className,null);
}
The following example shows how to get association names:
// get wbem client obj with specified protocol
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
CloseableIterator<CIMObjectPath> an =null; try{ an = wbclient.associatorNames(cimop,null, resultClass, null, null);
} catch (WBEMException e) {
System.out.println(e);
}
The following example shows how to get assoication Instances:
// get wbem client obj with specified protocol
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
CloseableIterator<CIMInstance> a =null; try{ a = wbclient.associatorInstances(cimop,null, resultClass, null, null, false, null);
} catch (WBEMException e) {
System.out.println(e);
}
The following example shows how to use the invoke method and use the extrinsic methods of CIM Class:
.// get wbem client obj with specified protocol
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
UnsignedInteger32 uInt32=(UnsignedInteger32) wbclient.invokeMethod(CIM_classname, methodname,inArgsAlias,outArgs);
Sample code for registering listener for indications: class Listener implements IndicationListener {
…… public void indicationOccured(String pIndicationURL, CIMInstance pIndication) {
CIMInstance indicationInstance = pIndication;
System.out.println("Received indication instance: " + indicationInstance);
}
…}
The following example shows how to register listener indications:
//get the WBEMListener from the WBEMListenerFactory
WBEMListener listnr = WBEMListenerFactory.getListener("CIM-XML");
//add the listener to the port. use 0 to specify any available port
Int port = api.addListener(cl,0, "http");
// get wbem client obj with specified protocol
WBEMClient wbclient = WBEMClientFactory.getClient("CIM-XML");
//create the filter
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
5-5
Chapter 5 Sample SMI-S Java Client
Examples of Developing SMI-S Client Using WBEM Solutions
String filter ="SELECT SELECT * from CIM_InstIndication WHERE sourceInstance ISA
CISCO_PhysicalComputerSystem";
CIMObjectPath op = new CIMObjectPath("CIM_IndicationFilter", namespace);
CIMClass filterClass = client.getClass(op, false, true, false, null);
CIMInstance filterInstance = filterClass.newInstance();
CIMProperty<?>[] fcpArray = { new CIMProperty<String>("Query", CIMDataType.STRING_T, filter, false, false, null), new CIMProperty<String>("QueryLanguage", CIMDataType.STRING_T, "WQL", false, false, null) }; filterInstance = filterInstance.deriveInstance(fcpArray);
CIMObjectPath filterOP = client.createInstance(filterInstance);
//create the listener
CIMObjectPath op = new CIMObjectPath("CIM_ListenerDestinationCIMXML", namespace);
CIMProperty<?>[] cpa = { new CIMProperty<String>("Destination",
CIMDataType.STRING_T, "http://" + systemName + ":"+ port +"/", false, false, null) };
// create new instance of listener
CIMInstance listenerInstance = new CIMInstance(op, cpa);
CIMObjectPath listenerOP = client.createInstance(listenerInstance);
//create a subscription, an association between the filter and listener.
CIMProperty<?>[] sicpArray = { new CIMProperty<CIMObjectPath>("Filter", new CIMDataType( filterOP.getObjectName()), filterOP, true, false, null), new CIMProperty<CIMObjectPath>("Handler", new CIMDataType( listenerOP.getObjectName()), listenerOP, true, false, null) };
CIMInstance subscriptionInstance = new CIMInstance( new CIMObjectPath("CIM_IndicationSubscription", namespace, sicpArray), sicpArray); try {
CIMObjectPath subscriptionOP = client.createInstance(subscriptionInstance);
} catch (WBEMException e) { throw e;
}
5-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
6
Managed Object Format Files for Cisco DCNM
SMI-S Server
This appendix provides the text from the Managed Object Format (MOF) files for the Cisco DCNM
SMI-S Server extensions. These MOF files are an extension to the standard MOF files and provide management for VSANs, PortChannels, FCIP, and iSCSI.
For information about the standard MOF files, refer to the DMTF website at the following URL: http://www.dmtf.org.
CISCO_ActiveConnection.mof
CISCO_ActiveConnection
[Association,
Description (
"This association defines a connection that is currently "
"communicating, or is configured to communicate, between two "
"ServiceAccessPoints i.e. two CISCO_ProtocolEndPoints." ),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ActiveConnectionProviderImpl")] class CISCO_ActiveConnection : CIM_ActiveConnection
{
[Override ( "Antecedent" ),
Description (
"A ServiceAccessPoint that is configured to communicate "
"or is actively communicating with the Dependent SAP. In "
"a unidirectional connection, this SAP is the one that is "
"transmitting." )]
CISCO_ProtocolEndPoint REF Antecedent;
[Override ( "Dependent" ),
Description (
"A second ServiceAccessPoint that is configured to "
"communicate or is actively communicating with the "
"Antecedent SAP. In a unidirectional connection, this SAP "
"is the one that is receiving the communication." )]
CISCO_ProtocolEndPoint REF Dependent;
};
CISCO_AdminDomain.mof
CISCO_AdminDomain
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-1
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_AdminDomainProviderImpl")] class CISCO_AdminDomain : CIM_AdminDomain
{};
CISCO_AdminDomainConformsToFabricProfile.mof
[Association, Version ( "3.1.0" ), Description (
"The SMISConformsToProfile association defines the "
"RegisteredProfiles that are conformant with a specific "
"verision of SIM-S. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_AdminDomainConformsToFabricProfile
ProviderImpl")
] class CISCO_AdminDomainConformsToFabricProfile : CIM_ElementConformsToProfile {
[Key, Override ( "ConformantStandard" ), Min ( 1 ), Max ( 1 ),
Description (
"The RegisteredProfile to which the ManagedElement conforms.")]
CISCO_FabricProfile REF ConformantStandard;
[Key, Override ( "ManagedElement" ), Min ( 1 ), Max ( 1 ),
Description (
"The ManagedElement that conforms to the RegisteredProfile.")]
CISCO_AdminDomain REF ManagedElement;
};
CISCO_AlertIndication.mof
CISCO_AlertIndication class CISCO_AlertIndication: CIM_AlertIndication {
[Override("IndicationIdentifier"), Description (
"Unique numeric identifier for indication.")] string IndicationIdentifier;
[Override("IndicationTime"), Description (
"The time and date of creation of the Indication. "
"The property may be set to NULL if the entity creating the "
"Indication is not capable of determining this information. "
"Note that IndicationTime may be the same for two Indications "
"that are generated in rapid succession.")] datetime IndicationTime;
[Override("AlertType"), Description (
"Primary classification of the Indication. "
"The following values are defined: \n"
"1 - Other. The Indication's OtherAlertType property conveys "
"its classification. Use of \"Other\" in an enumeration is a "
"standard CIM convention. It means that the current Indication "
"does not fit into the categories described by this enumeration. \n"
"2 - Communications Alert. An Indication of this type is "
"principally associated with the procedures and/or processes "
"required to convey information from one point to another. \n"
"3 - Quality of Service Alert. An Indication of this type is "
"principally associated with a degradation or errors in the "
"performance or function of an entity. \n"
"4 - Processing Error. An Indication of this type is "
"principally associated with a software or processing fault. "
6-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"This is the AlertType generated for failures during "
"enumerateInstanceNames or enumerateInstances. \n"
"5 - Device Alert. An Indication of this type is principally "
"associated with an equipment or hardware fault. \n"
"6 - Environmental Alert. An Indication of this type is "
"principally associated with a condition relating to an "
"enclosure in which the hardware resides, or other "
"environmental considerations. \n"
"7 - Model Change. The Indication addresses changes in the "
"Information Model. For example, it may embed a Lifecycle "
"Indication to convey the specific model change being "
"alerted. \n"
"8 - Security Alert. An Indication of this type is associated "
"with security violations, detection of viruses, user account changes "
"and similar issues. \n"
"The 'Description' field will describe the type of indication."),
ValueMap {"1", "2", "3", "4", "5", "6", "7", "8"},
Values {"Other", "Communications Alert", "Quality of Service Alert",
"Processing Error", "Device Alert", "Environmental Alert",
"Model Change", "Security Alert"}] uint16 AlertType;
[Override("OtherAlertType"), Description (
"A string describing the Alert type - used when "
"the AlertType property is set to 1, \"Other\". Other Alert types "
"include notifications that are intended as state change "
"notifications for fabric/switch/port/device/connection, etc."),
ModelCorrespondence {"CISCO_AlertIndication.AlertType"},
ValueMap {"Switch Alert", "Port Alert", "Fabric Alert", "Device Alert",
"Zone Alert", "Platform Alert", "Firmware Alert", "Connection Alert",
"HA Alert", "Agent Alert","Virtual Fabric Alert"}]
string OtherAlertType;
[Description (
"A string describing the Alert subtype. "),
MappingStrings {"API.CISCO | Event | EventType"},
ModelCorrespondence {"CISCO_AlertIndication.OtherAlertType"},
ValueMap {"New Login", "Failed Login", "Logout", "Config Changed",
"Track Change On", "Track Change Off", "Up", "Down",
"Fabric Changed", "Connected Area Online", "Connected Area Offline",
"Connected Area State Unknown", "Connected Port Online",
"Connected Port Offline", "Connected Port State Unknown",
"Database Merge Completed", "Database Change Completed",
"Config Enabled", "Config Disabled", "Config Saved",
"Config Committed", "Session Aborted", "Session Status Changed",
"Registered", "Deregistered", "State Changed", "Firmware Download Started",
"Firmware Download Completed", "Connection Merged", "Connection Deactivated",
"Connection Reactivated", "Failover Completed",
"Persistence Failure", "Initialization Failure",
"RPC Handles Initialization Failure","Event Registration Failure",
"SMIAgent Config Update Failure","Account Locked Out","Account Added",
"Account Deleted","Account Role Changed","Account Membership Changed",
"Password Expiring","Password Expired"}] string AlertSubType;
[Description (
"The identifying information for the admin "
"domain (Fabric) for which this indication is generated. "
"The property is the path of the Fabric instance encoded "
"as a string. The entity within this domain for which the "
"indication is generated is the called the AlertingManagedElement.")] string AlertingAdminDomain;
[Description (
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-3
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"The identifying information of the entity ")] string AlertingManagedElements[];
[Override("PerceivedSeverity"), Description (
"The severity of the event. "
"The values are: "
"1 - Other, by CIM convention, is used to indicate that the "
"Severity's value can be found in the OtherSeverity property. \n"
"3 - Degraded/Warning should be used when its appropriate to let "
"the user decide if action is needed. \n"
"4 - Minor should be used to indicate action is needed, but the "
"situation is not serious at this time. \n"
"5 - Major should be used to indicate action is needed NOW. \n"
"6 - Critical should be used to indicate action is needed NOW "
"and the scope is broad (perhaps an imminent outage to a "
"critical resource will result). \n"
"7 - Fatal/NonRecoverable should be used to indicate an error "
"occurred, but it's too late to take remedial action. \n"
"2 and 0 - Information and Unknown (respectively) follow common "
"usage. Literally, the AlertIndication is purely informational "
"or its severity is simply unknown."),
Values {"Unknown", "Other", "Information", "Degraded/Warning",
"Minor", "Major", "Critical", "Fatal/NonRecoverable"},
ValueMap{"0", "1", "2", "3", "4", "5", "6", "7"}] uint16 PerceivedSeverity = 0;
[Override("ProbableCause"), Description (
"An enumerated value that describes the probable cause "
"of the situation which resulted in the AlertIndication."),
Values {"Unknown", "Other"},
ValueMap{"0", "1"}] uint16 ProbableCause = 0;
[Description (
"The debug level of this event."),
Values {"Level_0", "Level_1", "Level_2", "Level_3", "Level_4",
"Level_5", "Level_6", "Level_7", "Level_8", "Level_9"},
ValueMap{"0", "1", "2", "3", "4", "5", "6", "7", "8", "9"}] uint16 DebugLevel = 0;
[Override("Description"), Description (
"Textual (ASCII) description of indication.")] string Description;
};
CISCO_Component.mof
CISCO_Component
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_Component : CIM_Component
{};
CISCO_ComputerSystem.mof
CISCO_ComputerSystem
[Abstract,
6-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Description ("This is an abstract class." )] class CISCO_ComputerSystem : CIM_ComputerSystem
{};
CISCO_ComputerSystemPackage.mof
CISCO_ComputerSystemPackage
[Association,
Description("ComputerSystem may be realized realized in "
"one or more PhysicalPackages. The ComputerSystemPackage "
"association explicitly defines this relationship."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ComputerSystemPackageProviderImpl"
)] class CISCO_ComputerSystemPackage : CIM_ComputerSystemPackage
{
[Override ( "Antecedent" ),
Description (
"The PhysicalPackage(s) that realize a Unitary ComputerSystem.")]
CISCO_PhysicalPackage REF Antecedent;
[Override ( "Dependent" ),
Description ( "The UnitaryComputerSystem." )]
CISCO_PhysicalComputerSystem REF Dependent;
};
CISCO_ComputerSystemRemoteService.mof
CISCO_ComputerSystemRemoteService
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ComputerSystemRemoteServiceProvide
rImpl")] class CISCO_ComputerSystemRemoteService : CISCO_HostedAccessPoint
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Weak, Description (
"The SAPs that are hosted on this System." )]
CISCO_RemoteServiceAccessPoint REF Dependent;
};
CISCO_ConnectivityCollection.mof
CISCO_ConnectivityCollection
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ConnectivityCollectionProviderImp
l")] class CISCO_ConnectivityCollection : CIM_ConnectivityCollection
{};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-5
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ConnectivityCollectionInVsan.mof
CISCO_ConnectivityCollectionInVsan
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ConnectivityCollectionInVsanProvid
erImpl")] class CISCO_ConnectivityCollectionInVsan : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_ConnectivityCollection REF Dependent;
};
CISCO_ConnectivityMemberOfCollection.mof
CISCO_ConnectivityMemberOfCollection
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ConnectivityMemberOfCollectionProv
iderImpl")] class CISCO_ConnectivityMemberOfCollection : CIM_MemberOfCollection
{
[Override ( "Collection" ), Min ( 1 ), Description (
"Collection representing Connectivity.")]
CISCO_ConnectivityCollection REF Collection;
[Override ( "Member" ), Min ( 1 ), Description (
"The protocol endpoints that are members of the connectivity collection.")]
CISCO_ProtocolEndPoint REF Member;
};
CISCO_ContainedDomain.mof
CISCO_ContainedDomain
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ContainedDomainProviderImpl")] class CISCO_ContainedDomain : CIM_ContainedDomain
{
[Aggregate, Override ( "GroupComponent" ),
Description (
"An AdminDomain that aggregates other AdminDomains." )]
CISCO_AdminDomain REF GroupComponent;
[Override ( "PartComponent" ),
Description (
"An AdminDomain aggregated by another AdminDomain." )]
CISCO_Vsan REF PartComponent;
};
6-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_CopyRunning.mof
CISCO_CopyRunning
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_CopyRunningProviderImpl")] class CISCO_CopyRunning:CIM_Service
{ uint32 Execute();
};
CISCO_DeviceAlias.mof
CISCO_DeviceAlias
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_DeviceAliasProviderImpl")] class CISCO_DeviceAlias : CIM_NamedAddressCollection
{ string name; string pwwn;
};
CISCO_DeviceSAPImplementation.mof
CISCO_DeviceSAPImplementation
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_DeviceSAPImplementation : CIM_DeviceSAPImplementation
{};
CISCO_ElementCapabilities.mof
CISCO_ElementCapabilities
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ElementCapabilities : CIM_ElementCapabilities
{};
CISCO_ElementSettingData.mof
CISCO_ElementSettingData
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ElementSettingData : CIM_ElementSettingData
{};
CISCO_ElementSoftwareIdentity.mof
[Association, Version("3.1.0"),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-7
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server class CISCO_ElementSoftwareIdentity : WBEMSolutions_ElementSoftwareIdentity {
[Override ( "Antecedent" ), Description (
"A LogicalElement's Software Asset.")]
CISCO_ServerSoftware REF Antecedent;
[Override ( "Dependent" ), Description (
"The ManagedElement that requires or uses the software.")]
CISCO_RegisteredProfile REF Dependent;
};
CISCO_ElementStatisticalData.mof
CISCO_ElementStatisticalData
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ElementStatisticalData : CIM_ElementStatisticalData
{};
CISCO_EndPort.mof
CISCO_EndPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EndPortProviderImpl")] class CISCO_EndPort : CIM_FCPort {
[Override ( "PortType"), Description (
"The specific mode currently enabled for the Port. The "
"values: \"N\" = Node Port, \"NL\" = Node Port supporting FC "
"arbitrated loop, \"E\" = Expansion Port connecting fabric "
"elements (for example, FC switches), \"F\" = Fabric "
"(element) Port, \"FL\" = Fabric (element) Port supporting "
"FC arbitrated loop, \"B\" = Bridge and \"G\" = Generic "
"Port. PortTypes are defined in the ANSI X3 standards. "
"When set to 1 (\"Other\"), the related property "
"OtherPortType contains a string description of the port's "
"type."),
ValueMap { "0", "1", "10", "11", "12", "13", "14", "15", "16",
"17", "18", "16004", "16010", "16011", "16012", "16000..65535"},
Values { "Unknown", "Other", "N", "NL", "F/NL", "Nx", "E", "F",
"FL", "B", "G", "PortChannel", "FCIP", "ISCSI-F", "ISCSI-N", "Vendor Reserved"}
]
uint16 PortType;
[Description (
"IP Address of the actual node.")] string NodeIpAddress;
[Experimental, Description (
"The availability of the port for client to "
"determine whether the port can be made operational. The "
"values: \n"
"\"Available\" indicates that the port can be made operational, \n"
"\"Not Installed\" indicates some aspect of the port has not been "
"installed preventing it from being operational but is discoverable through "
"instrumentation, \n"
"\"No Transceiver\" indicates that the transceiver is "
"not installed to allow the port to become operational, "
6-8
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"\"Incompatible Transceiver\" indicates the installed transceiver is not correct and is preventing "
"the port from being operational, \n"
"\"Not Licensed\" indicates that the port "
"cannot be made operational due to a license not existing for the port."),
ValueMap { "0", "1", "2", "3", "4", "5", "6" },
Values { "Unknown", "Available", "Not Installed", "No Transceiver",
"Incompatible Transceiver", "Not Licensed", "DMTF Reserved" }]
uint16 PortAvailability = 2;
};
CISCO_EndPortControlledByPortController.mof
CISCO_EndPortControlledByPortController
[Association,
Description ("This association represents the relationship between a "
"device and ports."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EndPortControlledByPortControllerP
roviderImpl")] class CISCO_EndPortControlledByPortController: CIM_ControlledBy {
[Override ("Antecedent"), Description (
"The device that controls the port.")]
CISCO_PortController REF Antecedent;
[Override ("Dependent"), Description (
"The port being controlled.")]
CISCO_EndPort REF Dependent;
};
[Override("DeviceNumber"), MaxLen(255), Description (
"Address of associated port in context of the antecedent "
"device. This may be a comma-separated list in case there "
"are multiple addresses."),
MappingStrings {"FC-GS-4 | FDMI | OS Device Name"}] string DeviceNumber;
CISCO_EndPortSAPImplementation.mof
CISCO_EndPortSAPImplementation
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EndPortSAPImplementationProviderIm
pl")] class CISCO_EndPortSAPImplementation : CISCO_DeviceSAPImplementation
{
[Override ( "Antecedent" ),
Description ( "The LogicalDevice." )]
CISCO_EndPort REF Antecedent;
[Override ( "Dependent" ),
Description (
"The ServiceAccessPoint implemented using the LogicalDevice."
)]
CISCO_ProtocolEndPoint REF Dependent;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-9
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_EndPortsInHostComputerSystem.mof
CISCO_EndPortsInHostComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EndPortsInHostComputerSystemProvid
erImpl")] class CISCO_EndPortsInHostComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_HostComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_EndPort REF PartComponent;
};
CISCO_EndPortsInStorageComputerSystem.mof
CISCO_EndPortsInStorageComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EndPortsInStorageComputerSystemPro
viderImpl")] class CISCO_EndPortsInStorageComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_StorageComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_EndPort REF PartComponent;
};
CISCO_EnvironmentalAlert.mof
CISCO_EnvironmentalAlert
[Abstract,
Indication] class CISCO_EnvironmentalAlert: CISCO_AlertIndication
{ string EnvAlertDescription;
uint32 PhysicalIndex; uint32 OperationalStatus;
};
6-10
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_EthernetPort.mof
CISCO_EthernetPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EthernetPortProviderImpl")] class CISCO_EthernetPort : CIM_EthernetPort
{};
CISCO_EthernetPortProtocolEndpoint.mof
CISCO_EthernetPortProtocolEndpoint
[Association,
Description ("CISCO_EthernetPortProtocolEndpoint associates a "
"CISCO_EthernetPort with CISCO_LANEndpoint . "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EthernetPortProtocolEndpointProvid
erImpl")] class CISCO_EthernetPortProtocolEndpoint : CIM_DeviceSAPImplementation {
[Override ( "Antecedent" ), Description (
"The EthernetPort that represents the Device behind the "
"ProtocolEndpoint.")]
CISCO_EthernetPort REF Antecedent;
};
[Override ( "Dependent" ), Description (
"The LANEndpoint implemented on the LogicalPort.")]
CISCO_LANEndpoint REF Dependent;
CISCO_EthernetPortsInPhysicalComputerSystem.mof
CISCO_EthernetPortsInPhysicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EthernetPortsInPhysicalComputerSys
temProviderImpl")] class CISCO_EthernetPortsInPhysicalComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_PhysicalComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_EthernetPort REF PartComponent;
};
CISCO_EthernetPortStatisticalData.mof
CISCO_EthernetPortStatisticalData
[Association,
Description (
"CISCO_IPEndPointStatistics is an association that associates "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-11
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"CISCO_IPProtocolEndPoint to its StatisticalData "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EthernetPortStatisticalDataProvide
rImpl")] class CISCO_EthernetPortStatisticalData : CISCO_ElementStatisticalData {
[Override ("ManagedElement"), Description (
"Reference to CISCO_EthernetPort instance.")]
CISCO_EthernetPort REF ManagedElement;
[Override("Stats"), Key, Description (
"The statistic information.")]
CISCO_EthernetPortStatistics REF Stats;
};
CISCO_EthernetPortStatistics.mof
CISCO_EthernetPortStatistics
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_EthernetPortStatisticsProviderImp
l")] class CISCO_EthernetPortStatistics : CIM_EthernetPortStatistics {
[Override("InstanceID"), Key, Description (
"Within the scope of the instantiating Namespace, InstanceID "
"opaquely and uniquely identifies an instance of this class. ")]
string InstanceID;
[Required, Override ( "ElementName" ), Description (
"The user friendly name for this instance of "
"StatisticalData. In addition, the user friendly name can be "
"used as a index property for a search of query. (Note: Name "
"does not have to be unique within a namespace.)")]
string ElementName ="Undefined";
[Override ( "PacketsTransmitted" ), Description (
"The total number of packets transmitted. This is "
"calculated as the sum of the packets transmitted "
"through each EPort associated to the GigEPort. "), Counter,
MappingStrings { "MIF.DMTF|Network Adapter 802 Port|001.6" }]
uint64 PacketsTransmitted;
[Override ( "PacketsReceived" ), Description (
"The total number of packets received. This is "
"calculated as the sum of the packets received "
"by each EPort associated to the GigEPort. "), Counter,
MappingStrings { "MIF.DMTF|Network Adapter 802 Port|001.8" }]
uint64 PacketsReceived;
[Override ( "SymbolErrors" ), Description (
"The number of times there was an invalid data symbol when a "
"valid carrier was present. The count is incremented at most "
"once per carrier event, even if multiple symbol errors "
"occur during the carrier event."), Counter,
MappingStrings { "MIB.IETF|EtherLike-MIB.dot3StatsSymbolErrors" }]
uint32 SymbolErrors;
[Override ( "AlignmentErrors" ), Description (
"A count of frames received on a particular interface that "
"are not an integral number of octets in length and do not "
"pass the FCS check. The count represented by an instance of "
"this object is incremented when the alignment error status "
"is returned by the MAC layer to the LLC (or other MAC "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-12
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"user). Received frames for which multiple error conditions "
"obtain are, according to the conventions of IEEE 802.3 "
"Layer Management, counted exclusively according to the "
"error status presented to the LLC."), Counter,
MappingStrings {"MIB.IETF|EtherLike-MIB.dot3StatsAlignmentErrors" }]
uint32 AlignmentErrors;
[Override ( "CarrierSenseErrors" ),
Description (
"The number of times that the carrier sense condition was "
"lost or never asserted when attempting to transmit a frame "
"on a particular interface. The count represented by an "
"instance of this object is incremented at most once per "
"transmission attempt, even if the carrier sense condition "
"fluctuates during a transmission attempt."), Counter,
MappingStrings {"MIB.IETF|EtherLike-MIB.dot3StatsCarrierSenseErrors" }]
uint32 CarrierSenseErrors;
[Override ( "FrameTooLongs" ),
Description (
"A count of frames received on a particular interface that "
"exceed the maximum permitted frame size. The count "
"represented by an instance of this object is incremented "
"when the FrameTooLong status is returned by the MAC layer "
"to the LLC (or other MAC user). Received frames for which "
"multiple error conditions obtain are, according to the "
"conventions of IEEE 802.3 Layer Management, counted "
"exclusively according to the error status presented to the "
"LLC."), Counter,
MappingStrings { "MIB.IETF|EtherLike-MIB.dot3StatsFrameTooLongs" }]
uint32 FrameTooLongs;
[Override ( "BytesTransmitted" ), Description (
"The total number of bytes transmitted, including framing "
"characters."), Units ( "Bytes" ), Counter,
MappingStrings { "MIB.IETF|MIB-II.ifOutOctets",
"MIF.DMTF|Network Adapter 802 Port|001.7" }]
uint64 BytesTransmitted;
[Override ( "BytesReceived" ), Description (
"The total number of bytes received, including framing "
"characters."), Units ( "Bytes" ), Counter,
MappingStrings { "MIB.IETF|MIB-II.ifInOctets",
"MIF.DMTF|Network Adapter 802 Port|001.9" }]
uint64 BytesReceived;
[Description (
"The total number of unicast frames transmitted. " )]
uint64 UnicastFramesTransmitted;
[Description (
"The total number of unicast frames received. " )]
uint64 UnicastFramesReceived;
[Description (
"The total number of multicast frames transmitted. " )]
uint64 MulticastFramesTransmitted;
[Description (
"The total number of multicast frames received. " )]
uint64 MulticastFramesReceived;
[Description (
"The total number of broadcast frames transmitted. " )]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-13
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
uint64 BroadcastFramesTransmitted;
[Description (
"The total number of broadcast frames received. " )]
uint64 BroadcastFramesReceived;
[Description (
"The total number of pause frames transmitted. " )]
uint64 PauseFramesTransmitted;
[Description (
"The total number of pause frames received. " )]
uint64 PauseFramesReceived;
[Description (
"A count of frames received with less than allowed minimum "
"frame length (64 bytes) and have CRC errors(Runt)." )]
uint32 FrameTooShorts;
[Description (
"A count of frames aborted because of excessive or "
"late collisions. " )]
uint32 Collisions;
[Description (
"A count of frames discarded because they are abruptly cut short "
"and miss valid CRC. " )]
uint32 FrameAborts;
[Description (
"A count of frames which are dropped because of lack of "
"receive buffer. " )]
uint32 Overruns;
[Description (
"A count of frames which are dropped because of "
"FIFO overflow. " )]
uint32 FIFOOverflow;
[Description (
"Number of compressed bytes through the GigEPort. This is "
"calculated as the sum of the compressed bytes transmitted "
"through each EPort associated to this GigEPort. ")]
uint64 CompressedBytes;
[Description (
"Number of uncompressed bytes through the GigEPort. This is "
"calculated as the sum of the uncompressed byes transmitted "
"through each EPort associated to this GigEPort. ")]
uint64 UncompressedBytes;
[Description (
"Number of IOAccelerated bytes.")]
uint64 IOAccelerated;
};
CISCO_FabricProfile.mof
[Version ( "3.1.0" ), Description (
"A RegisteredProfile describes a set of CIM Schema classes with "
"required properties and/or methods, necessary to manage a "
"real-world entity or to support a usage scenario, in an "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-14
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"interoperable fashion. RegisteredProfiles can be defined by "
"the DMTF or other standards organizations. Note that this "
"class should not be confused with CIM_Profile, which collects "
"SettingData instances, to be applied as a 'configuration "
"profile' for an element. \n"
"A RegisteredProfile is a named 'standard' for CIM-based "
"management of a particular System, subsystem, Service or other "
"entity, for a specified set of uses. It is a complete, "
"standalone definition, as opposed to the subclass "
"RegisteredSubProfile, which requires a scoping profile for "
"context. \n"
"The uses for a RegisteredProfile or SubProfile MUST be "
"specified in the document that defines the profile. Examples "
"of Profiles are to manage various aspects of an Operating "
"System, Storage Array, or Database. The name of the profile is "
"defined and scoped by its authoring organization."),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_FabricProfile : CISCO_RegisteredProfile {
};
CISCO_FabricService.mof
CISCO_FabricService
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FabricServiceProviderImpl")] class CISCO_FabricService : CIM_Service {
}; uint32 ZoneSetDistribute (
[Required, IN, Description (
"A reference to the ZoneSet to be activated.")]
CISCO_VSAN ref VSAN);
CISCO_FabricServiceInAdminDomain.mof
CISCO_FabricServiceInAdminDomain
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FabricServiceInAdminDomainProvider
Impl")] class CISCO_FabricServiceInAdminDomain : CISCO_HostedService
{ [Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_AdminDomain REF Antecedent;
[Override ( "Dependent" ),
Weak, Description ( "The Service hosted on the System." )]
CISCO_FabricService REF Dependent;
};
CISCO_FabricServiceInVsan.mof
CISCO_FabricServiceInVsan
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-15
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FabricServiceInVsanProviderImpl")] class CISCO_FabricServiceInVsan : CISCO_HostedService
{ [Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Weak, Description ( "The Service hosted on the System." )]
CISCO_FabricService REF Dependent;
};
CISCO_FanAlert.mof
CISCO_FanAlert
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FanAlertProviderImpl")] class CISCO_FanAlert: CISCO_EnvironmentalAlert
{};
CISCO_FCIPElementSettingData.mof
CISCO_FCIPElementSettingData
[Association,
Description ("This corresponds to the association between
CISCO_FCIPProtocolEndpoint "
"and CISCO_FCIPSettings. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPElementSettingDataProviderImpl
")] class CISCO_FCIPElementSettingData : CISCO_ElementSettingData
{
[Override ("ManagedElement"), Description (
"Reference to CISCO_FCIPProtocolEndpoint instance.")]
CISCO_FCIPProtocolEndpoint REF ManagedElement;
[Override ("SettingData"), Description (
"Reference to CISCO_FCIPSettings instance.")]
CISCO_FCIPSettings REF SettingData;
};
CISCO_FCIPPEBasedOn.mof
CISCO_FCIPPEBasedOn
[Association, Aggregation,
Description ("CISCO_FCIPPEBasedOn is an association used to establish "
"membership relationships between a fcipprofile and the fcip protocol endpoints"
"within that switch. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPPEBasedOnProviderImpl")] class CISCO_FCIPPEBasedOn: CISCO_Component {
6-16
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Override("GroupComponent"), Description (
"The switch that has contained Ethernet ports.")]
CISCO_FCIPProfile REF GroupComponent;
[Override("PartComponent"), Description (
"The FCIP ProtocolEndPoint in this switch.")]
CISCO_FCIPProtocolEndPoint REF PartComponent;
};
CISCO_FCIPProfile.mof
CISCO_FCIPProfile
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPProfileProviderImpl")] class CISCO_FCIPProfile : CIM_Profile
{
[Description ("The type of Internet address by which the entity is reachable. " )] uint32 FcipEntityAddressType;
[Description (
"The Internet address for this entity. "
)] string FcipEntityAddress;
[Description (
"A TCP port other than the FCIP Well-Known port on which the"
" FCIP entity listens for new TCP connection requests. It "
" contains the value zero (0) if the FCIP Entity only listens on "
" the Well-Known port. "
)] uint32 FcipEntityTcpConnPort;
[Description (
"An indication of whether the TCP Selective Acknowledgement"
" Option is enabled to allow the receiver end to acknowledge "
" multiple lost packets in a singel ACK, enabling faster"
" recovery."
"enabled(1) - acknowledge option is enabled."
" disabled(2) - acknowledge option is disabled. "
)] boolean FcipEntitySACKOption;
[Description (
"An indication of whether the FCIP Entity supports the "
"protection against sequence number wrap. "
"If true(1), the FCIP Entity supports protection against "
"sequence number wrap. If false(2), the FCIP Entity does not "
"support protection against sequence number wrap. "
)] boolean FcipEntitySeqNumWrap;
[Description (
"An indication of whether the FCIP Entity supports PHB IP QoS. "
)]
}; boolean FcipEntityPHBSupport;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-17
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_FCIPProtocolEndpoint.mof
CISCO_FCIPProtocolEndpoint
[Description ("A communication point from which data may be "
"sent or received. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPProtocolEndpointProviderImpl")
] class CISCO_FCIPProtocolEndpoint : CIM_ProtocolEndpoint {
[Override("SystemCreationClassName"), Key,
Propagated("CIM_System.CreationClassName"),
Description ("The scoping System's CreationClassName."),
MaxLen ( 256 )] string SystemCreationClassName;
[Override("SystemName"), Key, Propagated("CIM_System.Name"),
Description ("The scoping System's Name."),
MaxLen ( 256 )] string SystemName;
[Override("CreationClassName"), Key, Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this property "
"allows all instances of this class and its subclasses to be "
"uniquely identified."),
MaxLen ( 256 )] string CreationClassName;
[Override("Name"), Key, Description (
"A string that identifies this ProtocolEndpoint with either "
"a port or an interface on a device. To ensure uniqueness, "
"the Name property should be prepended or appended with "
"information from the Type or OtherTypeDescription "
"properties. The method selected is described in the "
"NameFormat property of this class."),
MaxLen ( 256 )] string Name;
[Override("NameFormat"), Description (
"NameFormat contains the naming heuristic that is chosen to "
"ensure that the value of the Name property is unique. For "
"example, one might choose to prepend the name of the port "
"or interface with the Type of ProtocolEndpoint that this "
"instance is (e.g., IPv4) followed by an underscore."),
MaxLen ( 256 )] string NameFormat;
[Description (
"Identifies the FCIP Tunnel on the GigE port."
"The value ranges from 0 to 7." )] uint16 TunnelID;
[Description (
"IP address of the remote end of the "
"FCIP connection.")] string RemoteIPAddress;
[Description (
"IP address for the given port.")] string LocalIPAddress ;
6-18
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Description (
"WWN of remote switch.")] string RemoteWWN;
[Description (
"WWN of the local FC switch.")] string LocalWWN;
[Description (
"Committed traffic rate on this FCIP channel.")] uint32 CommittedRate;
[Description (
"Flag to indicate if compression will be used.")] boolean Compression;
[Description (
"Flag to indicate if SACK will be used.")] boolean SelectiveACK;
[Description (
"Flag to indicate if path MTU discovery will be used.")] boolean PathMTU = false;
[Description (
"This indicates the Retransmit time in milliseconds.")] uint32 RetransmitTime;
[Description (
"This indicates the maximum number of retransmissions that "
"will be attempted.")] uint16 MaxRetransmissions;
[Override("ProtocolIFType"), Description (
"ProtocolIFType's enumeration is limited to IP-related and "
"reserved values for this subclass of ProtocolEndpoint."),
ValueMap { "1", "56", "222..4095", "4096", "4097", "4098",
"4116..32767", "32768.." },
Values { "Other","Fibre Channel", "IANA Reserved", "IPv4", "IPv6",
"IPv4/v6",
"DMTF Reserved", "Vendor Reserved" }]
uint16 ProtocolIFType = 56;
};
[Description (
"The Keep alive time in TCP.")] uint32 KeepAliveTimeout;
CISCO_FCIPSettings.mof
CISCO_FCIPSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPSettingsProviderImpl")] class CISCO_FCIPSettings : CIM_SettingData
{
[Override("InstanceID"), Key, Description (
"A string that identifies this ProtocolEndpoint with either "
"a port or an interface on a device. To ensure uniqueness, "
"the Name property should be prepended or appended with "
"information from the Type or OtherTypeDescription "
"properties. The method selected is described in the "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-19
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
6-20
"NameFormat property of this class."),
MaxLen ( 256 )] string InstanceID;
[Description (
"Identifies the FCIP Tunnel on the GigE port."
"The value ranges from 0 to 7." )] uint16 TunnelID;
[Description (
"If the value is set to 'false' this link endpoint actively"
" tries to connect to the peer. If it is set to 'true' the link"
"endpoint waits for the peer to connect to it. ")]
boolean PassiveMode;
[Description (
"The maximum number of TCP connections allowed on this"
"link. ")] uint32 NumTcpConnections;
boolean CheckTimestamp;
[Description(
"The accepted time difference between the local time"
"and the timestamp value received in the FCIP header."
"By default this value will be EDTOV/2. EDTOV is the"
"Error_Detect_Timeout Value used for Fibre channel Ports"
"as the timeout value for detecting an error condition.")] uint32 TimeStampTolerance;
[Description(
"The remote TCP port to which the local FCIP entity will"
"connect if and when it initiates a TCP connection setup"
"for this link. ")]
uint32 TcpRemPort;
//Wrong Description need to set it right
[Description(
"The remote TCP port to which the local FCIP entity will"
"connect if and when it initiates a TCP connection setup"
"for this link. ")] boolean LocalPortEnable;
[Description(
"If the value is set to 'true', the TCP active opener"
"initiates FCIP special frames and the TCP passive"
"opener responds to the FCIP special frames."
"If it is set to 'false', the FCIP special frames are"
"neither generated nor responded to. ")] boolean SpecialFrameEnable;
[Description(
"If the value is set to 'true', a message is"
"sent in response to a (Fibre Channel) ELS Echo"
"frame received from the peer. Some B Port"
"implementations use ELS Echo request/response frames"
"as Link Keep Alive."
"If it is set to 'false', this response is not"
"generated."
"This object is valid only if the"
"cfmFcipLinkExtLocalBPortEnable is 'true'. ")] boolean BPortKAEnable;
[Description(
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"The value to be set for the TOS field in IP header"
"for the TCP control connection."
"The cfmFcipLinkExtCntrlQOSField,cfmFcipLinkExtDataQOSField"
"must be set in the same SNMP set request. SET operation would"
"fail if this object is set individually. ")] uint32 CntrlQOSField;
[Description(
"The value to be set for the TOS field in IP header"
"for the TCP Data connection."
"The cfmFcipLinkExtCntrlQOSField,cfmFcipLinkExtDataQOSField"
"must be set in the same SNMP set request. SET operation would"
"fail if this object is set individually. ")] uint32 DataQOSField;
[Description(
"The ifIndex of the interface on which this FCIP link was"
"initiated. ")] uint32 EthIfIndex;
[Description(
"The Write accelerator allows for enhancing SCSI write"
"performance."
"If 'true', the FCIP Write accelerator is enabled on this link"
"If 'false' it is disabled.")] boolean WriteAccelerator;
[Description(
"The configuration for the IP compression."
"'none' - ip compression is disabled."
" 'highCompressionRatio' - indicates better compression"
" performance at the cost of lower"
" throughput."
" 'highThroughput' - indicates better throughput at"
" the cost of lower compression"
" performance."
"'auto' - indicates that an appropriate"
" mode wll be picked based on"
" the bandwidth and data."
" 'mode1' - fast compression mode for high"
" bandwidth WAN links with bandwidth"
"greater than 30 Mbps."
" 'mode2' - high compression mode for"
" moderately low bandwidth WAN links,"
" i.e. bandwidth between 15 and 30 Mbps."
" 'mode3' - high compression mode for"
" low bandwidth WAN links,"
" i.e. banwidth less than 15 Mbps."
)] uint32 IPComp;
[Description(
"The Tape accelerator allows for enhancing Tape write"
"performance."
"If 'true', the FCIP Tape accelerator is enabled on this link"
"If 'false' it is disabled.")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-21
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server boolean TapeAccelerator;
[Description(
"The flow control buffer size.")] uint32 FlowCtrlBufSize;
[Description(
"Indicates whether the IP Security has been turned on or"
" off on this link.")] boolean IPSec;
[Description(
"The physical ifIndex of the interface on which this FCIP link"
"is currently bound. ")] uint32 PhyIfIndex;
[Description(
"When Write Acceleration is operationally off for the FCIP"
" link, the value of this object will be set to 'false'."
"When Write Acceleration is operationally on for the FCIP"
"link, the value of this object will be set to 'true'. ")] boolean WriteAccOper;
[Description(
"When Tape Acceleration is operationally off for the FCIP"
" link, the value of this object will be set to 'false'."
"When Tape Acceleration is operationally on for the FCIP"
"link, the value of this object will be set to 'true'. ")] boolean TapeAccOper;
[Description(
"This object represents the state of the Tape Read"
"Acceleration for an FCIP link. Tape Read Acceleration"
"is automatically operational when Tape Acceleration is"
"operational (cfmFcipLinkExtTapeAccOper) and both sides"
"of the FCIP link support Tape Read Acceleration."
" When Tape Read Acceleration is operationally off for"
"the FCIP link, the value of this object is 'false'."
"When Tape Read Acceleration is operationally on for"
"the FCIP link, the value of this object is 'true'. ")] boolean TapeAccReadOper;
// [Description(
// "When Tape Acceleration is operationally off for the FCIP
// link, the value of this object will be set to 'false'.
// When Tape Acceleration is operationally on for the FCIP
// link, the value of this object will be set to 'true'. "
// )]
}; uint32 KeepAliveTimeout; uint32 SpecialFrameTimeout; uint16 ConnectionUsageFlags;
CISCO_FCIPTCPEndpoint.mof
CISCO_FCIPTCPEndpoint
[Association,
Description ("This corresponds to the association between
CISCO_FCIPProtocolEndpoint "
"and CISCO_TCPProtocolEndPoint."),
6-22
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCIPTCPEndpointProviderImpl")] class CISCO_FCIPTCPEndpoint : CIM_BindsTo {
[Override ( "Antecedent" ), Description (
"The underlying TCPEndpoint, which is depended upon.")]
CISCO_TCPProtocolEndPoint REF Antecedent;
};
[Override ( "Dependent" ), Description (
"The FCIP ProtocolEndpoint dependent on the TCP Endpoint.")]
CISCO_FCIPProtocolEndpoint REF Dependent;
CISCO_FCLogicalSwitchCapabilities.mof
CISCO_FCLogicalSwitchCapabilities
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCLogicalSwitchCapabilitiesProvid
erImpl")] class CISCO_FCLogicalSwitchCapabilities : CIM_FCSwitchCapabilities
{};
CISCO_FCLogicalSwitchSettings.mof
CISCO_FCLogicalSwitchSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCLogicalSwitchSettingsProviderIm
pl")] class CISCO_FCLogicalSwitchSettings : CIM_FCSwitchSettings
{};
CISCO_FCNodeMemberOfCollection.mof
CISCO_FCNodeMemberOfCollection
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCNodeMemberOfCollectionProviderIm
pl")] class CISCO_FCNodeMemberOfCollection : CIM_MemberOfCollection
{
[Override ( "Collection" ), Min ( 1 ), Description (
"Collection representing Connectivity.")]
CISCO_LogicalPortGroup REF Collection;
[Override ( "Member" ), Min ( 1 ), Description (
"The protocol endpoints that are members of the connectivity collection.")]
CISCO_EndPort REF Member;
};
CISCO_FCPort.mof
CISCO_FCPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortProviderImpl")] class CISCO_FCPort : CIM_FCPort {
[Override ( "PortType"), Description (
"The specific mode currently enabled for the Port. The "
"values: \"N\" = Node Port, \"NL\" = Node Port supporting FC "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-23
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"arbitrated loop, \"E\" = Expansion Port connecting fabric "
"elements (for example, FC switches), \"F\" = Fabric "
"(element) Port, \"FL\" = Fabric (element) Port supporting "
"FC arbitrated loop, \"B\" = Bridge and \"G\" = Generic "
"Port. PortTypes are defined in the ANSI X3 standards. "
"When set to 1 (\"Other\"), the related property "
"OtherPortType contains a string description of the port's "
"type."),
ValueMap { "0", "1", "10", "11", "12", "13", "14", "15", "16",
"17", "18", “19”, "16004", "16010", "16011", "16012", "16000..65535"},
Values { "Unknown", "Other", "N", "NL", "F/NL", "Nx", "E", "F",
"FL", "B", "G", “NP”, "PortChannel", "FCIP", "ISCSI-F", "ISCSI-N", "Vendor
Reserved"} ]
uint16 PortType;
[Description (
"IP Address of the actual node.")] string NodeIpAddress;
[Experimental, Description (
"The availability of the port for client to "
"determine whether the port can be made operational. The "
"values: \n"
"\"Available\" indicates that the port can be made operational, \n"
"\"Not Installed\" indicates some aspect of the port has not been "
"installed preventing it from being operational but is discoverable through "
"instrumentation, \n"
"\"No Transceiver\" indicates that the transceiver is "
"not installed to allow the port to become operational, "
"\"Incompatible Transceiver\" indicates the installed transceiver is not correct and is preventing "
"the port from being operational, \n"
"\"Not Licensed\" indicates that the port "
"cannot be made operational due to a license not existing for the port."),
ValueMap { "0", "1", "2", "3", "4", "5", "6" },
Values { "Unknown", "Available", "Not Installed", "No Transceiver",
"Incompatible Transceiver", "Not Licensed", "DMTF Reserved" }]
uint16 PortAvailability = 2;
};
CISCO_FCPortCapabilities.mof
CISCO_FCPortCapabilities
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortCapabilitiesProviderImpl")] class CISCO_FCPortCapabilities : CIM_FCPortCapabilities
{};
CISCO_FCPortElementCapabilities.mof
CISCO_FCPortElementCapabilities
[Association,
Description("ElementCapabilities represents the association between "
"ManagedElements and their Capabilities."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortElementCapabilitiesProviderI
mpl")] class CISCO_FCPortElementCapabilities : CISCO_ElementCapabilities
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
6-24
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Max ( 1 ),
Description ( "The managed element." )]
CISCO_FCPort REF ManagedElement;
[Override ( "Capabilities" ), Key, Description (
"The Capabilities object associated with the element." )]
CISCO_FCPortCapabilities REF Capabilities;
};
CISCO_FCPortProtocolEndPoint.mof
CISCO_FCPortProtocolEndPoint
[Association,
Description ("CISCO_FcPortProtocolEndpoint associates a "
"CISCO_FcPort with CISCO_LANEndpoint . "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortProtocolEndPointProviderImpl
")] class CISCO_FCPortProtocolEndPoint : CIM_DeviceSAPImplementation {
[Override ( "Antecedent" ), Description (
"The FcPort that represents the Device behind the "
"ProtocolEndpoint.")]
CISCO_FCPort REF Antecedent;
[Override ( "Dependent" ), Description (
"The FCIPProtocolEndpoint implemented on the LogicalPort.")]
CISCO_FCIPProtocolEndpoint REF Dependent;
};
CISCO_FCPortSAPImplementation.mof
CISCO_FCPortSAPImplementation
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortSAPImplementationProviderImp
l")] class CISCO_FCPortSAPImplementation : CISCO_DeviceSAPImplementation
{
[Override ( "Antecedent" ),
Description ( "The LogicalDevice." )]
Cisco_LogicalFcPort REF Antecedent;
[Override ( "Dependent" ),
Description (
"The ServiceAccessPoint implemented using the LogicalDevice."
)]
CISCO_ProtocolEndPoint REF Dependent;
};
CISCO_FCPortSettingData.mof
CISCO_FCPortSettingData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortSettingDataProviderImpl")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-25
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server class CISCO_FCPortSettingData : CISCO_ElementSettingData
{
[Override ( "ManagedElement" ), Key,
Description ( "The managed element." )]
CISCO_FCPort REF ManagedElement;
[Override ( "SettingData" ), Key, Description (
"The SettingData object associated with the element." )]
CISCO_FCPortSettings REF SettingData;
};
CISCO_FCPortSettings.mof
CISCO_FCPortSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortSettingsProviderImpl")] class CISCO_FCPortSettings : CIM_FCPortSettings
{};
CISCO_FCPortsInLogicalComputerSystem.mof
CISCO_FCPortsInLogicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortsInLogicalComputerSystemProv
iderImpl")] class CISCO_FCPortsInLogicalComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_LogicalComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_LogicalFCPort REF PartComponent;
};
CISCO_FCPortsInPhysicalComputerSystem.mof
CISCO_FCPortsInPhysicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortsInPhysicalComputerSystemPro
viderImpl")] class CISCO_FCPortsInPhysicalComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_PhysicalComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
6-26
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_FCPort REF PartComponent;
};
CISCO_FCPortsInPortChannel.mof
CISCO_FCPortsInPortChannel
[Association,
Description ("This corresponds to the association between CISCO_PortChannel"
"and CISCO_FCPort. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortsInPortChannelProviderImpl")
] class CISCO_FCPortsInPortChannel : CIM_MemberOfCollection
{
[Override ( "Collection" ), Min ( 1 ), Description (
"PortChannel.")]
CISCO_PortChannel REF Collection;
[Override ( "Member" ), Min ( 1 ), Max ( 8 ), Description (
"The ports that are members of the port channel.")]
CISCO_FCPort REF Member;
};
CISCO_FCPortStatisticalData.mof
CISCO_FCPortStatisticalData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortStatisticalDataProviderImpl"
)] class CISCO_FCPortStatisticalData : CISCO_ElementStatisticalData
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
Max ( 1 ),
Description (
"The ManagedElement for which statistical or metric data "
"is defined." )]
CISCO_FCPort REF ManagedElement;
[Override ( "Stats" ), Key, Description (
"The statistic information/object." )]
CISCO_FCPortStatistics REF Stats;
};
CISCO_FCPortStatistics.mof
CISCO_FCPortStatistics
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCPortStatisticsProviderImpl")] class CISCO_FCPortStatistics : CIM_FCPortStatistics
{};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-27
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_FCSwitchCapabilities.mof
CISCO_FCSwitchCapabilities
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCSwitchCapabilitiesProviderImpl"
)] class CISCO_FCSwitchCapabilities : CIM_FCSwitchCapabilities
{};
CISCO_FCSwitchSettings.mof
CISCO_FCSwitchSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_FCSwitchSettingsProviderImpl")] class CISCO_FCSwitchSettings : CIM_FCSwitchSettings
{};
CISCO_HBAProduct.mof
CISCO_HBAProduct
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_HBAProductProviderImpl"),
Description ("This class represents product information of FDMI enabled physical
HBA card attached "
"to a switch.")] class CISCO_HBAProduct: CIM_Product {
[Override("Name"),Key, Description (
"Commonly used Product name."),
MaxLen ( 256 )] string Name;
[Override("IdentifyingNumber"),Key, Description (
"A manufacturer-allocated number used to identify the HBA. "
"This value SHOULD match a serial number engraved or "
"printed in the HBA."),
MaxLen ( 64 ),
MappingStrings { "FC-GS-4 | FDMI | IdentifyingNumber " }] string IdentifyingNumber;
[Override("Vendor"),Key, Description (
"The name of the Product's supplier, or entity selling the "
"Product (the manufacturer, reseller, OEM, etc.). "
"Corresponds to the Vendor property in the Product object in "
"the DMTF Solution Exchange Standard."),
MaxLen ( 256 ),
MappingStrings { "FC-GS-4 | FDMI | Manufacturer" }] string Vendor;
[Override("Version"),Key, Description (
"A string indicating the version of the HBA card."),
MaxLen ( 64 ),
MappingStrings { "FC-GS-4 | FDMI | Version" }] string Version;
[Override("ElementName"), Description(
"The detailed description of the model of the HBA. The "
"value might provide a more detailed identification of the "
"HBA than the Model property does "),
MappingStrings {"FC-GS-4 | FDMI | Model Description"}] string ElementName;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-28
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
CISCO_HBASoftwareIdentity.mof
CISCO_HBASoftwareIdentity
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_HBASoftwareIdentityProviderImpl")
] class CISCO_HBASoftwareIdentity : CIM_SoftwareIdentity
{};
CISCO_HBASoftwareInstalledOnPlatform.mof
CISCO_HBASoftwareInstalledOnPlatform
[Association,
Description ("The SofwareInstalledOnPlatform relationship allows the "
"identification of the platform on which HBA driver "
"is installed and this association can return multiple instances."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_HBASoftwareInstalledOnPlatformProv
iderImpl")] class CISCO_HBASoftwareInstalledOnPlatform: CIM_InstalledSoftwareIdentity {
[Key, Override("System"), Max (1), Description (
"Reference to the platform hosting a particular "
"SoftwareIdentity.")]
CISCO_Platform REF System;
};
[Key, Override("InstalledSoftware"), Description (
"Reference to the driver that is installed on the "
"platform.")]
CISCO_HBASoftwareIdentity REF InstalledSoftware;
CISCO_HostComputerSystem.mof
CISCO_HostComputerSystem
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_HostComputerSystemProviderImpl")] class CISCO_HostComputerSystem : CISCO_ComputerSystem
{
String IpAddress;
};
CISCO_HostComputerSystemsInAdminDomain.mof
CISCO_HostComputerSystemsInAdminDomain
[Association,
Description (
"CISCO_HostComputerSystemsInAdminDomain is a association between CISCO_AdminDomain and "
"CISCO_HostComputerSystem."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_HostComputerSystemsInAdminDomainPr
oviderImpl")] class CISCO_HostComputerSystemsInAdminDomain : CISCO_Component
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-29
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
{
[Override ("GroupComponent"), Key, Aggregate, Description (
"The parent element in the association." )]
CISCO_AdminDomain REF GroupComponent;
[Override("PartComponent"), Key, Description (
"The child element in the association." )]
CISCO_HostComputerSystem REF PartComponent;
};
CISCO_HostedAccessPoint.mof
CISCO_HostedAccessPoint
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_HostedAccessPoint : CIM_HostedAccessPoint
{};
CISCO_HostedCollection.mof
CISCO_HostedCollection
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_HostedCollection : CIM_HostedCollection
{};
CISCO_HostedDependency.mof
CISCO_HostedDependency
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_HostedDependency : CIM_HostedDependency
{};
CISCO_HostedService.mof
CISCO_HostedService
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_HostedService : CIM_HostedService
{};
CISCO_InstalledSoftwareIdentity.mof
CISCO_InstalledSoftwareIdentity
[Abstract,
Association,
6-30
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Description ("This is an abstract association." )] class CISCO_InstalledSoftwareIdentity : CIM_InstalledSoftwareIdentity
{};
CISCO_IPElementSettingData.mof
CISCO_IPElementSettingData
[Association,
Description ("This corresponds to the association between CISCO_IPProtocolEndpoint
"
"and CISCO_IPSettings. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPElementSettingDataProviderImpl")
] class CISCO_IPElementSettingData : CIM_ElementSettingData
{
[Override ("ManagedElement"), Description (
"Reference to CISCO_IPProtocolEndpoint instance.")]
CISCO_IPProtocolEndpoint REF ManagedElement;
[Override ("SettingData"), Description (
"Reference to CISCO_FCIPSettings instance.")]
CISCO_IPSettings REF SettingData;
};
CISCO_IPEndPointStatisticalData.mof
CISCO_IPEndPointStatisticalData
[Association,
Description ("CISCO_IPEndPointStatistics is an association that associates "
"CISCO_IPProtocolEndPoint to its StatisticalData "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPEndPointStatisticalDataProviderI
mpl")] class CISCO_IPEndPointStatisticalData : CIM_ElementStatisticalData {
[Override ("ManagedElement"), Description (
"Reference to CISCO_IPProtocolEndpoint instance.")]
CISCO_IPProtocolEndPoint REF ManagedElement;
[Override("Stats"), Key, Description (
"The statistic information.")]
CISCO_IPEndPointStatistics REF Stats;
};
CISCO_IPEndPointStatistics.mof
CISCO_IPEndPointStatistics
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPEndPointStatisticsProviderImpl"
)] class CISCO_IPEndPointStatistics : CIM_IPEndpointStatistics {
[Description (
"The number of times FC synchronization lost on this FCIP Link. "
)]
uint64 FcipLossofFcSynchs;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-31
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Description (
"The number of times FCIP Special Frame not received on this FCIP Link. "
)]
uint64 FcipSfNotRcv;
[Description (
"The number of times FCIP Special Frame Response not received on this FCIP Link. "
)]
uint64 FcipSfRespNotRcv;
[Description (
"The number of times FCIP Special Frame Bytes mismatch"
" happened on this FCIP Link. "
)]
uint64 FcipSfRespMismatch;
[Description (
"The number of times FCIP Special Frame Invalid connections"
" once happened on this FCIP Link. "
)] uint64 FcipSfInvalidNonce;
[Description (
"The number of times FCIP Special Frame Response not received on this FCIP Link. "
)] uint64 FcipDuplicateSfRcv;
[Description (
"The number of times FCIP Special Frames with invalid "
" destination FC Fabric Entity WWN received on this FCIP Link. "
)] uint64 FcipSfInvalidWWN;
[Description (
"The number of times B_Access Link Keep Alive Time out"
" happened on this FCIP Link. "
)] uint64 FcipBB2LkaTimeOut;
[Description (
"The number of times SNTP Time Stamp expired on this FCIP Link. "
)] uint64 FcipSntpTimeStampExp;
};
CISCO_IPEthernetEndpoint.mof
CISCO_IPEthernetEndpoint
[Association,
Description ("This corresponds to the association between
CISCO_IPProtocollEndpoint "
"and CISCO_LANEndPoint." ),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPEthernetEndpointProviderImpl")] class CISCO_IPEthernetEndpoint : CIM_BindsTo {
[Override ( "Antecedent" ), Description (
"The underlying IP Endpoint, which is depended upon.")]
CISCO_IPProtocolEndpoint REF Antecedent;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-32
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
[Override ( "Dependent" ), Description (
"The LAN Endpoint dependent on the IP Endpoint.")]
CISCO_LANEndPoint REF Dependent;
CISCO_IPProtocolEndpoint.mof
CISCO_IPProtocolEndpoint
[Description ("A protocol endpoint that is dedicated to running IP."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPProtocolEndpointProviderImpl")] class CISCO_IPProtocolEndpoint: CIM_IPProtocolEndPoint {
[Override("SystemCreationClassName"), Key, Propagated("CIM_System.CreationClassName"),
Description ("The scoping System's CreationClassName."),
MaxLen ( 256 )] string SystemCreationClassName;
[Override("SystemName"), Key, Propagated("CIM_System.Name"),
Description ("The scoping System's Name."),
MaxLen ( 256 )] string SystemName;
[Override("CreationClassName"), Key, Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this property "
"allows all instances of this class and its subclasses to be "
"uniquely identified."),
MaxLen ( 256 )] string CreationClassName;
[Override("Name"), Key, Description (
"A string that identifies this ProtocolEndpoint with either "
"a port or an interface on a device. To ensure uniqueness, "
"the Name property should be prepended or appended with "
"information from the Type or OtherTypeDescription "
"properties. The method selected is described in the "
"NameFormat property of this class."),
MaxLen ( 256 )] string Name;
[Override("NameFormat"), Description (
"NameFormat contains the naming heuristic that is chosen to "
"ensure that the value of the Name property is unique. For "
"example, one might choose to prepend the name of the port "
"or interface with the Type of ProtocolEndpoint that this "
"instance is (e.g., IPv4) followed by an underscore."),
MaxLen ( 256 )] string NameFormat;
[Override("IPv4Address"), Description (
"The IPv4 address that this ProtocolEndpoint represents.")] string IPv4Address;
[Override("SubnetMask"), Description (
"The mask for the IPv4 address of this ProtocolEndpoint, if "
"one is defined.")] string SubnetMask;
[Override("ProtocolIFType"), Description (
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-33
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
// [Experimental, Description (
// "AddressOrigin identifies the method by which the IP "
//
//
"Address, Subnet Mask, and Gateway were assigned to the "
"IPProtocolEndpoint."),
//
//
ValueMap { "0", "1", "2", "3", "4", "5", "6..32767", "32768.." },
Values { "Unknown", "Other", "Not Applicable", "Static", "DHCP",
// "BOOTP", "DMTF Reserved", "Vendor Reserved" }]
// uint16 AddressOrigin = 3;
};
"ProtocolIFType's enumeration is limited to IP-related and "
"reserved values for this subclass of ProtocolEndpoint."),
ValueMap { "1", "222..4095", "4096", "4097", "4098",
"4116..32767", "32768.." },
Values { "Other", "IANA Reserved", "IPv4", "IPv6", "IPv4/v6",
"DMTF Reserved", "Vendor Reserved" }] uint16 ProtocolIFType = 4096;
CISCO_IPSettings.mof
CISCO_IPSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_IPSettingsProviderImpl")] class CISCO_IPSettings : CIM_IPSettings
{};
CISCO_LANEndpoint.mof
CISCO_LANEndpoint
[Description ("A communication endpoint which, when its associated interface "
"device is connected to a LAN, may send and receive data "
"frames. LANEndpoints include Ethernet, Token Ring and FDDI "
"interfaces."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LANEndpointProviderImpl")] class CISCO_LANEndpoint : CIM_ProtocolEndpoint {
[Override("SystemCreationClassName"), Key,
Propagated("CIM_System.CreationClassName"),
Description ("The scoping System's CreationClassName."),
MaxLen ( 256 )] string SystemCreationClassName;
[Override("SystemName"), Key, Propagated("CIM_System.Name"),
Description ("The scoping System's Name."),
MaxLen ( 256 )] string SystemName;
[Override("CreationClassName"), Key, Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this property "
"allows all instances of this class and its subclasses to be "
"uniquely identified."),
MaxLen ( 256 )] string CreationClassName;
[Override("Name"), Key, Description (
"A string that identifies this ProtocolEndpoint with either "
"a port or an interface on a device. To ensure uniqueness, "
6-34
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"the Name property should be prepended or appended with "
"information from the Type or OtherTypeDescription "
"properties. The method selected is described in the "
"NameFormat property of this class."),
MaxLen ( 256 )] string Name;
[Override ( "NameFormat" ), Description (
"NameFormat contains the naming heuristic that is chosen to "
"ensure that the value of the Name property is unique. For "
"example, one might choose to prepend the name of the port "
"or interface with the Type of ProtocolEndpoint that this "
"instance is (e.g., IPv4) followed by an underscore."),
MaxLen ( 256 )] string NameFormat;
};
[Override("ProtocolIFType"), Description (
"ProtocolIFType's enumeration is limited to Layer 2-related and "
"reserved values for this subclass of ProtocolEndpoint."),
ValueMap { "1", "6", "9", "15", "222..4095", "4116..32767", "32768.." },
Values { "Other", "Ethernet CSMA/CD", "ISO 802.5 Token Ring",
"FDDI", "IANA Reserved", "DMTF Reserved", "Vendor Reserved" }] uint16 ProtocolIFType = 6;
CISCO_LinkDown.mof
CISCO_LinkDown
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LinkDownProviderImpl")] class CISCO_LinkDown : CISCO_LinkStateChange
{};
CISCO_LinkStateChange.mof
CISCO_LinkStateChange
[Abstract,
Indication,
Description ("This is an abstract indication class." )] class CISCO_LinkStateChange : CISCO_AlertIndication
{
[Description (
"The desired state of the interface. The testing (3) state"
"indicates that no operational packets can be passed. When a"
"managed system initializes, all interfaces start with"
"ifAdminStatus in the down(2) state. As a result of either"
"explicit management action or per configuration information"
"retained by the managed system, ifAdminStatus is then"
"changed to either the up(1) or testing(3) states (or remains"
"in the down(2) state)."),
ValueMap {"0", "1", "2"},
Values { "up", "down", "testing"}]
uint32 ifAdminStatus;
[Description (
"The current operational state of the interface. "),
ValueMap {"1", "2", "3", "4", "5", "6", "7"},
Values { "up", "down", "testing", "unknown", "dormant",
"notPresent", "lowerLayerDown"}]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-35
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
uint32 ifOperStatus;
uint32 ifIndex;
};
CISCO_LinkUp.mof
CISCO_LinkUp
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LinkUpProviderImpl")] class CISCO_LinkUp : CISCO_LinkStateChange
{};
CISCO_LogicalComputerSystem.mof
CISCO_LogicalComputerSystem
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalComputerSystemProviderImpl
")] class CISCO_LogicalComputerSystem : CISCO_ComputerSystem
{
};
CISCO_LogicalComputerSystemsInAdminDomain.mof
CISCO_LogicalComputerSystemsInAdminDomain
[Association,
Description (
"CISCO_LogicalComputerSystemsInAdminDomain is a association between
CISCO_AdminDomain and "
"CISCO_LogicalComputerSystem."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalComputerSystemsInAdminDomai
nProviderImpl")] class CISCO_LogicalComputerSystemsInAdminDomain : CISCO_Component
{
[Override ("GroupComponent"), Key, Aggregate, Description (
"The parent element in the association." )]
CISCO_AdminDomain REF GroupComponent;
[Override("PartComponent"), Key, Description (
"The child element in the association." )]
CISCO_LogicalComputerSystem REF PartComponent;
};
CISCO_LogicalFCPort.mof
CISCO_LogicalFCPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalFCPortProviderImpl")] class CISCO_LogicalFCPort : CIM_FCPort {
[Override ( "PortType"), Description (
"The specific mode currently enabled for the Port. The "
"values: \"N\" = Node Port, \"NL\" = Node Port supporting FC "
"arbitrated loop, \"E\" = Expansion Port connecting fabric "
"elements (for example, FC switches), \"F\" = Fabric "
6-36
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"(element) Port, \"FL\" = Fabric (element) Port supporting "
"FC arbitrated loop, \"B\" = Bridge and \"G\" = Generic "
"Port. PortTypes are defined in the ANSI X3 standards. "
"When set to 1 (\"Other\"), the related property "
"OtherPortType contains a string description of the port's "
"type."),
ValueMap { "0", "1", "10", "11", "12", "13", "14", "15", "16",
"17", "18", "16004", "16010", "16011", "16012", "16000..65535"},
Values { "Unknown", "Other", "N", "NL", "F/NL", "Nx", "E", "F",
"FL", "B", "G", "PortChannel", "FCIP", "ISCSI-F", "ISCSI-N", "Vendor Reserved"}
]
uint16 PortType;
[Description (
"IP Address of the actual node.")] string NodeIpAddress;
[Experimental, Description (
"The availability of the port for client to "
"determine whether the port can be made operational. The "
"values: \n"
"\"Available\" indicates that the port can be made operational, \n"
"\"Not Installed\" indicates some aspect of the port has not been "
"installed preventing it from being operational but is discoverable through "
"instrumentation, \n"
"\"No Transceiver\" indicates that the transceiver is "
"not installed to allow the port to become operational, "
"\"Incompatible Transceiver\" indicates the installed transceiver is not correct and is preventing "
"the port from being operational, \n"
"\"Not Licensed\" indicates that the port "
"cannot be made operational due to a license not existing for the port."),
ValueMap { "0", "1", "2", "3", "4", "5", "6" },
Values { "Unknown", "Available", "Not Installed", "No Transceiver",
"Incompatible Transceiver", "Not Licensed", "DMTF Reserved" }]
uint16 PortAvailability = 2;
};
CISCO_LogicalFCPortForFCPort.mof
CISCO_LogicalFCPortForFCPort
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalFCPortForFCPortProviderImpl
")] class CISCO_LogicalFCPortForFCPort : CISCO_HostedDependency
{
[Override ( "Antecedent" ),
Max ( 1 ),
Description ( "The scoping ManagedElement." )]
CISCO_FCPort REF Antecedent;
[Override ( "Dependent" ),
Description ( "The hosted ManagedElement." )]
CISCO_LogicalFCPort REF Dependent;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-37
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_LogicalForPhysicalComputerSystem.mof
CISCO_LogicalForPhysicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalForPhysicalComputerSystemPr
oviderImpl")] class CISCO_LogicalForPhysicalComputerSystem : CISCO_HostedDependency
{
[Override ( "Antecedent" ),
Max ( 1 ),
Description ( "The scoping ManagedElement." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description ( "The hosted ManagedElement." )]
CISCO_LogicalComputerSystem REF Dependent;
};
CISCO_LogicalModule.mof
CISCO_LogicalModule
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalModuleProviderImpl")] class CISCO_LogicalModule : CIM_LogicalModule
{};
CISCO_LogicalModulesInPhysicalComputerSystem.mof
CISCO_LogicalModulesInComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalModulesInPhysicalComputerSy
stemProviderImpl")] class CISCO_LogicalModulesInPhysicalComputerSystem : CISCO_SystemDevice
{
[Aggregate, Override ( "GroupComponent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The parent system in the Association." )]
CISCO_PhysicalComputerSystem REF GroupComponent;
[Override ( "PartComponent" ),
Weak, Description (
"The LogicalDevice that is a component of a System." )]
CISCO_LogicalModule REF PartComponent;
};
CISCO_LogicalPortGroup.mof
CISCO_LogicalPortGroup
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalPortGroupProviderImpl")] class CISCO_LogicalPortGroup : CIM_LogicalPortGroup
{};
6-38
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_LogicalPortGroupInHostComputerSystem.mof
CISCO_LogicalPortGroupInHostComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalPortGroupInHostComputerSyst
emProviderImpl")] class CISCO_LogicalPortGroupInHostComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_HostComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_LogicalPortGroup REF Dependent;
};
CISCO_LogicalSwitchConformsToSwitchProfile.mof
[Association, Version ( "3.1.0" ), Description (
"The SMISConformsToProfile association defines the "
"RegisteredProfiles that are conformant with a specific "
"verision of SIM-S. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalSwitchConformsToSwitchProfi
leProviderImpl")
] class CISCO_LogicalSwitchConformsToSwitchProfile : CIM_ElementConformsToProfile {
[Key, Override ( "ConformantStandard" ), Min ( 1 ), Max ( 1 ),
Description (
"The RegisteredProfile to which the ManagedElement conforms.")]
CISCO_SwitchProfile REF ConformantStandard;
[Key, Override ( "ManagedElement" ), Min ( 1 ), Max ( 1 ),
Description (
"The ManagedElement that conforms to the RegisteredProfile.")]
CISCO_LogicalComputerSystem REF ManagedElement;
};
CISCO_LogicalSwitchElementCapabilities.mof
CISCO_LogicalSwitchElementCapabilities
[Association,
Description("ElementCapabilities represents the association between "
"ManagedElements and their Capabilities."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalSwitchElementCapabilitiesPr
oviderImpl")] class CISCO_LogicalSwitchElementCapabilities : CISCO_ElementCapabilities
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
Max ( 1 ),
Description ( "The managed element." )]
CISCO_LogicalComputerSystem REF ManagedElement;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-39
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Override ( "Capabilities" ), Key, Description (
"The Capabilities object associated with the element." )]
CISCO_FCLogicalSwitchCapabilities REF Capabilities;
};
CISCO_LogicalSwitchInstalledSoftwareIdentity.mof
CISCO_LogicalSwitchInstalledSoftwareIdentity
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalSwitchInstalledSoftwareIden
tityProviderImpl")] class CISCO_LogicalSwitchInstalledSoftwareIdentity : CISCO_InstalledSoftwareIdentity
{
[Override ( "System" ), Key, Description (
"The system on which the software is installed." )]
CISCO_LogicalComputerSystem REF System;
[Override ( "InstalledSoftware" ), Key, Description (
"The SoftwareIdentity that is installed." )]
CISCO_LogicalSwitchSoftwareIdentity REF InstalledSoftware;
};
CISCO_LogicalSwitchSettingData.mof
CISCO_LogicalSwitchSettingData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalSwitchSettingDataProviderIm
pl")] class CISCO_LogicalSwitchSettingData : CISCO_ElementSettingData
{
[Override ( "ManagedElement" ), Key,
Description ( "The managed element." )]
CISCO_LogicalComputerSystem REF ManagedElement;
[Override ( "SettingData" ), Key, Description (
"The SettingData object associated with the element." )]
CISCO_FCLogicalSwitchSettings REF SettingData;
};
CISCO_LogicalSwitchSoftwareIdentity.mof
CISCO_LogicalSwitchSoftwareIdentity
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalSwitchSoftwareIdentityProv
iderImpl")] class CISCO_LogicalSwitchSoftwareIdentity : CISCO_SoftwareIdentity
{};
CISCO_LogicalIdentity.mof
[Association,
6-40
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Description ("This association represents relation between the ServiceAccessPoints i.e. "
"two CISCO_ProtocolEndPoints of the NPV link."
"Basically it the connection between the "
"F port of the core NPIV to the F port of NPV which connects to the end devices"),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalIdentityProviderImpl")] class CISCO_LogicalIdentity : CIM_LogicalIdentity
{
[Override ( "SystemElement" ) ,
Description ("SystemElement represents one aspect of the Managed "
"Element. The use of \'System\' in the role name does not "
"limit the scope of the association. The role name was "
"defined in the original association, where the "
"referenced elements were limited to LogicalElements. "
"Since that time, it has been found valuable to "
"instantiate these types of relationships for "
"ManagedElements, such as Collections. So, the referenced "
"elements of the association were redefined to be "
"ManagedElements. Unfortunately, the role name could not "
"be changed without deprecating the entire association. "
"This was not deemed necessary just to correct the role "
"name." )]
CISCO_ProtocolEndPoint REF SystemElement;
[Override ( "SameElement" ),
Description ("SameElement represents an alternate aspect of the "
"ManagedElement.") ]
CISCO_ProtocolEndPoint REF SameElement;
};
CISCO_LogicalPortGroupInStorageComputerSystem.mof
// ==================================================================
// CISCO_LogicalPortGroupInStorageComputerSystem
// ==================================================================
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_LogicalPortGroupInStorageComputerS
ystemProviderImpl")] class CISCO_LogicalPortGroupInStorageComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_StorageComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_LogicalPortGroup REF Dependent;
};
CISCO_MediaFRU.mof
CISCO_MediaFRU
[Abstract,
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-41
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Indication,
Description ("This is an abstract indication class." )] class CISCO_MediaFRU : CISCO_AlertIndication
{
uint32 PhysicalIndex;
string PhysicalDescr;
uint32 PhysicalVendorType_len;
uint32 PhysicalContainedIn;
[
Description ("Entity Physical Class Type "),
ValueMap {"1", "2", "3","4" , "5", "6", "7", "8", "9","10", "11" } ,
Values {"ENT_OTHER","UNKNOWN_ENTITY", "CHASSIS", "BACKPLANE","CONTAINER",
"POWERSUPPLY", "FAN", "SENSOR", "MODULE", "PORT", "STACK"}
]
uint32 PhysicalClass;
uint32 PhysicalParRelPos;
string PhysicalName;
string PhysicalHardwareRev;
string PhysicalFirmwareRev;
string PhysicalSoftwareRev;
string PhysicalSerialNum;
string PhysicalMfgName;
string PhysicalModelName;
string PhysicalAlias;
string PhysicalAssetID;
boolean PhysicalIsFRU;
boolean Valid;
[
Description ( "Module Admin Status Status"),
ValueMap {"1", "2", "3","4"},
Values {"CEFC_PHYS_STATUS_OTHER ","CEFC_PHYS_STATUS_SUPPORTED",
"CEFC_PHYS_STATUS_UNSUPPORTED", "CEFC_PHYS_STATUS_INCOMPATIBLE"}
]
uint16 PhysicalStatus;
string PhySecondSerialNum;
string PhyProductNumber;
string PhyPartRevision;
string PhyMfgDate;
string PhysicalCLEICode;
uint16 PhySramSize;
string PhysicalNameofSlot;
};
CISCO_MediaFRUChanged.mof
CISCO_MediaFRUChanged
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_MediaFRUChangedProviderImpl")] class CISCO_MediaFRUChanged: CISCO_AlertIndication
{
uint32 PhysicalIndex;
[Description (
"Module Operational Status"),
ValueMap {"1", "2", "3", "4","5","6","7","8","9","10","11","12",
"13","14","15","16","17","18","19","20","21"},
Values {
"MOD_OPER_UNKNOWN","MOD_OPER_OK","MOD_OPER_DISABLED","MOD_OPER_OKBUTDIAGFAILED",
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-42
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"MOD_OPER_BOOT","MOD_OPER_SELFTEST", " MOD_OPER_FAILED", "MOD_OPER_MISSING",
"MOD_OPER_MISMATCHWITHPARENT", "MOD_OPER_MISMATCHCONFIG",
"MOD_OPER_DIAGFAILED",
"MOD_OPER_DORMANT" , " MOD_OPER_OUTOFSERVICEADMIN",
"MOD_OPER_OUTOFSERVICEENVTEMP",
"MOD_OPER_POWEREDDOWN", "MOD_OPER_POWEREDUP", " MOD_OPER_POWERDENIED",
"MOD_OPER_POWERCYCLED", "MD_OPER_OKBUTPOWEROVERWARNING","
MOD_OPER_OKBUTPOWEROVERCRITICAL",
"MOD_OPER_SYNCINPROGRESS" }
]
uint16 ModuleOperStatus;
[Description (
"Module Admin Status Status"),
ValueMap {"1", "2", "3","4"},
Values {"Admin Enabled","Admin Disabled", "Admin Reset", "Admin Out of Service"}
]
uint16 ModuleAdminStatus;
[Description (
"Module Admin Status Status"),
ValueMap {"1", "2", "3","4","5"},
Values {"UNKNOWN_RESET ","POWERUP", "PARITYERROR",
"CLEARCONFIGRESET","MANUALRESET"}
]
uint16 ModuleResetReason;
string ModuleResetReasonDescription;
uint32 numPorts;
uint32 boot_mode;
uint8 isValid;
uint8 mod_state;
uint8 mod_type;
uint8 pad[2];
uint32 mod_no;
uint32 ModuleUpTime;
uint32 numFcPorts;
};
CISCO_MediaFRUInserted.mof
CISCO_MediaFRUInserted
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_MediaFRUInsertedProviderImpl")] class CISCO_MediaFRUInserted : CISCO_MediaFRU
{};
CISCO_MediaFRURemoved.mof
CISCO_MediaFRURemoved
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_MediaFRURemovedProviderImpl")] class CISCO_MediaFRURemoved : CISCO_MediaFRU
{};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-43
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ModuleEthernetPort.mof
CISCO_ModuleEthernetPort
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ModuleEthernetPortProviderImpl")] class CISCO_ModuleEthernetPort : CISCO_ModulePort
{
[Aggregate, Override ( "GroupComponent" ),
Max ( 1 ),
Description ( "A module that has ports." )]
CISCO_LogicalModule REF GroupComponent;
[Override ( "PartComponent" ),
Description ( "A Port that is associated with a module." )]
CISCO_EthernetPort REF PartComponent;
};
CISCO_ModuleFcPort.mof
CISCO_ModuleFcPort
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ModuleFcPortProviderImpl")] class CISCO_ModuleFcPort : CISCO_ModulePort
{
[Aggregate, Override ( "GroupComponent" ),
Max ( 1 ),
Description ( "A module that has ports." )]
CISCO_LogicalModule REF GroupComponent;
[Override ( "PartComponent" ),
Description ( "A Port that is associated with a module." )]
CISCO_FCPort REF PartComponent;
};
CISCO_ModulePort.mof
CISCO_ModulePort
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ModulePort : CIM_ModulePort
{};
CISCO_NameServerDatabaseChanged.mof
CISCO_NameServerDatabaseChanged
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_NameServerDatabaseChangedProviderI
mpl")] class CISCO_NameServerDatabaseChanged: CISCO_AlertIndication
{
6-44
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
CISCO_PhysicalComputerSystem.mof
CISCO_PhysicalComputerSystem
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalComputerSystemProviderImp
l")] class CISCO_PhysicalComputerSystem : CISCO_ComputerSystem
{ string IpAddress;
};
CISCO_PhysicalComputerSystemsInAdminDomain.mof
CISCO_PhysicalComputerSystemsInAdminDomain
[Association,
Description (
"CISCO_PhysicalComputerSystemsInAdminDomain is a association between
CISCO_AdminDomain and "
"CISCO_PhysicalComputerSystem."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalComputerSystemsInAdminDoma
inProviderImpl")] class CISCO_PhysicalComputerSystemsInAdminDomain : CISCO_Component
{
[Override ("GroupComponent"), Key, Aggregate, Description (
"The parent element in the association." )]
CISCO_AdminDomain REF GroupComponent;
[Override("PartComponent"), Key, Description (
"The child element in the association." )]
CISCO_PhysicalComputerSystem REF PartComponent;
};
CISCO_PhysicalElement.mof
CISCO_PhysicalElement
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalElementProviderImpl")] class CISCO_PhysicalElement : CIM_PhysicalElement
{};
CISCO_PhysicalElementEthernetPortRealizes.mof
CISCO_PhysicalElementEthernetPortRealizes
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalElementEthernetPortRealize
sProviderImpl")] class CISCO_PhysicalElementEthernetPortRealizes : CISCO_Realizes
{
[Override ( "Antecedent" ),
Description (
"The physical component that implements the Device." )]
CISCO_PhysicalElement REF Antecedent;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-45
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Override ( "Dependent" ),
Description ( "The LogicalDevice." )]
CISCO_EthernetPort REF Dependent;
};
CISCO_PhysicalElementFcPortRealizes.mof
CISCO_PhysicalElementFcPortRealizes
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalElementFcPortRealizesProvi
derImpl")] class CISCO_PhysicalElementFcPortRealizes : CISCO_Realizes
{
[Override ( "Antecedent" ),
Description (
"The physical component that implements the Device." )]
CISCO_PhysicalElement REF Antecedent;
[Override ( "Dependent" ),
Description ( "The LogicalDevice." )]
CISCO_FCPort REF Dependent;
};
CISCO_PhysicalHBA.mof
CISCO_PhysicalHBA
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalHBAProviderImpl"),
Description ("This class represents FDMI enabled physical HBA card attached "
"to a switch" )] class CISCO_PhysicalHBA: CIM_PhysicalPackage {
[Override("Tag"), Key, MaxLen (256), Description (
"A unique physical identifier that serves as the key for "
"the HBA. The HBA serial number could be used as a tag.\n" )] string Tag;
[Override ( "ElementName" ),
MappingStrings { "MIB.IETF|Entity-MIB.entPhysicalName" }]
string ElementName;
[Override("CreationClassName"), Key, MaxLen (256), Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this "
"property allows all instances of this class and its "
"subclasses to be uniquely identified.")] string CreationClassName= "CISCO_PhysicalHBA";
[Override("Manufacturer"), MaxLen (256), Description (
"The name of the organization responsible for "
"manufacturing the HBA."),
MappingStrings {"FC-GS-4 | FDMI | Manufacturer"}] string Manufacturer;
[Override("Model"), MaxLen (64), Description (
"The name by which the HBA is generally known."),
MappingStrings {"FC-GS-4 | FDMI | Model"}]
6-46
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server string Model;
[Description (
"The detailed description of the model of the HBA. The "
"value might provide a more detailed identification of the "
"HBA than the Model property does."),
MaxLen (256),
MappingStrings {"FC-GS-4 | FDMI | Model Description"}] string ModelDescription;
[Override("SerialNumber"), MaxLen (64), Description (
"A manufacturer-allocated number used to identify the HBA. "
"This value SHOULD match a serial number engraved or "
"printed in the HBA."),
MappingStrings {"FC-GS-4 | FDMI | Serial Number"}] string SerialNumber;
} ;
[Override("Version"), MaxLen (64), Description (
"A string indicating the version of the HBA card."),
MappingStrings {"FC-GS-4 | FDMI | Version"}] string Version;
CISCO_PhysicalPackage.mof
CISCO_PhysicalPackage
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalPackageProviderImpl")] class CISCO_PhysicalPackage : CIM_PhysicalPackage
{};
CISCO_PhysicalPackageLogicalModuleRealizes.mof
CISCO_PhysicalPackageLogicalModuleRealizes
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PhysicalPackageLogicalModuleRealiz
esProviderImpl")] class CISCO_PhysicalPackageLogicalModuleRealizes : CISCO_Realizes
{
[Override ( "Antecedent" ),
Description (
"The physical component that implements the Device." )]
CISCO_PhysicalPackage REF Antecedent;
[Override ( "Dependent" ),
Description ( "The LogicalDevice." )]
CISCO_LogicalModule REF Dependent;
};
CISCO_Platform.mof
CISCO_Platform
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PlatformProviderImpl"),
Description ("CISCO_Platform represents a fabric-connected entity, "
"containing one or more Node objects, that has registered "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-47
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
6-48
"with a fabric's Management Server service."
"Instances of this class can be created and deleted by a "
"client using createInstance and deleteInstance respectively "
"This class also represents the HBA host and if the HBA host "
"information is got through FDMI call then the setInstance will "
"not be supported for setting the properties like Dedicated, "
"Management ServerList.")] class CISCO_Platform: CIM_ComputerSystem {
[Override ("CreationClassName"), Key, MaxLen (256),
Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this property "
"allows all instances of this class and its subclasses to "
"be uniquely identified.")] string CreationClassName= "CISCO_Platform";
[Override ("Name"), Key, MaxLen (256), Description (
"The inherited Name serves as key of the platform in an "
"enterprise environment. This value has the following "
"format:\n"
"\"Proxy WWN\":\"Platform Name\".")] string Name;
[Override ("ElementName"), Required, Description (
"A user-friendly name for the object. This property allows "
"each instance to define a user-friendly name IN ADDITION TO "
"its key properties/identity data, and description "
"information. \n"
"Note that ManagedSystemElement's Name property is also "
"defined as a user-friendly name. But, it is often "
"subclassed to be a Key. It is not reasonable that the same "
"property can convey both identity and a user friendly name, "
"without inconsistencies. Where Name exists and is not a Key "
"(such as for instances of LogicalDevice), the same "
"information MAY be present in both the Name and ElementName "
"properties.")] string ElementName;
[Override ( "NameFormat" ),Required, Description (
"The ComputerSystem object and its derivatives are Top Level "
"Objects of CIM. They provide the scope for numerous "
"components. Having unique System keys is required. The "
"NameFormat property identifies how the ComputerSystem Name "
"is generated. The NameFormat ValueMap qualifier defines the "
"various mechanisms for assigning the name. Note that "
"another name can be assigned and used for the "
"ComputerSystem that better suit a business, using the "
"inherited ElementName property."),
ValueMap { "Other", "IP", "Dial", "HID", "NWA", "HWA", "X25",
"ISDN", "IPX", "DCC", "ICD", "E.164", "SNA", "OID/OSI",
"WWN", "NAA" }] string NameFormat = "Other";
[Write, Override ("Dedicated"), Description(
"Platform type. Although this is represented as an array, "
"only one type is specified at any given time (array size is "
"always 1). When writing this property, users should "
"specify only a single type in an array size of exactly 1. "
"Specifying more or less than 1 type results in an exception "
"with an invalid argument error code."),
Values{"Unknown", "Others", "Gateway", "dummy3", "dummy4",
"Converter", "HBA", "Swproxy", "StorageDev", "Host",
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"Storsubsys", "Module", "Driver", "StorAccess"},
ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
"11", "12", "13"},
MappingStrings {"API.CISCO | Platform | PlatformType"}] uint16 Dedicated[];
[Override ("OtherIdentifyingInfo"), Description(
"Platform name: for example, host name."),
MappingStrings {"API.CISCO | Platform | PlatformName"}] string OtherIdentifyingInfo[];
};
[Write, Description(
"The set of management IP Addresses used to access this "
"platform."),
MappingStrings {"API.CISCO | Platform | ManagementAddrSet"}] string MgmtAddressList[];
CISCO_PlatformHostedSANAccessPoint.mof
CISCO_PlatformHostedSANAccessPoint
[Association,
Description ("CISCO_PlatformHostedSANAccessPoint is an association "
"between a ProtocolEndPoint and the platform on which it is "
"provided. The cardinality of this association is "
"one-to-many and is weak with respect to the platform. Each "
"platform can host many ProtocolEndPoints."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PlatformHostedSANAccessPointProvid
erImpl")] class CISCO_PlatformHostedSANAccessPoint: CIM_HostedAccessPoint {
[Override ("Antecedent"), Max (1), Min (1), Description (
"The hosting system.")]
CISCO_Platform REF Antecedent;
};
[Override ("Dependent"), Weak, Description (
"The SAPs that are hosted on this system.")]
CISCO_ProtocolEndPoint REF Dependent;
CISCO_PlatformPackage.mof
CISCO_PlatformPackage
[Association,
Description ("This association denotes one or more physical HBAs that "
"realize a Platform."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PlatformPackageProviderImpl")] class CISCO_PlatformPackage: CIM_ComputerSystemPackage {
[Override ("Antecedent"), Description (
"The physical HBA that realizes a Platform.")]
CISCO_PhysicalHBA REF Antecedent;
};
[Override ("Dependent"), Description (
"The Platform.")]
CISCO_Platform REF Dependent;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-49
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_PortAdded.mof
CISCO_PortAdded
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortAddedProviderImpl")] class CISCO_PortAdded: CIM_InstCreation
{};
CISCO_PortChannel.mof
CISCO_PortChannel
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortChannelProviderImpl")] class CISCO_PortChannel : CIM_RedundancySet
{
[Override("Caption"), Description (
"An user-friendly name of the port channel. ")] string Caption;
[Override("Description"), Description (
"An user-friendly name of the port channel. ")] string Description;
[Override("ElementName"), Description (
"An user-friendly name of the port channel. ")] string ElementName;
[Override("InstanceID"), Description (
"The ifIndex of port channel interface concatenated with number of members in that portchannel. (Eg: 67108866:1) ")] string InstanceID;
[Description ("CreationTime of the port channel interface.")] datetime CreationTime;
[Description ("The timestamp indicating the time of last action performed on the port channel interface.")] datetime LastActionTime; boolean LastActionStatus;
// [Description ("The minimum number of members required for PortChannel ")]
// uint32 MinNumberNeeded = 1;
// [Description ("The maximum number of members that can be part for PortChannel ")]
// uint32 MaxNumberSupported = 8;
[Description ("Vsan to which the port channel belongs to. It is zero, if the portchannel is trunked.")] uint16 VsanId; boolean isTrunked;
[Description ("If the addition was forced, it will be set to true.")] boolean ChannelAdditionForced;
[Description ("The number of interface that are part of the portchannel.")] uint32 NumberOfMembers;
[Description("Indicates the Admin Status of the port channel mode."),
ValueMap { "1", "2", "3", "4", "5"},
Values { "Auto", "On", "Off", "Desirable", "Active"}] uint16 AdminStatus;
[Description("Indicates the Operational Status of the port channel mode." ),
6-50
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
ValueMap { "1", "2", "3", "4", "5"},
Values { "Auto", "On", "Off", "Desirable", "Active"}] uint16 OperStatus;
};
[Description (
"Indicates the current status of the port channel."),
ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
"10", "11", "12", "13", "14", "15", "16", "17", "18"},
Values {"Unknown", "Other", "OK", "Degraded", "Stressed",
"Predictive Failure", "Error", "Non-Recoverable Error",
"Starting", "Stopping", "Stopped", "In Service",
"No Contact", "Lost Communication", "Aborted",
"Dormant", "Supporting Entity in Error", "Completed",
"Power Mode"},
ArrayType ("Indexed")] uint16 OperationalStatus[];
CISCO_PortChannelsInSwitch.mof
CISCO_PortChannelsInSwitch
[Association,
Description ("This corresponds to the association between
CISCO_PhysicalComputerSystem"
"and CISCO_PortChannel. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortChannelsInSwitchProviderImpl")
] class CISCO_PortChannelsInSwitch : CIM_HostedCollection
{
[Override ( "Antecedent" ), Description (
"The scoping system.")]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ), Description (
"The collection defined in the context of a system.")]
CISCO_PortChannel REF Dependent;
};
CISCO_PortController.mof
CISCO_PortController
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortControllerProviderImpl"),
Description("CISCO_PortController represents the port controller of an FDMI enabled HBA.")] class CISCO_PortController: CIM_PortController {
[Override("SystemCreationClassName"), Key, MaxLen (256), Description (
"The scoping system's creation class name. The "
"scoping system is the CISCO_Platform or "
"CISCO_Fabric of which this device is part.")] string SystemCreationClassName;
[Override("SystemName"), Key, MaxLen (256), Description (
"The scoping system's Name property. The value "
"is equivalent to the platform name if the scoping system is an "
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-51
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"instance of CISCO_Platform or the Proxy Switch WWN if the "
"scoping system is an instance of CISCO_Fabric.")] string SystemName;
[Override("CreationClassName"), Key, MaxLen (256),
Description (
"CreationClassName indicates the name of the CISCO_PortController "
"class that, when used with the other key properties of this "
"class, uniquely identifies an instance of the "
"CISCO_PortController class.")] string CreationClassName= "CISCO_PortController";
[Override("DeviceID"), Key, MaxLen (64), Description (
"This is the Serial Number of the HBA"),
MappingStrings {"API.CISCO | HBA | WWN",
"API.CISCO | Node | WWN"}] string DeviceID;
};
[Override("ControllerType"),Required,Description (
"The type or model of the port controller. Specific values "
"will be enumerated in a later release of this schema. When "
"set to 1 (\"Other\"), the related property "
"OtherControllerType contains a string description of the "
"controller's type."),
ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8" },
Values { "Unknown", "Other", "Ethernet", "IB", "FC", "FDDI",
"ATM", "Token Ring", "Frame Relay" },
ModelCorrespondence { "CIM_PortController.OtherControllerType" }] uint16 ControllerType = 4;
CISCO_PortControllerInFabric.mof
CISCO_PortControllerInFabric
[Association,
Description ("CISCO_PortControllerInFabric defines a SystemSpecificCollection "
"in the context of a scoping system. This association is "
"created ONLY if CISCO_PortController cannot be scoped within "
"CISCO_Platform. This can happen if the scoping platform "
"cannot be determined for some reason: for example, if it "
"was not registered in the platform database."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortControllerInFabricProviderImpl
")] class CISCO_PortControllerInFabric: CIM_SystemDevice {
[Override ("GroupComponent"), Description (
"A platform hosts a collection of devices.")]
CISCO_Vsan REF GroupComponent;
};
[Override ("PartComponent"), Description (
"The devices hosted on a platform.")]
CISCO_PortController REF PartComponent;
CISCO_PortControllerInPlatform.mof
CISCO_PortControllerInPlatform
6-52
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Association,
Description ("CISCO_PortControllerInPlatform defines a SystemSpecificCollection "
"in the context of a scoping system. The node registered "
"in the platform database must also be registered in the "
"Name Server."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortControllerInPlatformProviderIm
pl")] class CISCO_PortControllerInPlatform: CIM_SystemDevice {
[Override ("GroupComponent"), Description (
"A platform hosts a collection of devices."),
MappingStrings {"API.CISCO | Platform | PlatformNodeSet "}]
CISCO_Platform REF GroupComponent;
};
[Override ("PartComponent"), Description (
"The devices hosted on a platform.")]
CISCO_PortController REF PartComponent;
CISCO_PortControllerRealizes.mof
CISCO_PortControllerRealizes
[Association,
Description ("CISCO_PortControllerRealizes is the association that defines "
"the mapping between devices and the physical elements "
"that implement them."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortControllerRealizesProviderImpl
")] class CISCO_PortControllerRealizes: CIM_Realizes {
[Override ("Antecedent"), Description (
"The physical HBA that implements the Device.")]
CISCO_PhysicalHBA REF Antecedent;
};
[Override ("Dependent"), Description (
"The Device.")]
CISCO_PortController REF Dependent;
CISCO_PortControllerSoftwareIdentity.mof
CISCO_PortControllerSoftwareIdentity
[Association,
Description ("The PortControllerSoftwareIdentity relationship identifies any "
"software that is associated with the device and this association "
"can return multiple instances."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortControllerSoftwareIdentityProv
iderImpl")] class CISCO_PortControllerSoftwareIdentity: CIM_ElementSoftwareIdentity {
[Override ("Antecedent"), Description (
"The SoftwareIdentity on the device.")]
CISCO_HBASoftwareIdentity REF Antecedent;
[Override ("Dependent"), Description (
"The logical device that requires or uses the software.")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-53
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
CISCO_PortController REF Dependent;
CISCO_PortRemoved.mof
CISCO_PortRemoved
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PortRemovedProviderImpl")] class CISCO_PortRemoved: CIM_InstDeletion
{};
CISCO_PowerAlert.mof
CISCO_PowerAlert
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_PowerAlertProviderImpl")] class CISCO_PowerAlert: CISCO_EnvironmentalAlert
{
uint32 FRUPowerAdminStatus;
uint32 FRUCurrent;
};
CISCO_Product.mof
CISCO_Product
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProductProviderImpl")] class CISCO_Product : CIM_Product
{};
CISCO_ProductPhysicalComponent.mof
CISCO_ProductPhysicalComponent
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProductPhysicalComponentProviderIm
pl")] class CISCO_ProductPhysicalComponent : CIM_ProductPhysicalComponent
{
[Override ( "GroupComponent" ),
Max ( 1 ),
Description ( "The Product." )]
CISCO_Product REF GroupComponent;
[Override ( "PartComponent" ),
Description (
"The PhysicalElement which is a part of the Product." )]
CISCO_PhysicalElement REF PartComponent;
};
6-54
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ProductPhysicalHBA.mof
CISCO_ProductPhysicalHBA
[Association,
Description ("The HBA is shipped to the customer by a third party "
"(OEM/reseller) to the customer. This class associates "
"the HBA with the product."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProductPhysicalHBAProviderImpl")] class CISCO_ProductPhysicalHBA: CIM_ProductPhysicalComponent {
[Override ("GroupComponent"), Description (
"The product.")]
CISCO_HBAProduct REF GroupComponent;
};
[Override ("PartComponent"), Description (
"The HBA that is shipped as a product.")]
CISCO_PhysicalHBA REF PartComponent;
CISCO_ProductSoftwareComponent.mof
[Association, Version("3.1.0"),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_ProductSoftwareComponent : WBEMSolutions_ProductSoftwareComponent {
};
CISCO_ProtocolEndPoint.mof
CISCO_ProtocolEndPoint
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProtocolEndPointProviderImpl")] class CISCO_ProtocolEndPoint : CIM_ProtocolEndPoint
{};
CISCO_ProtocolEndPointHostComputerSystem.mof
CISCO_ProtocolEndPointHostComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProtocolEndPointHostComputerSystem
ProviderImpl")] class CISCO_ProtocolEndPointHostComputerSystem : CISCO_HostedAccessPoint
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_HostComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Weak, Description (
"The SAPs that are hosted on this System." )]
CISCO_ProtocolEndPoint REF Dependent;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-55
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
CISCO_ProtocolEndPointLogicalComputerSystem.mof
CISCO_ProtocolEndPointLogicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProtocolEndPointLogicalComputerSys
temProviderImpl")] class CISCO_ProtocolEndPointLogicalComputerSystem : CISCO_HostedAccessPoint
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_LogicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Weak, Description (
"The SAPs that are hosted on this System." )]
CISCO_ProtocolEndPoint REF Dependent;
};
CISCO_ProtocolEndPointStorageComputerSystem.mof
CISCO_ProtocolEndPointStorageComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ProtocolEndPointStorageComputerSys
temProviderImpl")] class CISCO_ProtocolEndPointStorageComputerSystem : CISCO_HostedAccessPoint
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_StorageComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Weak, Description (
"The SAPs that are hosted on this System." )]
CISCO_ProtocolEndPoint REF Dependent;
};
CISCO_Realizes.mof
CISCO_Realizes
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_Realizes : CIM_Realizes
{};
6-56
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ReferencedProfile.mof
[Association, Version ( "2.6.0" ), Description (
"A subprofile requires another RegisteredProfile for context. "
"This association mandates the scoping relationship between a "
"subprofile and its scoping profile."),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_ReferencedProfile : WBEMSolutions_ReferencedProfile {
[Override ( "Antecedent" ), Min ( 1 ), Description (
"The RegisteredProfile that is referenced/required by the "
"subprofile.")]
CISCO_RegisteredProfile REF Antecedent;
[Override ( "Dependent" ), Description (
"A RegisteredSubProfile that requires a scoping profile, for "
"context.")]
CISCO_RegisteredSubProfile REF Dependent;
};
CISCO_RegisteredProfile.mof
[Version ( "3.1.0" ), Description (
"A RegisteredProfile describes a set of CIM Schema classes with "
"required properties and/or methods, necessary to manage a "
"real-world entity or to support a usage scenario, in an "
"interoperable fashion. RegisteredProfiles can be defined by "
"the DMTF or other standards organizations. Note that this "
"class should not be confused with CIM_Profile, which collects "
"SettingData instances, to be applied as a 'configuration "
"profile' for an element. \n"
"A RegisteredProfile is a named 'standard' for CIM-based "
"management of a particular System, subsystem, Service or other "
"entity, for a specified set of uses. It is a complete, "
"standalone definition, as opposed to the subclass "
"RegisteredSubProfile, which requires a scoping profile for "
"context. \n"
"The uses for a RegisteredProfile or SubProfile MUST be "
"specified in the document that defines the profile. Examples "
"of Profiles are to manage various aspects of an Operating "
"System, Storage Array, or Database. The name of the profile is "
"defined and scoped by its authoring organization."),
//Provider("jsr48:com.wbemsolutions.wbem.cimom."
// "GenericReadOnlyProvider")
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_RegisteredProfileProviderImpl")
] class CISCO_RegisteredProfile : WBEMSolutions_RegisteredProfile {
};
CISCO_RegisteredProfileInstances.mof
instance of CISCO_RegisteredProfile as $DMTF100_PRP {
InstanceID = "CISCO:CISCO_RegisteredProfile.2.Profile Registration.1.0.0";
RegisteredOrganization = 2;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-57
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
RegisteredName = "Profile Registration";
RegisteredVersion = "1.0.0";
AdvertiseTypes = {3};
Caption = "2:Profile Registration:1.0.0";
Description = "2:Profile Registration:1.0.0";
ElementName = "2:Profile Registration:1.0.0";
}; instance of CISCO_ServerSoftware as $software {
InstanceID = "CISCO:CISCO_ServerSoftware-CISCO SMI-S Agent";
MajorVersion = "1";
MinorVersion = "1";
RevisionNumber = "0";
VersionString = "1.1.0";
Manufacturer = "Cisco Systems";
SerialNumber = "CISCO SMI-S Agent" " " "1.1.0";
Caption = "CISCO SMI-S Agent";
Description = "CISCO SMI-S Agent";
ElementName = "CISCO SMI-S Agent";
Name = "CISCO SMI-S Agent";
Classifications = {5};
}; instance of CISCO_ElementSoftwareIdentity {
Antecedent = $software;
Dependent = $DMTF100_PRP;
}; instance of CISCO_RegisteredSubProfile as $SMIS100_PRP {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Profile Registration.1.0.0";
RegisteredOrganization = 11;
RegisteredName = "Profile Registration";
RegisteredVersion = "1.0.0";
AdvertiseTypes = {2};
Caption = "11:Profile Registration:1.0.0";
Description = "11:Profile Registration:1.0.0";
ElementName = "11:Profile Registration:1.0.0";
};
//The following instance reference the SNIA PRP to the DMTF PRP instance of CISCO_ReferencedProfile {
Antecedent = $DMTF100_PRP;
Dependent = $SMIS100_PRP;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMIS100_PRP;
}; instance of WBEMSolutions_RegisteredProfile as $SMIS140 {
InstanceID = "WBEMSolutions:WBEMSolutions_RegisteredProfile.11.SMI-S.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "SMI-S";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {3};
Caption = "SMI-S";
Description = "SMI-S";
ElementName = "SMI-S";
};
6-58
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server instance of CISCO_ServerProduct as $product {
Name = "CISCO SMI-S Agent";
IdentifyingNumber = "CISCO SMI-S Agent 1.1.0";
Vendor = "Cisco Systems";
Version = "1.1.0";
Caption = "CISCO SMI-S Agent";
Description = "CISCO SMI-S Agent";
ElementName = "CISCO SMI-S Agent";
SKUNumber = "CISCO SMI-S Agent";
}; instance of WBEMSolutions_ProductSoftwareComponent {
GroupComponent = $product;
PartComponent = $software;
}; instance of CISCO_FabricProfile as $SMI140_Fabric {
InstanceID = "CISCO:CISCO_RegisteredProfile.11.Fabric.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Fabric";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {3};
Caption = "11:Fabric:1.4.0";
Description = "11:Fabric:1.4.0";
ElementName = "11:Fabric:1.4.0";
}; instance of CISCO_RegisteredSubProfile as $SMI140_Fabric_ZoneControl {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Zone Control.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Zone Control";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:ZoneControl:1.4.0";
Description = "11:ZoneControl:1.4.0";
ElementName = "11:ZoneControl:1.4.0";
}; instance of CISCO_RegisteredSubProfile as $SMI140_Fabric_EnhancedZoneControl {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Enhanced Zoning and Enhanced Zoning
Control.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Enhanced Zoning and Enhanced Zoning Control";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:Enhanced Zoning and Enhanced Zoning Control:1.4.0";
Description = "11:Enhanced Zoning and Enhanced Zoning Control:1.4.0";
ElementName = "11:Enhanced Zoning and Enhanced Zoning Control:1.4.0";
}; instance of CISCO_RegisteredSubProfile as $SMI140_Fabric_FDMI {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.FDMI.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "FDMI";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:FDMI:1.4.0";
Description = "11:FDMI:1.4.0";
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-59
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
ElementName = "11:FDMI:1.4.0";
}; instance of CISCO_RegisteredSubProfile as $SMI140_Fabric_VirtualFabrics {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Virtual Fabrics.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Virtual Fabrics";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:Virtual Fabrics:1.4.0";
Description = "11:Virtual Fabrics:1.4.0";
ElementName = "11:Virtual Fabrics:1.4.0";
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $DMTF100_PRP;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMIS100_PRP;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Fabric;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Fabric_ZoneControl;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Fabric_EnhancedZoneControl;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Fabric_FDMI;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Fabric_VirtualFabrics;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Fabric;
Dependent = $SMIS100_PRP;
}; instance of CISCO_SubProfileRequiresProfile {
6-60
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Antecedent = $SMI140_Fabric;
Dependent = $SMI140_Fabric_ZoneControl;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Fabric;
Dependent = $SMI140_Fabric_FDMI;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Fabric;
Dependent = $SMI140_Fabric_EnhancedZoneControl;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Fabric;
Dependent = $SMI140_Fabric_VirtualFabrics;
}; instance of CISCO_ElementSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Fabric;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Fabric_FDMI;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Fabric_ZoneControl;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Fabric_EnhancedZoneControl;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Fabric_VirtualFabrics;
}; instance of CISCO_SwitchProfile as $SMI140_Switch {
InstanceID = "CISCO:CISCO_RegisteredProfile.11.Switch.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Switch";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {3};
Caption = "11:Switch:1.4.0";
Description = "11:Switch:1.4.0";
ElementName = "11:Switch:1.4.0";
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-61
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
6-62 instance of CISCO_RegisteredSubProfile as $SMI140_Switch_SwitchPartitioning {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Switch Partitioning.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Switch Partitioning";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:SwitchPartitioning:1.4.0";
Description = "11:SwitchPartitioning:1.4.0";
ElementName = "11:SwitchPartitioning:1.4.0";
}; instance of CISCO_RegisteredSubProfile as $SMI140_Switch_Blades {
InstanceID = "CISCO:CISCO_RegisteredSubProfile.11.Blades.1.4.0";
RegisteredOrganization = 11;
RegisteredName = "Blades";
RegisteredVersion = "1.4.0";
AdvertiseTypes = {2};
Caption = "11:Blades:1.4.0";
Description = "11:Blades:1.4.0";
ElementName = "11:Blades:1.4.0";
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Switch;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Switch_Blades;
}; instance of WBEMSolutions_SMISConformsToProfile {
ConformantStandard = $SMIS140;
ManagedElement = $SMI140_Switch_SwitchPartitioning;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Switch;
Dependent = $SMIS100_PRP;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Switch;
Dependent = $SMI140_Switch_Blades;
}; instance of CISCO_SubProfileRequiresProfile {
Antecedent = $SMI140_Switch;
Dependent = $SMI140_Switch_SwitchPartitioning;
}; instance of CISCO_ElementSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Switch;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Switch_Blades;
}; instance of CISCO_SubProfileSoftwareIdentity {
Antecedent = $software;
Dependent = $SMI140_Switch_SwitchPartitioning;
};
CISCO_RegisteredSubProfile.mof
[Version ( "3.1.0" ), Description (
"A RegisteredSubProfile subclasses RegisteredProfile to "
"indicate that a scoping profile is required to provide "
"context. The latter is specified by the mandatory association, "
"SubProfileRequiresProfile."),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_RegisteredSubProfile : WBEMSolutions_RegisteredSubProfile {
};
CISCO_RemoteFCIPPort.mof
CISCO_RemoteFCIPPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_RemoteFCIPPortProviderImpl")] class CISCO_RemoteFCIPPort : CIM_RemotePort
{};
CISCO_RemoteIPServiceAccessPoint.mof
CISCO_RemoteIPServiceAccessPoint
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_RemoteIPServiceAccessPointProvide
rImpl")] class CISCO_RemoteIPServiceAccessPoint: CIM_RemoteServiceAccessPoint
{};
CISCO_RemoteServiceAccessPoint.mof
CISCO_RemoteServiceAccessPoint
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_RemoteServiceAccessPointProviderI
mpl")] class CISCO_RemoteServiceAccessPoint : CIM_RemoteServiceAccessPoint
{};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-63
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_RemoteTCPPort.mof
CISCO_RemoteTCPPort
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_RemoteTCPPortProviderImpl")] class CISCO_RemoteTCPPort : CIM_RemotePort
{};
CISCO_SANFCIPEndpoint.mof
CISCO_SANFCIPEndpoint
[Association,
Description ("This corresponds to the association between
CISCO_FCIPProtocolEndpoint "
"and CISCO_ProtocolEndPoint. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SANFCIPEndpointProviderImpl")] class CISCO_SANFCIPEndpoint : CIM_BindsTo {
[Override ("Antecedent"), Description (
"The underlying SANEndpoint, which is depended upon.")]
CISCO_FCIPProtocolEndPoint REF Antecedent;
};
[Override ( "Dependent" ), Description (
"The FCIP ProtocolEndpoint dependent on the SANEndpoint.")]
CISCO_RemoteFCIPPort REF Dependent;
CISCO_SANIPEndpoint.mof
CISCO_SANIPEndpoint
[Association,
Description ("This corresponds to the association between CISCO_IPProtocolEndpoint
"
"and CISCO_RemoteFCIPServiceAccessPoint. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SANIPEndpointProviderImpl")] class CISCO_SANIPEndpoint : CIM_BindsTo {
[Override ("Antecedent"), Description (
"The underlying SANEndpoint, which is depended upon.")]
CISCO_IPProtocolEndpoint REF Antecedent ;
[Override ( "Dependent" ), Description (
"The FCIP ProtocolEndpoint dependent on the SANEndpoint.")]
CISCO_RemoteIPServiceAccessPoint REF Dependent;
};
CISCO_SANTCPEndpoint.mof
CISCO_SANTCPEndpoint
[Association,
6-64
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Description ("This corresponds to the association between CISCO_IPProtocolEndpoint
"
"and CISCO_TCPProtocolEndPoint. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SANTCPEndpointProviderImpl")] class CISCO_SANTCPEndpoint : CIM_BindsTo {
[Override ( "Antecedent" ), Description (
"The underlying IP Endpoint, which is depended upon.")]
CISCO_TCPProtocolEndpoint REF Antecedent;
[Override ( "Dependent" ), Description (
"The TCP ProtocolEndpoint dependent on the IP Endpoint.")]
CISCO_RemoteTCPPort REF Dependent;
};
CISCO_SAPAvailableForElement.mof
CISCO_SAPAvailableForElement
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SAPAvailableForElementProviderImpl
")] class CISCO_SAPAvailableForElement : CIM_SAPAvailableForElement
{
[Override ("AvailableSAP"), Key, Description (
"The Service Access Point that is available." )]
CISCO_RemoteServiceAccessPoint REF AvailableSAP;
[Override ("ManagedElement"), Key, Description (
"The ManagedElement for which the SAP is available." )]
CISCO_PhysicalComputerSystem REF ManagedElement;
};
CISCO_SecurityAlert.mof
CISCO_SecurityAlert
[Abstract,
Indication,
Description ("This is an abstract indication class." )] class CISCO_SecurityAlert : CISCO_AlertIndication
{};
CISCO_ServerProduct.mof
[Version("3.1.0"),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_ServerProduct : WBEMSolutions_WBEMServerProduct {
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-65
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ServerSoftware.mof
[Version("3.1.0"), Description("WBEM Server Software"),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_ServerSoftware : WBEMSolutions_WBEMServerSoftware {
};
CISCO_SoftwareIdentity.mof
CISCO_SoftwareIdentity
[Abstract,
Description ("This is an abstract class." )] class CISCO_SoftwareIdentity : CIM_SoftwareIdentity
{};
CISCO_StatisticsCollection.mof
CISCO_StatisticsCollection
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StatisticsCollectionProviderImpl"
)] class CISCO_StatisticsCollection : CIM_StatisticsCollection
{};
CISCO_StatisticsHostedCollection.mof
CISCO_StatisticsHostedCollection
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StatisticsHostedCollectionProvider
Impl")] class CISCO_StatisticsHostedCollection : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_StatisticsCollection REF Dependent;
};
CISCO_StatisticsHostedCollectionInComputerSystem.mof
CISCO_StatisticsHostedCollectionInComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StatisticsHostedCollectionInComput
erSystemProviderImpl")]
6-66
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server class CISCO_StatisticsHostedCollectionInComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_StatisticsHostedCollection REF Dependent;
};
CISCO_StatisticsMemberOfCollection.mof
CISCO_StatisticsMemberOfCollection
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StatisticsMemberOfCollectionProvid
erImpl")] class CISCO_StatisticsMemberOfCollection : CIM_MemberOfCollection
{
[Override ("Collection"), Key, Aggregate, Description (
"The Collection that aggregates members." )]
CISCO_StatisticsCollection REF Collection;
[Override ("Member"), Key, Description (
"The aggregated member of the Collection." )]
CISCO_FCPortStatistics REF Member;
};
CISCO_StorageComputerSystem.mof
CISCO_StorageComputerSystem
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StorageComputerSystemProviderImpl
")] class CISCO_StorageComputerSystem : CISCO_ComputerSystem
{
String IpAddress;
};
CISCO_StorageComputerSystemsInAdminDomain.mof
CISCO_StorageComputerSystemsInAdminDomain
[Association,
Description (
"CISCO_StorageComputerSystemsInAdminDomain is a association between
CISCO_AdminDomain and "
"CISCO_StorageComputerSystem."),
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-67
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_StorageComputerSystemsInAdminDomai
nProviderImpl")] class CISCO_StorageComputerSystemsInAdminDomain : CISCO_Component
{
[Override ("GroupComponent"), Key, Aggregate, Description (
"The parent element in the association." )]
CISCO_AdminDomain REF GroupComponent;
[Override("PartComponent"), Key, Description (
"The child element in the association." )]
CISCO_StorageComputerSystem REF PartComponent;
};
CISCO_SubProfileRequiresProfile.mof
[Association, Version ( "3.1.0" ), Description (
"A subprofile requires another RegisteredProfile for context. "
"This association mandates the scoping relationship between a "
"subprofile and its scoping profile.\n"
"Note that this is only used for SMI profiles. Newer profiles"
"do not have the concept of sub profiles."),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_SubProfileRequiresProfile : WBEMSolutions_SubProfileRequiresProfile {
[Override ( "Antecedent" ), Min ( 1 ), Description (
"The RegisteredProfile that is referenced/required by the "
"subprofile.")]
CISCO_RegisteredProfile REF Antecedent;
[Override ( "Dependent" ), Description (
"A RegisteredSubProfile that requires a scoping profile, for "
"context.")]
CISCO_RegisteredSubProfile REF Dependent;
};
CISCO_SubProfileSoftwareIdentity.mof
[Association, Version("3.1.0"),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_SubProfileSoftwareIdentity : WBEMSolutions_SubProfileSoftwareIdentity {
[Override ( "Antecedent" ), Description (
"A LogicalElement's Software Asset.")]
CISCO_ServerSoftware REF Antecedent;
[Override ( "Dependent" ), Description (
"The ManagedElement that requires or uses the software.")]
CISCO_RegisteredSubProfile REF Dependent;
};
6-68
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_SwitchAdded.mof
CISCO_SwitchAdded
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchAddedProviderImpl")] class CISCO_SwitchAdded: CIM_InstCreation
{};
CISCO_SwitchConformsToFabricProfile.mof
[Association, Version ( "3.1.0" ), Description (
"The SMISConformsToProfile association defines the "
"RegisteredProfiles that are conformant with a specific "
"verision of SIM-S. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchConformsToFabricProfileProvi
derImpl")
] class CISCO_SwitchConformsToFabricProfile : CIM_ElementConformsToProfile {
[Key, Override ( "ConformantStandard" ), Min ( 1 ), Max ( 1 ),
Description (
"The RegisteredProfile to which the ManagedElement conforms.")]
CISCO_FabricProfile REF ConformantStandard;
[Key, Override ( "ManagedElement" ), Min ( 1 ), Max ( 1 ),
Description (
"The ManagedElement that conforms to the RegisteredProfile.")]
CISCO_LogicalComputerSystem REF ManagedElement;
};
CISCO_SwitchConformsToSwitchProfile.mof
[Association, Version ( "3.1.0" ), Description (
"The SMISConformsToProfile association defines the "
"RegisteredProfiles that are conformant with a specific "
"verision of SIM-S. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchConformsToSwitchProfileProvi
derImpl")
] class CISCO_SwitchConformsToSwitchProfile : CIM_ElementConformsToProfile {
[Key, Override ( "ConformantStandard" ), Min ( 1 ), Max ( 1 ),
Description (
"The RegisteredProfile to which the ManagedElement conforms.")]
CISCO_SwitchProfile REF ConformantStandard;
[Key, Override ( "ManagedElement" ), Min ( 1 ), Max ( 1 ),
Description (
"The ManagedElement that conforms to the RegisteredProfile.")]
CISCO_PhysicalComputerSystem REF ManagedElement;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-69
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_SwitchElementCapabilities.mof
CISCO_SwitchElementCapabilities
[Association,
Description("ElementCapabilities represents the association between "
"ManagedElements and their Capabilities."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchElementCapabilitiesProviderI
mpl")] class CISCO_SwitchElementCapabilities : CISCO_ElementCapabilities
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
Max ( 1 ),
Description ( "The managed element." )]
CISCO_PhysicalComputerSystem REF ManagedElement;
[Override ( "Capabilities" ), Key, Description (
"The Capabilities object associated with the element." )]
CISCO_FCSwitchCapabilities REF Capabilities;
};
CISCO_SwitchHostedFCIPAccessPoint.mof
CISCO_SwitchHostedFCIPAccessPoint
[Association,
Description (
"CISCO_SwitchHostedFCIPAccessPoint is an association between an "
"FCIP protocol endpoint and the switch on which it is provided. "
"The cardinality of this association is one-to-many and is "
"weak with respect to the switch. Each switch can host many "
"FCIP protocol endpoints."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchHostedFCIPAccessPointProvide
rImpl")] class CISCO_SwitchHostedFCIPAccessPoint: CIM_HostedAccessPoint {
[Override ("Antecedent"), Max (1), Min (1), Description (
"The hosting system.")]
CISCO_LogicalComputerSystem REF Antecedent;
};
[Override ("Dependent"), Weak, Description (
"The SAPs that are hosted on this system.")]
CISCO_FCIPProtocolEndPoint REF Dependent;
CISCO_SwitchHostedIPAccessPoint.mof
CISCO_SwitchHostedIPAccessPoint
[Association,
Description (
"CISCO_SwitchHostedIPAccessPoint is an association between an"
"IP protocol endpoint and the switch on which it is provided. "
"The cardinality of this association is one-to-many and is "
"weak with respect to the switch. Each switch can host many "
"IP protocol endpoints."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchHostedIPAccessPointProviderI
mpl")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-70
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server class CISCO_SwitchHostedIPAccessPoint: CIM_HostedAccessPoint {
[Override ("Antecedent"), Max (1), Min (1), Description (
"The hosting system.")]
CISCO_LogicalComputerSystem REF Antecedent;
};
[Override ("Dependent"), Weak, Description (
"The SAPs that are hosted on this system.")]
CISCO_IPProtocolEndPoint REF Dependent;
CISCO_SwitchHostedTCPAccessPoint.mof
CISCO_SwitchHostedTCPAccessPoint
[Association,
Description (
"CISCO_SwitchHostedTCPAccessPoint is an association between a"
"TCP protocol endpoint and the switch on which it is provided. "
"The cardinality of this association is one-to-many and is "
"weak with respect to the switch. Each switch can host many "
"TCP protocol endpoints."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchHostedTCPAccessPointProvider
Impl")] class CISCO_SwitchHostedTCPAccessPoint: CIM_HostedAccessPoint {
[Override ("Antecedent"), Max (1), Min (1), Description (
"The hosting system.")]
CISCO_LogicalComputerSystem REF Antecedent;
};
[Override ("Dependent"), Weak, Description (
"The SAPs that are hosted on this system.")]
CISCO_TCPProtocolEndPoint REF Dependent;
CISCO_SwitchInstalledSoftwareIdentity.mof
CISCO_SwitchInstalledSoftwareIdentity
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchInstalledSoftwareIdentityPro
viderImpl")] class CISCO_SwitchInstalledSoftwareIdentity : CISCO_InstalledSoftwareIdentity
{
[Override ( "System" ), Key, Description (
"The system on which the software is installed." )]
CISCO_PhysicalComputerSystem REF System;
[Override ( "InstalledSoftware" ), Key, Description (
"The SoftwareIdentity that is installed." )]
CISCO_SwitchSoftwareIdentity REF InstalledSoftware;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-71
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_SwitchProfile.mof
[Version ( "3.1.0" ), Description (
"A RegisteredProfile describes a set of CIM Schema classes with "
"required properties and/or methods, necessary to manage a "
"real-world entity or to support a usage scenario, in an "
"interoperable fashion. RegisteredProfiles can be defined by "
"the DMTF or other standards organizations. Note that this "
"class should not be confused with CIM_Profile, which collects "
"SettingData instances, to be applied as a 'configuration "
"profile' for an element. \n"
"A RegisteredProfile is a named 'standard' for CIM-based "
"management of a particular System, subsystem, Service or other "
"entity, for a specified set of uses. It is a complete, "
"standalone definition, as opposed to the subclass "
"RegisteredSubProfile, which requires a scoping profile for "
"context. \n"
"The uses for a RegisteredProfile or SubProfile MUST be "
"specified in the document that defines the profile. Examples "
"of Profiles are to manage various aspects of an Operating "
"System, Storage Array, or Database. The name of the profile is "
"defined and scoped by its authoring organization."),
Provider("jsr48:com.wbemsolutions.wbem.cimom."
"GenericReadOnlyProvider")
] class CISCO_SwitchProfile : CISCO_RegisteredProfile {
};
CISCO_SwitchRemoved.mof
CISCO_SwitchRemoved
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchRemovedProviderImpl")] class CISCO_SwitchRemoved: CIM_InstDeletion
{};
CISCO_SwitchSettingData.mof
CISCO_SwitchSettingData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchSettingDataProviderImpl")] class CISCO_SwitchSettingData : CISCO_ElementSettingData
{
[Override ( "ManagedElement" ), Key,
Description ( "The managed element." )]
CISCO_PhysicalComputerSystem REF ManagedElement;
[Override ( "SettingData" ), Key, Description (
"The SettingData object associated with the element." )]
CISCO_FCSwitchSettings REF SettingData;
};
6-72
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_SwitchSoftwareIdentity.mof
CISCO_SwitchSoftwareIdentity
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_SwitchSoftwareIdentityProviderImp
l")] class CISCO_SwitchSoftwareIdentity : CISCO_SoftwareIdentity
{};
CISCO_SystemDevice.mof
CISCO_SystemDevice
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_SystemDevice : CIM_SystemDevice
{};
CISCO_TCPElementSettingData.mof
CISCO_TCPElementSettingData
[Association,
Description ("This corresponds to the association between CISCO_IPProtocolEndpoint
"
"and CISCO_IPSettings. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPElementSettingDataProviderImpl"
)] class CISCO_TCPElementSettingData : CIM_ElementSettingData
{
[Override ("ManagedElement"), Description (
"Reference to CISCO_IPProtocolEndpoint instance.")]
CISCO_TCPProtocolEndpoint REF ManagedElement;
[Override ("SettingData"), Description (
"Reference to CISCO_FCIPSettings instance.")]
CISCO_TCPSettings REF SettingData;
};
CISCO_TCPEndPointStatisticalData.mof
CISCO_TCPEndPointStatisticalData
[Association,
Description ("CISCO_IPEndPointStatistics is an association that associates "
"CISCO_IPProtocolEndPoint to its StatisticalData "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPEndPointStatisticalDataProvider
Impl")] class CISCO_TCPEndPointStatisticalData : CIM_ElementStatisticalData {
[Override ("ManagedElement"), Description (
"Reference to CISCO_IPProtocolEndpoint instance.")]
CISCO_TCPProtocolEndPoint REF ManagedElement;
[Override("Stats"), Key, Description (
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-73
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"The statistic information.")]
CISCO_TCPEndPointStatistics REF Stats;
};
CISCO_TCPEndPointStatistics.mof
CISCO_TCPEndPointStatistics
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPEndPointStatisticsProviderImpl
")] class CISCO_TCPEndPointStatistics : CIM_TCPEndpointStatistics
{
[Description ("The TCP Keep alive timeout for all links within this entity.")] uint32 KeepAliveTimeOut;
[Description ("The Maximum number of times that the same item of data"
"will be retransmitted over a TCP connection. If delivery"
"is not acknowledged after this number of retransmissions"
" then the TCP connection is terminated. ")] uint32 MaxReTransmission;
[Description (
"The path MTU discovery is enabled if the value of this object is true(1), else it is disabled, and"
"has the value false(2). "
)] boolean PathMTU;
[Description (
"The time interval for which the discovered pathMTU is valid, before MSS reverts back to the negotiated"
"TCP value. This object is writeble only if"
"cfmFcipEntityExtPMTUEnable is 'true'. "
)] uint32 PathMTUResetTimeOut;
[Description(
"The TCP minimum retransmit timeout for all the links on"
"this entity. "
)] uint32 MinimumRTO;
[Description (
"The aggregate TCP send window for all TCP connections on all"
" Links within this entity. This value is used for Egress"
"Flow Control. When the aggregate of the data queued"
"on all connections within this entity reaches this value,"
" the sender is flow controlled. "
)] uint32 SendBufSize ;
[Description (
"This is an estimate of the Bandwidth of the network pipe used for the B-D product computation,which lets decide"
"the TCP receive window to advertise."
"The cfmFcipEntityExtTcpMaxBW,cfmFcipEntityExtTcpMinAvailBW,"
"cfmFcipEntityExtTcpRndTrpTimeEst must be set in the same"
"SNMP set request. SET operation would fail if this object"
"is set individually."
)] uint32 TcpMaxBW;
6-74
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Description (
"The minimum available bandwidth for the TCP connections"
" on the Links within this entity."
" The cfmFcipEntityExtTcpMaxBW,cfmFcipEntityExtTcpMinAvailBW,"
" cfmFcipEntityExtTcpRndTrpTimeEst must be set in the same"
" SNMP set request. SET operation would fail if this object"
" is set individually. "
)] uint32 TcpMinAvailBW;
[Description (
"This is an estimate of the round trip delay of the network"
" pipe used for the B-D product computation, which lets us"
" derive the TCP receive window to advertise."
" The cfmFcipEntityExtTcpMaxBW,cfmFcipEntityExtTcpMinAvailBW,"
" cfmFcipEntityExtTcpRndTrpTimeEst must be set in the same"
" SNMP set request. SET operation would fail if this object"
" is set individually. microseconds "
)] uint32 TcpRndTrpTimeEst;
[Description (
"This object is used for enabling/disabling the congestion"
"window monitoring. If the value of this object is true(1),"
" it is enabled. It is disabled if the value is false(2). "
)] boolean ExtCWMEnable=true;
[Description (
"The maximum burst sent after a tcp sender idle period. This object is writeble only if"
" cfmFcipEntityExtCWMEnable is 'true'. kilobytes"
)] uint32 CWMBurstSize;
[Description (
"The maximum delay variation that is not due to"
" congestion that can be experienced by TCP"
" connections for all links on this enti ty in milliseconds."
)] uint32 MaxJitter;
};
CISCO_TCPIPEndpoint.mof
CISCO_TCPIPEndpoint
[Association,
Description ("This corresponds to the association between CISCO_IPProtocolEndpoint
"
"and CISCO_TCPProtocolEndPoint. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPIPEndpointProviderImpl")] class CISCO_TCPIPEndpoint : CIM_BindsTo {
[Override ( "Antecedent" ), Description (
"The underlying IP Endpoint, which is depended upon.")]
CISCO_IPProtocolEndpoint REF Antecedent;
[Override ( "Dependent" ), Description (
"The TCP ProtocolEndpoint dependent on the IP Endpoint.")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-75
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
};
CISCO_TCPProtocolEndPoint REF Dependent;
CISCO_TCPProtocolEndpoint.mof
CISCO_TCPProtocolEndpoint
[Description ("A protocol endpoint that is dedicated to running TCP. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPProtocolEndPointProviderImpl")] class CISCO_TCPProtocolEndPoint: CIM_TCPProtocolEndPoint {
[Override("SystemCreationClassName"), Key, Propagated("CIM_System.CreationClassName"),
Description ("The scoping System's CreationClassName."),
MaxLen ( 256 )] string SystemCreationClassName;
[Override("SystemName"), Key, Propagated("CIM_System.Name"),
Description ("The scoping System's Name."),
MaxLen ( 256 )] string SystemName;
[Override("CreationClassName"), Key, Description (
"CreationClassName indicates the name of the class or the "
"subclass used in the creation of an instance. When used "
"with the other key properties of this class, this property "
"allows all instances of this class and its subclasses to be "
"uniquely identified."),
MaxLen ( 256 )] string CreationClassName;
[Override("Name"), Key, Description (
"A string that identifies this ProtocolEndpoint with either "
"a port or an interface on a device. To ensure uniqueness, "
"the Name property should be prepended or appended with "
"information from the Type or OtherTypeDescription "
"properties. The method selected is described in the "
"NameFormat property of this class."),
MaxLen ( 256 )] string Name;
[Override("NameFormat"), Description (
"NameFormat contains the naming heuristic that is chosen to "
"ensure that the value of the Name property is unique. For "
"example, one might choose to prepend the name of the port "
"or interface with the Type of ProtocolEndpoint that this "
"instance is (e.g., IPv4) followed by an underscore."),
MaxLen ( 256 )] string NameFormat;
[Override("PortNumber"), Description (
"The TCP port number for data connection traffic.")] uint32 PortNumber = 3226;
[Override("ProtocolIFType"), Description (
"ProtocolIFType's enumeration is limited to TCP and reserved "
"values for this subclass of ProtocolEndpoint."),
ValueMap { "1", "222..4095", "4111", "4116..32767", "32768.." },
Values { "Other", "IANA Reserved", "TCP", "DMTF Reserved", "Vendor Reserved" }] uint16 ProtocolIFType = 4111;
[Description ("The default maximum TCP Receiver Window size for this TCP connection")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-76
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server uint32 ReceiverWindowSize;
[Description ("The TCP Maximum Segment Size (MSS) for this TCP connection. ")] uint32 MaximumSegmentSize;
[Description ("The timeout value for this TCP connection.")] uint32 ConnectionTimeOut;
[Description ("Remote Port number for this TCP Connection.")] uint32 RemotePortNumber;
[Description (
"The nature of messages that get transmitted on this TCP connection."),
ValueMap { "1", "2", "3"},
Values { "Control", "Data", "Both" }] string ConnectionPurpose;
};
CISCO_TCPSettings.mof
CISCO_TCPSettings
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TCPSettingsProviderImpl")] class CISCO_TCPSettings : CIM_TCPSettings {
[Write, Description (
"Sets the TCP/IP retransmit time for an initial SYN segment "
"when establishing a connection. The suggested value is 240 "
"seconds based on RFC 793. "),
Units ("Seconds"), MinValue (30), MaxValue (240) ]
uint8 WaitTimeTotalTime = 240;
[Write, Description (
"Selects TCP/IP delayed acknowledgements (ACKs) if set to 1 "
"(default), and selects immediate ACKs if set to 0. If "
"delayed ACKs are set, TCP/IP does not send an ACK "
"immediately on receiving data. TCP/IP normally delays "
"sending an ACK to improve the chance that it can bundle "
"it with transmitted data ") ]
boolean DelayedACKsEnabled;
[Write, Description (
"Control system-wide implementation of TCP/IP performance "
"extensions including timestamps and large window scaling "
"(as defined in RFC 1323). These features provide more "
"efficient and reliable usage of high-bandwidth, "
"high-latency links. If set to 1 (the default), negotiation "
"is turned on and will permit a TCP/IP receive window size "
"as large as 1,073,725,440 bytes (just under 1GB). "
"If set to 0, negotiation is disabled and the largest "
"possible window size is 65,535 bytes (64KB-1)."
"Window size negotiation may be disabled on a per-interface "
"basis by specifying the -rfc1323 option to ifconfig(1Mtcp). "
"This is necessary for PPP and SLIP interfaces that allow "
"header compression. ") ]
boolean WindowSizeNegotiationEnabled;
[Write, Description (
"Enable RFC1323 TCP timestamps. ") ]
boolean TimeStampsEnabled;
[Write, Description (
"Sets the idle time before TCP/IP keepalives are sent "
"(if enabled). The default value is 7200 seconds. "
"The suggested value is 7200 seconds. "),
Units ("Seconds"), MinValue (300), MaxValue (86400) ]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-77
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
uint32 KeepAliveIdleTime = 7200;
[Write, Description (
"Sets the number of TCP/IP keepalives that will be sent before "
"giving up. The suggested value is 8. "),
MinValue (1), MaxValue (256) ]
uint16 KeepAlivePackets = 8;
[Write, Description (
"Sets the TCP/IP keepalive interval between keepalive packets "
"once they start being sent. The suggested value is 75."),
Units ("Seconds"), MinValue (1), MaxValue (43200) ]
uint16 KeepAliveInterval = 75;
[Write, Description (
"Sets the number of keep-alive probes to be sent per slow timer "
"run. The suggested value is 5. "),
MinValue (1), MaxValue (64) ]
uint8 MaxKeepAliveProbes = 5;
[Write, Description (
"Default maximum segment size used in communicating with remote "
"networks. The suggested value is 512."),
Units ("Bytes"), MinValue (512), MaxValue (32768) ]
uint32 DefaultSegmentSize = 512;
[Write, Description (
"Enable RFC2018 TCP Selective Acknowledgements. ") ]
boolean SelectiveACKsEnabled;
[Write, Description (
"Enable TCP syncookies. The kernel must be compiled with "
"CONFIG_SYN_COOKIES. Syncookies protects a socket from overload "
"when too many connection attempts arrive. Client machines may "
"not be able to detect an overloaded machine with a short timeout "
"anymore when syncookies are enabled. ") ]
boolean SYNCookiesEnabled;
};
CISCO_TempAlert.mof
CISCO_TempAlert
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_TempAlertProviderImpl")] class CISCO_TempAlert: CISCO_EnvironmentalAlert
{
uint32 SensorValue;
uint32 SensorThresholdValue;
uint32 SensorThresholdIndex;
};
CISCO_UserAddedOnSwitch.mof
CISCO_UserAddedOnSwitch
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_UserAddedProviderImpl")] class CISCO_UserAddedOnSwitch: CISCO_SecurityAlert
{};
CISCO_UserLoginFailed.mof
CISCO_UserLoginFailed
6-78
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_UserLoginFailedProviderImpl")] class CISCO_UserLoginFailed: CISCO_SecurityAlert
{};
CISCO_UserModifiedOnSwitch.mof
CISCO_UserModifiedOnSwitch
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_UserModifiedProviderImpl")] class CISCO_UserModifiedOnSwitch: CISCO_SecurityAlert
{};
CISCO_UserRemovedOnSwitch.mof
CISCO_UserRemovedOnSwitch
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_UserRemovedProviderImpl")] class CISCO_UserRemovedOnSwitch: CISCO_SecurityAlert
{};
CISCO_Vsan.mof
CISCO_Vsan
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_VsanProviderImpl")] class CISCO_Vsan : CIM_AdminDomain {
}; string LoadBalancingType; string InteropMode;
CISCO_VSANChanged.mof
CISCO_VSANChanged
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_VsanChangedProviderImpl")] class CISCO_VSANChanged: CISCO_AlertIndication
{};
CISCO_VsanComputerSystemComponent.mof
CISCO_VsanComputerSystemComponent
[Association,
Description (
"CISCO_VsanComputerSystemComponent is a association between CISCO_Vsan and "
"CISCO_LogicalComputerSystem."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_VsanComputerSystemComponentProvide
rImpl")]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-79
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server class CISCO_VsanComputerSystemComponent : CISCO_Component
{
[Override ("GroupComponent"), Key, Aggregate, Description (
"The parent element in the association." )]
CISCO_Vsan REF GroupComponent;
[Override("PartComponent"), Key, Description (
"The child element in the association." )]
CISCO_LogicalComputerSystem REF PartComponent;
};
CISCO_VsanConformsToFabricProfile.mof
[Association, Version ( "3.1.0" ), Description (
"The SMISConformsToProfile association defines the "
"RegisteredProfiles that are conformant with a specific "
"verision of SIM-S. "),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_VsanConformsToFabricProfileProvide
rImpl")
] class CISCO_VsanConformsToFabricProfile : CIM_ElementConformsToProfile {
[Key, Override ( "ConformantStandard" ), Min ( 1 ), Max ( 1 ),
Description (
"The RegisteredProfile to which the ManagedElement conforms.")]
CISCO_FabricProfile REF ConformantStandard;
[Key, Override ( "ManagedElement" ), Min ( 1 ), Max ( 1 ),
Description (
"The ManagedElement that conforms to the RegisteredProfile.")]
CISCO_Vsan REF ManagedElement;
};
CISCO_VsanZoneCapabilities.mof
CISCO_VsanZoneCapabilities
[Association,
Description("ElementCapabilities represents the association between "
"ManagedElements and their Capabilities."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_VsanZoneCapabilitiesProviderImpl")
] class CISCO_VsanZoneCapabilities : CISCO_ElementCapabilities
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
Max ( 1 ),
Description ( "The managed element." )]
CISCO_Vsan REF ManagedElement;
[Override ( "Capabilities" ), Key, Description (
"The Capabilities object associated with the element." )]
CISCO_ZoneCapabilities REF Capabilities;
};
6-80
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_Zone.mof
CISCO_Zone
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneProviderImpl")] class CISCO_Zone : CIM_Zone
{};
CISCO_ZoneAlert.mof
CISCO_ZoneAlert
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneAlertProviderImpl")] class CISCO_ZoneAlert : CISCO_AlertIndication
{ uint32 VsanId;
};
CISCO_ZoneAlias.mof
CISCO_ZoneAlias
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneAliasProviderImpl")] class CISCO_ZoneAlias : CIM_NamedAddressCollection
{};
CISCO_ZoneAliasForZone.mof
CISCO_ZoneAliasForZone
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneAliasForZoneProviderImpl")] class CISCO_ZoneAliasForZone : CISCO_ZoneMemberOfCollection
{
[Override("Collection"), Key, Aggregate, Description (
"The Collection that aggregates members." )]
CISCO_Zone REF Collection;
[Override("Member"), Key, Description ( "The aggregated member of the Collection."
)]
CISCO_ZoneAlias REF Member;
};
CISCO_ZoneAliasInVsan.mof
CISCO_ZoneAliasInVsan
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneAliasInVsanProviderImpl")] class CISCO_ZoneAliasInVsan : CISCO_ZoneHostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-81
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_ZoneAlias REF Dependent;
};
CISCO_ZoneAliasSettingData.mof
CISCO_ZoneAliasSettingData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneAliasSettingDataProviderImpl")
] class CISCO_ZoneAliasSettingData : CISCO_ElementSettingData
{
[Override ( "ManagedElement" ), Key,
Description ( "The managed element." )]
CISCO_ZoneAlias REF ManagedElement;
[Override ( "SettingData" ), Key, Description (
"The SettingData object associated with the element." )]
CISCO_ZoneMemberSettingData REF SettingData;
};
CISCO_ZoneCapabilities.mof
CISCO_ZoneCapabilities
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneCapabilitiesProviderImpl")] class CISCO_ZoneCapabilities : CIM_ZoneCapabilities
{};
CISCO_ZoneCapInAdminDomain.mof
CISCO_ZoneCapInAdminDomain
[Association,
Description("ElementCapabilities represents the association between "
"ManagedElements and their Capabilities."),
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneCapInAdminDomainProviderImpl")
] class CISCO_ZoneCapInAdminDomain : CISCO_ElementCapabilities
{
[Override ( "ManagedElement" ), Key, Min ( 1 ),
Max ( 1 ),
Description ( "The managed element." )]
CISCO_AdminDomain REF ManagedElement;
[Override ( "Capabilities" ), Key, Description (
"The Capabilities object associated with the element." )]
CISCO_ZoneCapabilities REF Capabilities;
};
6-82
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ZoneHostedCollection.mof
CISCO_ZoneHostedCollection
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ZoneHostedCollection : CISCO_HostedCollection
{};
CISCO_ZoneInLogicalComputerSystem.mof
CISCO_ZoneInLogicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneInLogicalComputerSystemProvide
rImpl")] class CISCO_ZoneInLogicalComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_LogicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_Zone REF Dependent;
};
CISCO_ZoneInPhysicalComputerSystem.mof
CISCO_ZoneInPhysicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneInPhysicalComputerSystemProvid
erImpl")] class CISCO_ZoneInPhysicalComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_Zone REF Dependent;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-83
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ZoneInVsan.mof
CISCO_ZoneInVsan
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneInVsanProviderImpl")] class CISCO_ZoneInVsan : CISCO_ZoneHostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_Zone REF Dependent;
};
CISCO_ZoneMemberOfCollection.mof
CISCO_ZoneMemberOfCollection
[Abstract,
Association,
Description ("This is an abstract association." )] class CISCO_ZoneMemberOfCollection : CIM_MemberOfCollection
{};
CISCO_ZoneMemberSettingData.mof
CISCO_ZoneMemberSettingData
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneMemberSettingDataProviderImpl
")] class CISCO_ZoneMemberSettingData : CIM_ZoneMembershipSettingData
{
[Override ( "ConnectivityMemberType" ), Description (
"ConnectivityMemberType specifies the type of identification "
"used in the ConnectivityMemberID field. For Fibre Channel, "
"several of the enumerated values require additional "
"explanation: \n"
"* A ConnectivityMemberType equal to 2 (Permanent Address) "
"indicates that an NxPort WWN (pWWN)value should be specified in "
"the related ConnectivityMemberID property. \n"
"* A ConnectivityMemberType of 3 (FCID) indicates "
"that an NxPort Address ID(FCID) value should be specified in the "
"related ConnectivityMemberID property. \n"
"* A ConnectivityMemberType of 4 (Switch Port ID) indicates "
"that a Domain or Port Number(DomainID) value should be specified in "
"the related ConnectivityMemberID property. \n"
"* A ConnectivityMemberType of 5 (fcalias) "
"indicates that alias name which denotes a port ID or WWN shoud be "
"specified in the related ConnectivityMemberID property."
"* A ConnectivityMemberType of 6 (Interface) "
"indicates that a interface of local switch. The fc interface should"
"be specified in the related ConnectivityMemberID property(eg. fc1/9)"
"* A ConnectivityMemberType of 7 (fWWN) "
"indicates that Fabric port WWN.The WWN of the fabric "
"port value should be specified in the "
"related ConnectivityMemberID property."
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-84
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"* A ConnectivityMemberType of 8 (Network Address IpV4) "
"indicates that IPv4 address of an attached device in 32 bits"
"in dotted decimal format should be specified in the "
"related ConnectivityMemberID property."
"* A ConnectivityMemberType of 9 (Network Address IpV6) "
"indicates that IPv6 address. The IPv6 address of an attached device "
"in 128 bits in colon(:)-separated hexadecimal format should be specified"
" in related ConnectivityMemberID property."
"* A ConnectivityMemberType of 10 (Interface with Remote SWWN) "
"indicates that a interface of remote switch. The fc interface should"
"be specified along with Switch WWN in the related ConnectivityMemberID"
"property(eg. fc1/9;20000005300084DF)"
"* A ConnectivityMemberType of 11 (Interface with DomainID) "
"indicates that a interface of local switch. The fc interface should"
"be specified along with the Domain Id in the related "
"ConnectivityMemberID property(eg.fc1/9;25)"
"* A ConnectivityMemberType of 12 (Symbolic-node name) "
"indicates that a symbolic-node name"
"should be specified in the "
"related ConnectivityMemberID property."
"* A ConnectivityMemberType of 13 (Device alias) "
"indicates that a device alias"
"should be specified in the "
"related ConnectivityMemberID property.")]
uint16 ConnectivityMemberType;
};
CISCO_ZoneService.mof
CISCO_ZoneService
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneServiceProviderImpl")] class CISCO_ZoneService : CIM_ZoneService
{};
CISCO_ZoneServiceInAdminDomain.mof
CISCO_ZoneServiceInAdminDomain
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneServiceInAdminDomainProviderIm
pl")] class CISCO_ZoneServiceInAdminDomain : CISCO_HostedService
{ [Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_AdminDomain REF Antecedent;
[Override ( "Dependent" ),
Weak, Description ( "The Service hosted on the System." )]
CISCO_ZoneService REF Dependent;
};
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-85
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
CISCO_ZoneServiceInVsan.mof
CISCO_ZoneServiceInVsan
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneServiceInVsanProviderImpl")] class CISCO_ZoneServiceInVsan : CISCO_HostedService
{ [Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The hosting System." )]
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Weak, Description ( "The Service hosted on the System." )]
CISCO_ZoneService REF Dependent;
};
CISCO_ZoneSet.mof
CISCO_ZoneSet
[Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetProviderImpl")] class CISCO_ZoneSet : CIM_ZoneSet
{};
CISCO_ZoneSetAlert.mof
CISCO_ZoneSetAlert
[Indication,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetAlertProviderImpl")] class CISCO_ZoneSetAlert: CISCO_AlertIndication
{ string ZoneSetName; uint32 VsanId;
};
CISCO_ZoneSetInAdminDomain.mof
CISCO_ZoneSetInAdminDomain
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetInAdminDomainProviderImpl")
] class CISCO_ZoneSetInAdminDomain : CISCO_ZoneHostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_AdminDomain REF Antecedent;
[Override ( "Dependent" ),
Description (
6-86
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
"The collection defined in the context of a system." )]
CISCO_ZoneSet REF Dependent;
};
CISCO_ZoneSetInLogicalComputerSystem.mof
CISCO_ZoneSetInLogicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetInLogicalComputerSystemProv
iderImpl")] class CISCO_ZoneSetInLogicalComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_LogicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_ZoneSet REF Dependent;
};
CISCO_ZoneSetInPhysicalComputerSystem.mof
CISCO_ZoneSetInPhysicalComputerSystem
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetInPhysicalComputerSystemPro
viderImpl")] class CISCO_ZoneSetInPhysicalComputerSystem : CISCO_HostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_PhysicalComputerSystem REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_ZoneSet REF Dependent;
};
CISCO_ZoneSetInVsan.mof
CISCO_ZoneSetInVsan
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSetInVsanProviderImpl")] class CISCO_ZoneSetInVsan : CISCO_ZoneHostedCollection
{
[Override ( "Antecedent" ),
Min ( 1 ),
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
6-87
Chapter 6 Managed Object Format Files for Cisco DCNM SMI-S Server
Max ( 1 ),
Description ( "The scoping system." )]
CISCO_Vsan REF Antecedent;
[Override ( "Dependent" ),
Description (
"The collection defined in the context of a system." )]
CISCO_ZoneSet REF Dependent;
};
CISCO_ZoneSettingData.mof
CISCO_ZoneSettingData
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZoneSettingDataProviderImpl")] class CISCO_ZoneSettingData : CISCO_ElementSettingData
{
[Override ( "ManagedElement" ), Key,
Description ( "The managed element." )]
CISCO_Zone REF ManagedElement;
[Override ( "SettingData" ), Key, Description (
"The SettingData object associated with the element." )]
CISCO_ZoneMemberSettingData REF SettingData;
};
CISCO_ZonesInZoneSet.mof
CISCO_ZonesInZoneSet
[Association,
Provider("jsr48:com.cisco.dcbu.smis.provider.impl.CISCO_ZonesInZoneSetProviderImpl")] class CISCO_ZonesInZoneSet : CISCO_ZoneMemberOfCollection
{
[Override("Collection"), Key, Aggregate, Description (
"The Collection that aggregates members." )]
CISCO_Zoneset REF Collection;
[Override("Member"), Key, Description ( "The aggregated member of the Collection."
)]
CISCO_Zone REF Member;
};
6-88
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
7
Introduction to Cisco DCNM for SAN Web
Services
Cisco DCNM for SAN (DCNM-SAN) Web Services provide application programming interfaces (APIs) that expose Cisco DCNM-SAN core software functionalities as remote procedure calls to third-party vendors. Software developers can use the APIs to design computer applications that interact with the
Cisco DCNM-SAN Server over the network.
With Cisco DCNM-SAN, you can monitor MDS switch events, performance, and inventory, and you can perform administrative tasks. Applications can access Cisco DCNM-SAN Web Services through many protocols and data formats such as HTTP, HTTPS, XML, SOAP, and WSDL.
Cisco DCNM-SAN Web Services provide cross-platform operations. Web Services can interact with
.NET applications, C++ applications, and applications written in other programming languages and Web
Services must adhere to accepted conventions to make services interoperable with other applications.
For this reason, Cisco DCNM-SAN Web Services must follow the Java API for XML Web Services
(JAX-WS) specification. Cisco DCNM-SAN Web Services relies on JBoss Web Service (JBoss WS) as a service endpoint engine and as an entry point into the JAX-WS programming model. The framework also allows Cisco DCNM-SAN Web Services to become an integral part of the Cisco DCNM-SAN
Server run-time environment.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
7-1
Chapter 7 Introduction to Cisco DCNM for SAN Web Services
7-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
8
DCNM for SAN Web Services API
This chapter describes the DCNM for SAN (DCNM-SAN) Web Services application program interface
(API). This chapter defines the APIs exposed by the Cisco DCNM for SAN Web Services feature.
This chapter includes the following sections:
•
•
•
•
•
Web Services Specifications, page 8-1
Zone Manager WS - SEI, page 8-24
•
•
•
•
•
•
Web Services Specifications
Web Services specifications combine together to provide interoperable protocols for security, communication, and syntax for representing data.
•
•
•
•
XML
XML is the data format that defines the structure of the message. XML Web Services architecture allows programs written in different languages on different platforms to communicate with each other in a standards-based way. XML Web Services expose useful functionality to Web users through a standard
Web protocol (SOAP).
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-1
Chapter 8 DCNM for SAN Web Services API
Logon Service
SOAP
HTTP/HTTPS
HTTP/HTTPS is the transport layer of the service. HTTP/HTTPS allows data to traverse the network easily and is widely accepted. It is also considered as platform neutral. Every Cisco DCNM-SAN Web
Services operation is through HTTP/HTTPS.
WDSL
Simple Object Access Protocol (SOAP) is the communications protocol for Web Services. SOAP is a specification that defines the XML format for messages. The advantage of SOAP is that it has been implemented on many different hardware and software platforms.
A WSDL definition is an XML document with a root definition element from the http://schemas.xmlsoap.org/wsdl/ namespace. Cisco DCNM-SAN Web Services uses the WSDL document to publish which operations of DCNM-SAN are available. The definitions element can contain several other elements including types, message, portType, binding, and service, all of which come from the namespace. WSDL is published on FMServer at: http://localhost/LogonWSService/LogonWS?wsdl
Logon Service
LogonWS makes IdentityManager’s operations available as Web Service calls. LogonWS allows the following operations:
•
•
requestToken
This method returns a token string that must be passed in as the header of the SOAP message. Once the username and password is authenticated using DCNM-SAN’s SecurityManager, the token is generated and is kept valid for the number of milliseconds specified in the expiration argument.
Parameters username—Name of the user.
password—Password of the user.
expiration—Time (in milliseconds).
Return Value
Session token.
Error
Error code: 201—Invalid argument in Web Service exception.
8-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
requestLogonRole
Parameters username—Name of the user.
password—Password of the user.
expiration—Time (in milliseconds).
Return Value
Session token.
Error
Error code: 201—Invalid argument in Web Service exception.
requestLogonToken
Parameters username—Name of the user.
password—Password of the user.
expiration—Time (in milliseconds).
Return Value
Session token.
Error
Error code: 201—Invalid argument in Web Service exception.
getCredentialByToken
Parameters username—Name of the user.
password—Password of the user.
expiration—Time (in milliseconds).
Return Value
Session token.
Error
Error code: 201—Invalid argument in Web Service exception.
Logon Service
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-3
Chapter 8 DCNM for SAN Web Services API
San WS
validateToken
This method returns true or false depending on the validity of the token. If the token has expired, it returns false, or else it returns true.
Parameters token—Session Token.
Return Value
Boolean value is True if DCNM-SAN accepts the token.
Error
Error code: 201—Invalid argument in Web Service exception.
Authentication or Token
To interact with DCNM-SAN Web Services, you must obtain a token through LogonWS and attach this token to the header message of every SOAP requests. DCNM-SAN Web Services verifies user credentials using a unique token string that is administered by LogonWS. At any given time, HTTPS should be deployed to secure the communication channel. The following example displays the format of the header message:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
<m:Token xmlns:m="http://www.w3schools.com/transaction/">
token string is put here
</m:Token></SOAP-ENV:Header>
<SOAP-ENV:Body>
<getFabrics xmlns="http://ep.jaxws.dcbu.cisco.com/"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
IdentityManager
IdentityManager provides identity services and manages the user credentials that are required by Web
Services. It is the token provider that administers and maintains tokens. It authenticates the user, generates tokens, and validates or expires tokens by periodically checking and clearing the cache.
San WS
San Service is an Enterprise Java Beans (EJB) component that manages SAN-related service requests and executes queries on DCNM-SAN for information. San WS checks with IdentityManager for authentication before performing the request. A valid token string indicates to San Service that the user
8-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS is a DCNM-SAN user and that it must honor and execute the request. After retrieving the required information, it sends the result back to the user. SanWS logs errors in fms_ws.log. The service end-point interface (SEI) of SanWS defines the operations of the service, and sends them to the end users.
getFabrics
Returns the list of all open fabrics.
Return Value
An array of open fabrics.
Error
Error Code: 300— General SAN Service exception.
getFabricByIP
Returns the list of fabrics associated with the IP address of a given switch.
Parameters ipAddress—IP address of the switch.
Return Value
List of all fabrics associated with the specific IP address.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getPmEntity
Returns the PM entity from the database.
Return Value
PM entity from the database.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getPmChartData
Returns the PM statistics of a specific RRD file.
Return Value
PM statistics of a specific RRD file.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-5
Chapter 8 DCNM for SAN Web Services API
San WS
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFabricByKey
Returns the list of fabrics associated with the specified key.
Parameters key—Key of the fabric.
Return Value
List of all fabrics associated with the specified key.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFabricBySwitchKey
Returns the list of fabrics associated with the specified seed switch key (WWN).
Parameters swkey—Seed switch key of the fabric.
Return Value
List of all fabrics associated with the specified seed switch key.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getSwitchesByFabric
Returns the list of switches associated with the specified fabric key.
Parameters key—Key of the fabric.
Return Value
List of all fabrics associated with the specified fabric key.
Error
Error Code: 300— General SAN Service exception.
8-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
getNeighborSwitches
Returns the list of neighboring switches associated with the specified WwnKey.
Parameters key—WwnKey object.
Return Value
List of neighboring switches associated with the specified WwnKey.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Error Code: 302—SAN does not find objects by query key exception.
getActiveServerNodes
Returns the list of all active DCNM for SAN servers.
Parameters key—Key of the fabric.
Return Value
List of all fabric servers that are active.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFabricWithSnmpCredentail
Returns the list of fabrics (except the fabric with opening status) with the SNMP credentials.
Parameters key—Key of the fabric.
Return Value
List of all fabrics with their SNMP credentials.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
San WS
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-7
Chapter 8 DCNM for SAN Web Services API
San WS
getSwitchesByFabric
Returns the list of switches associated with the specified fabric key.
Parameters key—Key of the fabric.
Return Value
List of all fabrics associated with the specified fabric key.
Error
Error Code: 300— General SAN Service exception.
getSwitch
Returns the list of switches on all the fabrics.
Parameters key—Key of the fabric.
Return Value
List of all fabrics associated with the specified fabric key.
Error
Error Code: 300— General SAN Service exception.
getSwitchByKey
Returns the switch associated with the specified switch key object.
Parameters key—Key of the fabric.
Return Value
Switch associated with the specified switch key.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getSwitchIPByName
Returns the IP address associated with the specified system name or switch name.
8-8
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
Parameters sysname—Name of the system or switch.
Return Value
IP address associated with the specified system name.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
getSwitchIPByKey
Returns the IP address of the switch associated with the specified WwnKey object.
Parameters key—WwnKey object.
Return Value
IP address associated with the specified WwnKey object.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getNeighborSwitches
Returns the list of neighboring switches associated with the specified WwnKey.
Parameters key—WwnKey object.
Return Value
List of neighboring switches associated with the specified WwnKey.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Error Code: 302—SAN does not find objects by query key exception.
getVsans
Returns the list of VSANs in the fabric associated with the specified fabric key.
Parameters key—Fabric key object.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-9
Chapter 8 DCNM for SAN Web Services API
San WS
Return Value
List of VSANs in the fabric associated with the specified fabric key.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getVsan
Returns the VSAN in the fabric associated with the specified VSAN key object.
Parameters key—VSAN key object.
Return Value
VSANs in the fabric associated with the specified VSAN key object.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
getIsls
Returns the list of ISLs in the VSAN associated with the specified VSAN key.
Parameters key—VSAN key.
Return Value
Array of ISL objects in the VSAN associated with the specified VSAN key.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
discoverFabric
This API opens the fabric. This function requires the IP address of the seed switch and SNMP credentials.
Parameters seed—IP address of the seed switch.
user—SNMP credential.
8-10
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
Return Value
Boolean value is True if the discovery was successful.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Error Code: 100— Authentication failure exception.
Error Code: 101—Invalid credentials exception.
manageFabric
Returns true or false depending on manageability of the fabric.
Parameters key—Fabric key.
Return Value
Returns true if the fabric can be identified or managed. Returns false if the fabric cannot be identified or managed.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
unManageFabric
This function unmanages a fabric.
Parameters key—Fabric key.
Return Value
None.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
closeFabric
This function unmanages and closes a fabric.
Parameters key—Fabric key.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-11
Chapter 8 DCNM for SAN Web Services API
San WS
Return Value
None.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
purgeFabric
This function purges the specified fabric data both from the DCNM-SAN cache and database.
Parameters key—Fabric key.
Return Value
None.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Error Code: 302—SAN does not find objects by query key exception.
getEndports
Returns the list of all the end ports known to DCNM-SAN.
Return Value
An array of all the end ports.
Error
Error Code: 300— General SAN Service exception.
getEnclosures
Returns the list of all the enclosures known to DCNM-SAN.
Return Value
An array of enclosure objects.
Error
Error Code: 300— General SAN Service exception.
8-12
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
getEndPortByKey
Returns the end port based on the switch WWN.
Parameters key—WWN of the node.
Return Value
Returns the end port based on the switch WWN. Returns null if there are no end ports associated with the switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEndPortAttachedToSw
Returns the end ports that are associated with a switch.
Parameters key—IP address of the switch.
Return Value
Returns the end ports based on switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnclosureByName
Returns the enclosure based on the name.
Parameters name—Name of the enclosure object.
Return Value
Returns the enclosure object.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-13
Chapter 8 DCNM for SAN Web Services API
San WS
getEnclosureByKey
Returns the enclosure based on the name.
Parameters name—Name of the enclosure object.
Return Value
Returns the enclosure object.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnclosureByPWwn
Returns the enclosures that are associated with a physical WWN.
Parameters wwn—Physical WWN of the switch.
Return Value
Returns the enclosure based on physical WWN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
updateEnclosure
Update the enclosure with the value that is passed as parameter.
Parameters value—Value to update the enclosure.
Return Value
None.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
updateEndportEnclosure
Update the end port enclosure with the value that is passed as parameter.
8-14
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
Parameters endportKey—Value for the end port key.
enclosureKey—Value for the enclosure key.
Return Value
None.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getHosts
Returns the list of all the host enclosures known to DCNM-SAN.
Return Value
Returns the list of all the host enclosures known to DCNM-SAN.
Error
Error Code: 300— General SAN Service exception.
getHost
Returns the name of hosts in a VSAN.
Parameters key—Name of the VSAN.
Return Value
Returns the name of the hosts in tthe specified VSAN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getHostByFabric
Returns the name of hosts in a fabric.
ValidationException is displayed if any of the following situation occurs:
•
•
If the argument passed is null.
If the argument does not contain a valid key.
Parameters key—Name of the fabric.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-15
Chapter 8 DCNM for SAN Web Services API
San WS
Return Value
Returns the name of the hosts in the specified VSAN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getStorages
Returns the list of all the storage device enclosures known to DCNM-SAN.
Return Value
An array of all the storage device enclosures known to DCNM-SAN.
Error
Error Code: 300— General SAN Service exception.
getStorageByFabric
Returns the name of storage device enclosures in a fabric.
Parameters key—Name of the fabric.
Return Value
Returns the name of the storages in the specified fabric.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getHostPorts
Returns the list of all the host end ports in a fabric.
Parameters key—Name of the fabric.
Return Value
An array of all the host ports in a fabric.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
8-16
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
getDomainId
Returns the domain address.
Parameters key—Wwn vsanid—Unique identifier of the VSAN.
Return Value
Domain IP address.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getVsanIp
Returns the IP address of a VSAN.
Parameters key—Wwn vsanid—Unique identifier of the VSAN.
Return Value
IP address of a VSAN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getVsanDomains
Returns all VSAN domains in a switch.
Parameters
Key—Wwnkey
Return Value
VSAN domains in a switch.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
San WS
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-17
San WS
getIvrEnfZoneSetName
Returns the fabric IVR-enforced zone set name.
Parameters
Key—Fabric key
Return Value
Zone set name.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrEnfZoneSetNumber
Returns the fabric IVR-enforced zone number.
Parameters
Key—Fabric key
Return Value
Zone number.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
getIvrEnfZoneSetActivateTime
Returns the fabric IVR-enforced zone set activate time.
Parameters
Key—Fabric key
Return Value
Time stamp in the long integer format.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Chapter 8 DCNM for SAN Web Services API
getIvrEnfZoneSet
Returns the fabric IVR-enforced zone set.
Parameters
8-18
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
Key—Fabric key
Return Value
List of zone objects.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrActiveZonesetChecksum
Returns the IVR active zone set checksum.
Parameters
Key—Fabric key
Return Value
Checksum value.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getAliases
Returns all the aliases used by the fabric.
Parameters
Key—Fabric key
Return Value
Aliases used by the fabric.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
useFcAlias
Returns all the FC aliases used by the fabric.
Parameters
Key—Fabric key
Return Value
FC aliases used by the fabric.
Error
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-19
San WS
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnfZoneSet
Returns all theVSAN enforced zone sets.
Parameters
Key—Fabric key
Return Value
List of zones.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnfZoneSetName
Returns all the VSAN enforced zone set names.
Parameters
Key—Fabric key
Return Value
List of zone set names.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnfZoneSetName
Returns all the VSAN enforced zone set name.
Parameters
Key—Fabric key
Return Value
List of zone set names.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
Chapter 8 DCNM for SAN Web Services API
8-20
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
getFCAliases
Returns all the FC aliases for the fabric.
Parameters
Key—Fabric key
Return Value
List of aliases.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFCAliasesByVsan
Returns all the FC aliases for the VSAN.
Parameters
Key—Fabric key
Return Value
List of aliases for the VSAN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getCFS
Returns CFS.
Parameters
Key—Fabric key
Return Value
List of CFS features.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getCFSBySwitch
Returns CFS.
Parameters
Key—Switch key
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-21
San WS
Return Value
List of CFS features.
Error
Error Code: 300— General SAN Service exception.
Error code: 201—Invalid argument in Web Service exception.
getZoneMode
Returns zone operation modes.
Parameters
Key—Fabric key
Return Value
List of zone operation modes.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneModeByVsan
Returns zone operation modes for VSAN.
Parameters
Key—VSAN key
Return Value
List of zone operation modes.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Chapter 8 DCNM for SAN Web Services API
getZoneAttributes
Returns zone attributes.
Parameters
Key—Fabric key
Return Value
Zone attributes.
Error
Error Code: 300— General SAN Service exception.
8-22
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
San WS
Error Code: 201—Invalid argument in Web Service exception.
getZoneAttributesByVsan
Returns zone attributes for VSAN.
Parameters
Key—VSAN key
Return Value
Zone attributes for VSAN.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getSwitchPorts
Returns ports for the switch.
Parameters
Key—Fabric key
Return Value
List of ports for a given switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
isIVREnabled
Returns a boolean value depending on whether the IVR is enabled on the switch or not.
Parameters
Key—Switch key
Return Value
Boolean value.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getSwitchDateAndTime
Returns the switch time and date.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-23
Zone Manager WS - SEI
Parameters
Key—Switch key
Return Value
Boolean value.
Error
Error Code: 400—SnmpException.
Zone Manager WS - SEI
activateZoneset
Activates the zone set.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Operational status of the zone set.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
addZone
Add a new zone to the list of zones.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Zone object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
addZoneAlias
Adds a zone alias.
Parameters
8-24
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Zone Manager WS - SEI key—WwnKey key—Name of the VSAN
Return Value
Zone object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
addZoneMemberToZone
Adds a new zone member to the specific zone.
Parameters key—WwnKey key—Name of the VSAN
Return Value
ID of the zone member.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
addZoneMemberToZoneAlias
Adds a zone member to the zone alias.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Zone member.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
createZone
Creates a new zone.
Parameters key—WwnKey key—Name of the VSAN
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-25
Zone Manager WS - SEI
Return Value
Zone object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
createZoneAlias
Creates a zone alias.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Zone alias object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
createZoneMemberInZone
Creates a zone member in the specified zone.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Member ID.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
createZoneMemberInZoneAlias
Creates a zone member in the specified zone alias.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Member ID.
8-26
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Zone Manager WS - SEI
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
createZoneSet
Creates a zone set.
Parameters key—WwnKey key—Name of the VSAN
Return Value
ID of the zone set.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
deActivateZoneset
Returns the operational status of the zone set.
Parameters key—WwnKey key—Name of the VSAN
Return Value
Operational status of the zone set.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getEnfZoneSet
Returns the enforced zone set.
Parameters key—WwnKey.
key—Name of the VSAN.
Return Value
ID of the zone set.
Error
Error Code: 300—General SAN Service exception.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-27
Zone Manager WS - SEI
Error Code: 201—Invalid argument in Web Service exception.
getEnfZoneSetName
Returns the name of the enforced zone set.
Parameters key—WwnKey key—Name of the VSAN
Return Value
ID of the zone set.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrActiveZonesetChecksum
Returns the IVR active zoneset checksum.
Parameters key—FabricKey
Return Value
Checksum value.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrEnfZoneNumber
Returns the fabric IVR enforced zone number.
Parameters key—FabricKey
Return Value
Zone number.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Chapter 8 DCNM for SAN Web Services API
8-28
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Zone Manager WS - SEI
getIvrEnfZoneSet
Returns the fabric IVR enforced zone set ID.
Parameters key—FabricKey
Return Value
Zone set ID.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrEnfZoneSetActivateTime
Returns the fabric IVR enforced zone set activate time.
Parameters key—FabricKey
Return Value
System time as the number of seconds elapsed since the start of the Unix epoch at 1 January 1970
00:00:00 UT.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIvrEnfZoneSetName
Returns the fabric IVR enforced zone set name.
Parameters key—WWNKey
Return Value
Zone ID.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZone
Returns an array of zone IDs.
Parameters key—WwnKey
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-29
Zone Manager WS - SEI
Return Value
Zone object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneAlias
Returns zone alias.
Parameters key—WwnKey key—VSAN Key
Return Value
Zone alias object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneAliases
Returns an array of zone aliases.
Parameters key—WwnKey key—VSAN Key
Return Value
List of zone aliases.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneAttributes
Returns all the attributes for the zone.
Parameters key—WwnKey key—VSAN Key
Return Value
List of zone attributes.
8-30
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneAttributesByVsan
Returns all the zone attributes for the VSAN.
Parameters key—WwnKey
Return Value
List of zone attributes for the VSAN.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneCapabilitiesByFabric
Returns the zone information associated with the specified fabric key.
Parameters key—Fabric key
Return Value
ZoneCapabilities object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneCapabilitiesByVsan
Returns all zone information for the VSAN.
Parameters key—WwnKey
Return Value
ZoneCapabilities object.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Zone Manager WS - SEI
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-31
Zone Manager WS - SEI
getZoneMode
Returns the list of zone modes.
Parameters key—WwnKey
Return Value
Zone information.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneModeByVsan
Returns the list of zone modes for the VSAN.
Parameters key—VSAN key
Return Value
Zone information for the VSAN.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneSet
Returns the zone set.
Parameters key—WwnKey
Return Value
Zone sets.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZoneSets
Returns the list of zone sets.
Parameters key—WwnKey
Chapter 8 DCNM for SAN Web Services API
8-32
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Statistics WS
Return Value
List of zone sets.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getZones
Returns the list of zones.
Parameters key—WwnKey
Return Value
List of zones.
Error
Error Code: 300—General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Statistics WS
getEndDeviceStatistics
Returns the statistics of the end device.
Parameters key—WwnKey
Return Value
Statistics of the end device.
Error
Error Code: 201—Invalid argument in Web Service exception.
getEndDeviceStatisticsByAlias
Returns the statistics of the end devices by device alias.
Parameters key—WwnKey
Return Value
Statistics of the end devices.
Error
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-33
Statistics WS
Error Code: 201—Invalid argument in Web Service exception.
getEthPortStatisticsByKey
Returns the statistics of the Ethernet port.
Parameters key—WwnKey
Return Value
Statistics of the Ethernet port.
Error
Error Code: 201—Invalid argument in Web Service exception.
getEthPortStatisticsBySwitch
Returns the statistics of the Ethernet port based on a switch.
Parameters key—WwnKey
Return Value
Statistics of the Ethernet port based on a switch.
Error
Error Code: 201—Invalid argument in Web Service exception.
getFcPortStatistics
Returns the statistics of the Fibre Channel port.
Parameters key—WwnKey
Return Value
Statistics of the Fibre Channel port.
Error
Error Code: 201—Invalid argument in Web Service exception.
Chapter 8 DCNM for SAN Web Services API
8-34
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Statistics WS
getFcPortStatisticsByKey
Returns the statistics of the Fibre Channel port based on the switch WWN.
Parameters key—WwnKey
Return Value
Statistics of the Fibre Channel port.
Error
Error Code: 201—Invalid argument in Web Service exception.
getFcPortStatisticsBySwitch
Returns the statistics of the Fibre Channel port based on a switch.
Parameters key—WwnKey
Return Value
Port statistics of the Fibre Channel port.
Error
Error Code: 201—Invalid argument in Web Service exception.
getIPEndPointStatisticsByKey
Returns the statistics of the IPEndPoint based on a switch WWN.
Parameters key—WwnKey
Return Value
Statistics of the IPEndPoint.
Error
Error Code: 201—Invalid argument in Web Service exception.
getIPEndPointStatisticsBySwitch
Returns the statistics of the IPEndPoint based on a switch.
Parameters key—WwnKey
Return Value
Statistics of the IPEndPoint.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-35
Chapter 8 DCNM for SAN Web Services API
Security WS
Error
Error Code: 201—Invalid argument in Web Service exception.
getTCPEndPointStatisticsByKey
Returns the statistics of the TCPEndPoint based on a switch WWN.
Parameters key—WwnKey
Return Value
Statistics of the TCPEndPoint.
Error
Error Code: 201—Invalid argument in Web Service exception.
getTCPEndPointStatisticsBySwitch
Returns the statistics of the TCPEndPoint based on a switch.
Parameters key—WwnKey
Return Value
Statistics of the TCPEndPoint on a switch.
Error
Error Code: 201—Invalid argument in Web Service exception.
Security WS
getAaaMaxServer
Returns a value for the maximum number of server entries in a server group of the AAA configuration.
Parameters key—WwnKey
Return Value
Maximum number of server entries in a server group of the AAA configuration.
Error
Error Code: 400—SnmpException
8-36
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Security WS
getAaaMaxAppServer
Returns a value for the maximum number of server entries in the AAA configuration for an application type.
Parameters key—WwnKey
Return Value
Maximum number of server entries in a server group in the AAA configuration.
Error
Error Code: 400—SnmpException
isClearAcctLogSet
Checks if the clear accounting log is set.
Parameters key—WwnKey
Return Value
Checks if the clear accounting log is set.
Error
Error Code: 400—SnmpException
isMSCHAPRequired
Returns a boolean value to indicate if MSCHAP authentication mechanism is required for authenticating a user.
Parameters key—WwnKey
Return Value
Boolean value to indicate if MSCHAP authentication mechanism is required for authenticating a user.
Error
Error Code: 400—SnmpException
getAaaSetup
Returns the AAA configuration.
Parameters key—WwnKey
Return Value
AAA configuration.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-37
Chapter 8 DCNM for SAN Web Services API
Security WS
Error
Error Code: 400—SnmpException
getAaaAppServerGroups
Returns the AAA server groups for a specific application type.
Parameters key—WwnKey
Return Value
AAA server groups for a specific application type.
Error
Error Code: 400—SnmpException
getAaaServerGroups
Returns all the AAA server group entries (a server group consists of a number of AAA servers implementing the same AAA protocol).
Parameters key—WwnKey
Return Value
AAA server group entries.
Error
Error Code: 400—SnmpException
getSnmpUsers
Returns information about SNMP users.
Parameters key—WwnKey
Return Value
Information about SNMP users.
Error
Error Code: 400—SnmpException
getIPACLProfiles
Returns all the IP ACL profiles.
Parameters key—WwnKey
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-38
Chapter 8 DCNM for SAN Web Services API
Security WS
Return Value
All the IP ACL profiles.
Error
Error Code: 400—SnmpException
getSSHConfig
Returns the SSH configuration information.
Parameters key—WwnKey
Return Value
SSH configuration information.
Error
Error Code: 400—SnmpException
getSSHEnabled
Returns a boolean value to indicate if the SSH is enabled.
Parameters key—WwnKey
Return Value
Boolean value to indicate if the SSH is enabled.
Error
Error Code: 400—SnmpException
isTelnetEnabled
Returns a boolean value to indicate if Telnet is enabled.
Parameters key—WwnKey
Return Value
Boolean value to indicate if Telnet is enabled.
Error
Error Code: 400—SnmpException.
getPkiRsaKeys
Returns the PKI RSA key pair entries.
Parameters
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-39
Security WS key—WwnKey
Return Value
PKI RSA key pair entries.
Error
Error Code: 400—SnmpException.
getPkiTrustPointNames
Returns a list of PKI trustpoint names.
Parameters key—WwnKey
Return Value
A list of PKI trustpoint names.
Error
Error Code: 400—SnmpException.
getPkiTrustPointNames
Returns a list of PKI trustpoint names.
Parameters key—WwnKey
Return Value
A list of PKI trustpoint names.
Error
Error Code: 400—SnmpException.
getPkiCert
Returns certificate information of a PKI trustpoint.
Parameters key—WwnKey
Return Value
Certificate information of a PKI trustpoint.
Error
Error Code: 400—SnmpException.
Chapter 8 DCNM for SAN Web Services API
8-40
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Security WS
getPkiAction
Returns the PKI support action of a trustpoint.
Parameters key—WwnKey
Return Value
PKI support action of a trustpoint.
Error
Error Code: 400—SnmpException.
getPkiTrustPoint
Returns the PKI trust point information, which consists of the key pair name, a list of revocation methods, and the contact HTTP URL of the external OCSP server for certificate revocation.
Parameters key—WwnKey
Return Value
PKI trust point information.
Error
Error Code: 400—SnmpException.
getFeatureControls
Returns all of the feature control names and their respective statuses.
Parameters key—WwnKey
Return Value
Feature control names and statuses.
Error
Error Code: 400—SnmpException.
getIkeFailRecoveryCfg
Returns the IKE configuration.
Parameters key—WwnKey
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-41
Security WS
Return Value
IKE configuration.
Error
Error Code: 400—SnmpException
getIkeCfgPolicies
Returns the policy that is used to set up the IKE tunnels.
Parameters key—WwnKey
Return Value
Policy that is used to set up the IKE tunnels.
Error
Error Code: 400—SnmpException.
getIkeCfgInitiators
Returns the IKE initiator configuration information.
Parameters key—WwnKey
Return Value
IKE initiator configuration information.
Error
Error Code: 400—SnmpException.
getIkeTunnels
Returns the IKE tunnels information.
Parameters key—WwnKey
Return Value
IKE tunnels information.
Error
Error Code: 400—SnmpException.
getIPsecGlobalCfg
Returns the IPsec tunnel configuration information.
8-42
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Security WS
Parameters key—WwnKey
Return Value
IPsec tunnel configuration information.
Error
Error Code: 400—SnmpException.
getIPsecXformSets
Returns the IPsec transform set information.
Parameters key—WwnKey
Return Value
IPsec transform set information.
Error
Error Code: 400—SnmpException.
getIPsecCryptoMaps
Returns the IPsec cryptomap set.
Parameters key—WwnKey
Return Value
IPsec cryptomap set.
Error
Error Code: 400—SnmpException.
getIfsFromCryptoMap
Returns the interface name from the IPsec cryptomap.
Parameters key—WwnKey
Return Value
Interface name from the IPsec cryptomap.
Error
Error Code: 400—SnmpException.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-43
Protocol WS
getIPsecTunnels
Returns the information about IPsec tunnels.
Parameters key—WwnKey
Return Value
Information about IPsec tunnels.
Error
Error Code: 400—SnmpException.
isFipsModeEnabled
Returns information about the FIPS mode.
Parameters key—WwnKey
Return Value
Information about FIPS mode.
Error
Error Code: 400—SnmpException.
Protocol WS
getNtpPeers
Returns NTP peer information.
Parameters key—WwnKey
Return Value
NTP peer information.
Error
Error Code: 400—SnmpException
getNtpInfo
Returns NTP system information.
Parameters
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-44
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Protocol WS key—WwnKey
Return Value
NTP system information.
Error
Error Code: 400—SnmpException
getFspfConfig
Returns the FSPF protocol configuration.
Parameters key—WwnKey
Return Value
Configuration settings of the FSPF protocol.
Error
Error Code: 400—SnmpException
queryInterfaceFspfConfig
Returns the FSPF configuration on the interface pertaining to the specified VSAN.
Parameters key—WwnKey vsanid—Unique identifier of the VSAN
Return Value
FSPF configuration settings on the interface of a specified VSAN.
Error
Error Code: 400—SnmpException
getFcipProfiles
Returns FCIP profiles.
Parameters
Key—Fabric key
Return Value
List of FCIP profiles.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-45
Protocol WS
getFcipProfilesBySwitch
Returns FCIP profiles based on a switch.
Parameters
Key—Switch key
Return Value
List of FCIP profiles.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnels
Returns FCIP tunnels.
Parameters
Key—Fabric key
Return Value
List of FCIP tunnels.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnelsBySwitch
Returns FCIP tunnels based on a switch.
Parameters
Key—Switch key
Return Value
List of FCIP tunnels.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnelByLinkIndex
Returns FCIP tunnels based on a switch.
Parameters
Key—Switch key
Chapter 8 DCNM for SAN Web Services API
8-46
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Protocol WS
Return Value
List of FCIP tunnels.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnelByLinkIfIndex
Returns FCIP tunnels based on a switch.
Parameters
Key—Switch key
Return Value
List of FCIP tunnels.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnelErrors
Returns FCIP tunnels errors.
Parameters
Key—Fabric key
Return Value
List of FCIP tunnel errors.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getFcipTunnelErrorsBySwitch
Returns FCIP tunnels errors based on a switch.
Parameters
Key—Switch key
Return Value
List of FCIP tunnels errors.
Error
Error Code: 300— General SAN Service exception.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-47
Protocol WS
Error Code: 201—Invalid argument in Web Service exception.
getIpSettingsBySwitch
Returns IP settings from the switch.
Parameters
Key—Switch key
Return Value
IP settings from the switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getIpSettings
Returns IP settings from the switch and port.
Parameters
Key—Port key
Return Value
IP settings from the switch and port.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getTcpSettingsBySwitch
Returns TCP settings from the switch.
Parameters
Key—Switch key
Return Value
TCP settings from the switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
getTcpSettings
Returns TCP settings from the switch.
8-48
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Cluster WS - SEI
Parameters
Key—Switch key
Return Value
TCP settings from the switch.
Error
Error Code: 300— General SAN Service exception.
Error Code: 201—Invalid argument in Web Service exception.
Cluster WS - SEI
Service end point interface (SEI) of Cluster WS defines the operations of the service. These methods are published to the end users.
getSwitchesByFabricKey
Returns all the switches related to a fabric key.
Parameters key—Name of the fabric.
Return Value
All the switches associated with the fabric.
Error
Error Code: 400—SnmpException
getServerIpByFabricKey
Returns the managing server IP address from a fabric key.
Parameters key—Name of the fabric.
Return Value
IP address of the server.
Error
Error Code: 400—SnmpException
getServerIpBySwitchKey
Returns the managing server IP address from a switch key.
Parameters key—Name of the switch.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-49
Cluster WS - SEI
Return Value
IP address of the server.
Error
Error Code: 400—SnmpException
getFabricsByServerIp
Returns name of the fabric by server IP address.
Parameters key—IP address
Return Value
Name of the fabric.
Error
Error Code: 400—SnmpException
getAllServers
Returns all the servers in this federation.
Parameters key—IP address
Return Value
All the servers in the federation.
Error
Error Code: 400—SnmpException
getFabricByEnclosureKey
Returns the fabric key from an enclosure key.
Parameters key—Name of the enclosure.
Return Value
Name of the fabric.
Error
Error Code: 400—SnmpException
getServerIpByEnclosureKey
Returns the server IP address from an enclosure key.
Parameters
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-50
Chapter 8 DCNM for SAN Web Services API
Chapter 8 DCNM for SAN Web Services API
Event WS - SEI key—Name of the fabric.
Return Value
IP address of the server.
Error
Error Code: 400—SnmpException
getServerIpByVsanKey
Returns the server IP address from a VSAN key.
Parameters key—Name of the VSAN
Return Value
IP address of the server.
Error
Error Code: 400—SnmpException
Event WS - SEI
Service end point interface (SEI) of Event WS defines the operations of the service. These methods are published to the end users.
isCallHomeEnabled
Returns a boolean value depending upon the activation of the CallHome feature.
Parameters key—WwnKey
Return Value
Boolean value
Error
Error Code: 400—SnmpException
getCallHomeDestProfile
Returns the CallHome destination profile.
Parameters key—WwnKey
Return Value
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-51
Chapter 8 DCNM for SAN Web Services API
Event WS - SEI
Error
Error Code: 400—SnmpException
getCallHomeSysInfo
Returns system information about the CallHome feature.
Parameters key—WwnKey
Return Value
System information about the CallHome feature.
Error
Error Code: 400—SnmpException
getEmailMaxEntries
Returns the maximum number of e-mail address entries for the CallHome feature.
Parameters key—WwnKey
Return Value
Number of e-mail address entries for the CallHome feature
Error
Error Code: 400—SnmpException
getEmailSetup
Returns the e-mail setup details of the CallHome feature.
Parameters key—WwnKey
Return Value
E-mail setup details of CallHome feature.
Error
Error Code: 400—SnmpException
getSyslogServers
Returns the list of syslog servers.
Parameters key—WwnKey
8-52
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Inventory WS - SEI
Return Value
List of syslog servers.
Error
Error Code: 400—SnmpException
getSyslogMessageControl
Returns a list of syslog message configuration.
Parameters key—WwnKey
Return Value
List of syslog message configuration.
Error
Error Code: 400—SnmpException
getSyslogLoggingCfg
Returns syslog logging configuration.
Parameters key—WwnKey
Return Value
Configuration information on syslog credentials.
Error
Error Code: 400—SnmpException
Inventory WS - SEI
Service end point interface (SEI) of Inventory WS defines the service end point interface for Inventory
Web Service. These methods are published to the end users.
getPowerSuppliesBySwitchWwnKey
Returns name of the power suppies by switch.
Parameters key—WwnKey
Return Value
List of power supply names.
Error
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-53
Inventory WS - SEI
Error Code: 300 or 201—SAN service error or Invalid Argument
getPowerSuppliesBySwitchSnKey
Returns name of the power suppies by switch.
Parameters key—swKey
Return Value
List of power supply names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getPowerSuppliesBySwitchIP
Returns name of the power supplies by switch IP address.
Parameters key—swKey
Return Value
List of power supply names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getCardsBySwitchWwnKey
Returns name of the cards from a switch key.
Parameters key—swKey
Return Value
List of card names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getCardsBySwitchSnkey
Returns name of the cards from a switch key.
Parameters key—swKey
Chapter 8 DCNM for SAN Web Services API
8-54
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Inventory WS - SEI
Return Value
List of card names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getCardsBySwitchIP
Returns name of the cards by switch IP address.
Parameters key—swKey
Return Value
List of card names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getFansBySwitchWwnKey
Returns name of the fans by switch key.
Parameters key—swKey
Return Value
List of fan names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getFansBySwitchSnKey
Returns name of the fans by switch key.
Parameters key—swKey
Return Value
List of fan names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getFansBySwitchIP
Returns name of the fans by switch IP address.
Parameters
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-55
Inventory WS - SEI key—swKey
Return Value
List of fan names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getChassisBySwitchWwnKey
Returns name of the chassis by switch key.
Parameters key—swKey
Return Value
List of chassis names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getChassisBySwitchSnKey
Returns name of the chassis by switch key.
Parameters key—swKey
Return Value
List of chassis names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getChassisBySwitchIP
Returns name of the chassis by switch IP address.
Parameters key—swKey
Return Value
List of chassis names.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
Chapter 8 DCNM for SAN Web Services API
8-56
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Inventory WS - SEI
getAllHbas
Returns name of the hosts by host IP address.
Parameters key—hba WWN
Return Value
List of HBAs.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getHbaByWwn
Returns name of the hosts by host IP address.
Parameters key—hba WWN
Return Value
List of HBAs.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getLicensesBySwitchWwnKey
Returns name of the licenses used by the switch.
Parameters key—swKey
Return Value
List of licenses.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getLicensesBySwitchIP
Returns name of the licenses used by the switch.
Parameters key—swKey
Return Value
List of licenses.
Error
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-57
Inventory WS - SEI
Error Code: 300 or 201—SAN service error or Invalid Argument
getLicenseFlags
Returns name of the licenses used by the switch.
Parameters key—swKey
Return Value
List of licenses.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
getCardByPhysicalIndex
Returns the physical and switch index.
Parameters key—swKey
Return Value
List of indexes.
Error
Error Code: 300 or 201—SAN service error or Invalid Argument
Chapter 8 DCNM for SAN Web Services API
8-58
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
Chapter 8 DCNM for SAN Web Services API
Error Codes
Error Codes
Error Code
101
Description
Invalid credential
200
201
202
300
301
400
201
Web Service error
Invalid argument in Web Service function
Unreachable Web Service server
SAN service error
Invalid query key
SNMP error
Invalid argument
Note DCNM-SAN Web Services supports server federation. Service requests to SanWS, SecurityWS,
ProtocolWS, EventWS, and InventoryWS automatically dispatches the calls to the correct server in the federation. If you are using server federation, the following methods do not automatically mediate to the corresponding server in the federation:
SanWS : getEnclosures() getEndports() getFabricByIP() getHosts() getStorages() getSwitchIPByName() getSwitches()
InventoryWS : getAllHbas() getLicenseFlags()
In those specific instances, you might need to rely on ClusterWS to determine the server that you need to send the request.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
8-59
Error Codes
Chapter 8 DCNM for SAN Web Services API
8-60
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C H A P T E R
9
Discovery Automation Tool
You can use the Discovery Automation tool to discover DCNM-SAN, DCNM-LAN, and vCenter. After
Cisco DCNM is installed, this tool requires the IP address and user credentials of the seed switch in
DCNM-SAN, DCNM-LAN, and vCenter.
•
Installing Discovery Automation, page 9-1
•
Using the Discovery Automation Tool, page 9-1
Installing Discovery Automation
After you install Cisco DCNM, you can find the Discovery Automation tool installation informaiton here:
• Batch files exeute the Discover Fabric tool are located:
– On Windows at< DCNM install di r>/dcm/fm/bin/DiscoverFabric.bat
•
– On Linux at DiscoverFabric.sh
The jars are available at < DCNM install dir >dcm/fm/lib/.
The webservices used are:
– SAN discovery— SANWS to discoverFabricWithServer
–
–
LAN discovery— SANWS to discoverLan vCenter discovery— SANWS to addVirtualCenter
Using the Discovery Automation Tool
To use the discovery automation tool, enter the following command:
DiscoverFabric < FMServerIP > < FMUserName > < FMPassword > < Fabric-info file name- absolute path > [FM Server Port] (Optional-Default value is 80).
The fabric-info filename contains the DCNM-SAN, DCNM-LAN, and vCenter information and should be in the following format:
• For SAN SNMP v2— SeedSwitch IP, Community String, FM Server IP/Hostname
•
•
For SAN SNMP v3— SeedSwitch IP, UserName,Password, Protocol, FM Server IP/Hostname
For LAN SNMP v2— SeedSwitch IP, Community String, FM Server IP/Hostname
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
9-1
Chapter 9 Discovery Automation Tool
•
•
• For LAN SNMP v3— SeedSwitch IP, Snmp Version, UserName, Password, maxHop, enablePwd, groupDbId, Protocol, FM Server IP/Hostname
For VCENTER—VirtualCenter IP, UserName, Password
For deepDiscover— between protcol and serverIP.
9-2
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
A P P E N D I X
A
Sample Client Program
78-xxxxx-xx
This appendix provides a sample client program using the API.
Example A-1 Zone Manager Web Services API package com.cisco.dcbu.smis.jaxws.test; import static com.cisco.dcbu.smis.jaxws.test.ZoneWsUtil.*; import java.io.BufferedReader; import java.io.InputStreamReader; import com.cisco.dcbu.smis.jaxws.ep.Fabric; import com.cisco.dcbu.smis.jaxws.ep.OperationStatus; import com.cisco.dcbu.smis.jaxws.ep.Vsan; import com.cisco.dcbu.smis.jaxws.ep.WwnKey; import com.cisco.dcbu.smis.jaxws.ep.Zone; import com.cisco.dcbu.smis.jaxws.ep.ZoneMember; import com.cisco.dcbu.smis.jaxws.ep.ZoneSet; import com.cisco.dcbu.smis.jaxws.ep._switch; public class ZoneWsClient {
/**
* Default constructor
*/ public ZoneWsClient() { input_ = new BufferedReader(new InputStreamReader(System.in));
}
/**
* Main method is the starting point of execution.
* @param args
* @throws Exception
*/ public static void main(String[] args) throws Exception { menu();
}
/**
* This method show all available zone webservice as user menu.
* @throws Exception
*/ public static void menu() throws Exception {
ZoneWsClient zwsClient = new ZoneWsClient(); int choice = 0; for (;;) {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
A-1
A-2
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L header("=================================Zone WS
Client=============================================");
System.out.println("Available Zone services:\n\n " + "\t1:Discover Zones in fabric\n " + "\t2:Discover Zonesets in fabric\n " + "\t3:Discover Zonemenbers in fabric\n
"
+ "\t4:Create new Zone in fabric\n " + "\t5:Create new ZoneSet in fabric\n " + "\t6:Add Zonemember to existing Zone in fabric\n " + "\t7:Add existing Zone to existing Zoneset in fabric\n "
+ "\t8:Activate/Deactivate a ZoneSet in fabric\n " + "\t9:Manual Zone
Cache Invalidation\n " + "\t10:Exit ");
System.out.println("\n\tPlease enter your Choice: "); try { choice = Integer.parseInt(input_.readLine());
} catch (NumberFormatException e) {
System.out.println("Enter Integer choices only..."); continue;
} switch (choice) { case 1: zwsClient.displayZone(); break; case 2: zwsClient.displayZonesets(); break; case 3: zwsClient.displayZonemembers(); break; case 4: zwsClient.createZone(); break; case 5: zwsClient.createZoneSet(); break; case 6: zwsClient.addZoneMember(); break; case 7: zwsClient.addZone(); break; case 8: zwsClient.activateAndDeactivateZoneSet(); trailer("ACTIVATE/DEACTIVATE ZONESET"); break; case 9: zwsClient.zoneCacheInvalidation(); break; case 10:
System.out.println("Exiting ZoneWSClient.."); trailer("Zone WS CLIENT");
System.exit(1); default:
System.out.println("Wrong Choice entered.");
}
}
}
/**
* This method invalidates zonedata cache by making use of
* ZoneManagerWS: invalidateZoneDataCache()
*/ public void zoneCacheInvalidation() { try {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
System.out.println("Invalidation of Zone data cache started"); zoneManager.invalidateZoneDataCache();
System.out.println("Succesfully Invalidated Zone data cache");
} catch (Exception e) { exception(e);
}finally{ trailer("Zone Cache Invalidation");
}
}
/**
* This method takes promts user to enter already existing zoneset name to
* activate/deactivate.
* ZoneManagerWS: ActivateZoneset()
* ZoneManagerWS: deActivateZoneset()
*/ public void activateAndDeactivateZoneSet() throws Exception { int flag = 0,choice=0; do{ try {
System.out.println("Enter your choice\n 1:Activate a ZoneSet\n 2:Deactivate a
ZoneSet\n 3:Main menu"); choice = Integer.parseInt(input_.readLine());
OperationStatus oper = null; if(choice==3)return; if (choice != 1 && choice != 2 && choice !=3) {
System.out.println("Enter right Choice: 1 or 2 or 3"); flag = 0; continue;
} oper = activation(choice); if (oper != null){
System.out.println("Zoneset activation/deactivation is done successfully.\n
Please wait for 1-5 minutes to get reflected."); flag =1;
} else if (oper == null){
System.out.println("Zoneset activation/deactivation is not successfull"); flag =1;
} break;
} catch(NumberFormatException ne){
System.out.println("NumberFormatException: Integer type expected."); continue;
} catch (Exception e) { exception(e); flag=0; continue;
}
}while(choice !=3||flag==0);
} private OperationStatus activation(int choice) throws Exception {
OperationStatus oper = null;
System.out.println("Enter the ZoneSet name to be activated/deactivated ");
String zName = input_.readLine();
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(sws!=null){
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-3
A-4
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
ZoneSet enfZoneset = zoneManager.getEnfZoneSetDO(vsan.getKey());
ZoneSet[] zoneSets = zoneManager.getZoneSets(vsan.getKey(),new
WwnKey(sw.getWwn())); if(zoneSets==null){
System.out.println("Zoneset is null for VSan
"+vsan.getKey().getVsanID()); continue;
} for (ZoneSet zs : zoneSets) { if (enfZoneset != null) { if (enfZoneset.getName().equals(zName) && choice == 1 && enfZoneset.isActive()) {
} else if (!enfZoneset.getName().equals(zName) && choice == 2 && zs.getName().equals(zName)) {
System.out.println("Selected ZoneSet is already activated"); return null;
System.out.println("Selected ZoneSet is already deactivated"); return null;
}
} else if (enfZoneset == null && choice == 2) {
System.out.println("No ZoneSet is active to deactivate"); return null;
} else if (zs.getName().equals(zName) && choice == 2 &&
!zs.isActive()) {
System.out.println("Selected ZoneSet is already deactivated"); return null;
} if (zs.getName().equals(zName)) { if (choice == 1) oper = zoneManager.activateZoneset(vsan.getKey(), new
WwnKey(sw.getWwn()), zs.getName()); else if (choice == 2) oper = zoneManager.deActivateZoneset(vsan.getKey(), new
WwnKey(sw.getWwn()), zs.getName()); return oper;
}
}
}
}
}
System.out.println("Invalid Zoneset is selected");
}
}} return oper;
}
/**
* This method promts user to enter a unique zone name and creates the
* zone in default vsan.
* ZoneManagerWS:createZone()
*/ public void createZone() { try {
String zName=null; do{
System.out.println("Enter the new Zone name");
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L zName= input_.readLine();
}while(zName.length()<1);
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) { int qosPriority = -1; boolean readOnly = false; boolean broadcast = false; boolean qos = false;
Zone zone1 = zoneManager.createZone(vsan.getKey(),new
WwnKey(sw.getWwn()), zName, readOnly, broadcast, qos, qosPriority); if (zone1 == null) else
System.out.println("Failed to create Zone: " + zName);
System.out.println("Zone " + zName + " created successfuly in
Vsan:" + vsan.getKey().getVsanID() + ",Switch: " + sw.getName()); return;
}
}
}}
}
}
} catch (Exception e) { exception(e);
}finally{ trailer("CREATE ZONE");
}
}
/**
* This method promts user to enter an existing zone,zonememberid and zonemembertype and creates a zonemember in zone provided.
* ZoneManagerWS:addZoneMemberToZone
*/ public void addZoneMember() { try { for (;;) {
System.out.println("\nEnter existing zonename to which member has to be added\n");
String zoneName = input_.readLine();
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
Zone existingzones[] = zoneManager.getZones(vsan.getKey(), new
WwnKey(sw.getWwn())); if(existingzones==null){ continue;
} boolean flag=false; for (Zone zs : existingzones) { if (zs.getName().equals(zoneName)) {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-5
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L number format. \n 1. For WWN ");
System.out.println("Enter zonemember id which is in hexa format Eg: 1122334455667788 or 11:22:33:44:55:66:77:88"); hexstr=input_.readLine(); if (hexstr.contains(":")) zonememberid = ZoneWsUtil.fromHexString(hexstr, true); int zonememtype = Integer.parseInt(input_.readLine());
String hexstr = null; byte[] zonememberid = null; if(zonememtype==1){ else zonememberid = ZoneWsUtil.fromHexString(hexstr, false); flag=true;
System.out.println("Enter zonemember type which is in
} else{
System.out.println("Demo ZoneWsClient do not support other member types\n"); continue;
}
ZoneMember zoneMemberAdded = zoneManager.addZoneMemberToZone(vsan.getKey(),new WwnKey(sw.getWwn()),zoneName, zonememtype, -1,-1, -1, zonememberid, null); if (zoneMemberAdded == null)
System.out.println("Failed to add Zonemember to specified zone"); else
System.out.println("ZoneMember added succesfully to zone "+ zoneName); return;
}
} if(flag==false)
System.out.println("Zone " + zoneName + " not found. Please enter an existing zone");
}}
}}
}}
}
} catch(NumberFormatException ne){
System.out.println("NumberFormatException: Please check the input type/format");
} catch (Exception e) { exception(e);
}finally{ trailer("ADD ZONE");
}
}
/**
* This method promts user to enter existing zoneset, existing zone
* and adds zone to zoneset.
* ZoneManagerWS:addZoneToZoneset()
*
*/ public void addZone() { try { for (;;) {
A-6
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
System.out.println("Enter already existing zoneset to which the zone has to be added: ");
String zonesetName = input_.readLine();
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
ZoneSet existingzonesets[] = zoneManager.getZoneSets(vsan.getKey(), new WwnKey(sw.getWwn())); for (ZoneSet zset : existingzonesets) { if (zset.getName().equals(zonesetName)) {
System.out.println("Enter existing zone to be added to zoneset: ");
String zonename = input_.readLine();
Zone existingzones[] = zoneManager.getZones(vsan.getKey(),new WwnKey(sw.getWwn())); for (Zone zone : existingzones) { if (zone.getName().equals(zonename)) {
ZoneSet znst = zoneManager.addZoneToZoneset(vsan.getKey(),new WwnKey(sw.getWwn()),zset, zone); if (znst == null)
System.out.println("Failed to add Zone to specified Zoneset"); else
System.out.println("Zone "+ zonename+ " added succesfully to zoneset "+ zonesetName); return;
}
}
System.out.println("Zone "+ zonename+ " not found.
Please enter an existing zone");
}
}}
}}
}}
}
System.out.println("ZoneSet " + zonesetName+ " not found. Please enter an existing zoneset");
}
} catch (Exception e) { exception(e);
}finally{ trailer("ADD ZONE");
}
}
/**
* This method promts user to enter zoneset name which will be created
* in default vsan.
* ZoneManagerWS:createZoneSet()
*/ public void createZoneSet() { try {
System.out.println("Enter the new unique Zoneset name");
String zonsetName =input_.readLine();
Fabric[] fabrics = getFabrics();
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-7
A-8
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
ZoneSet newzoneset = zoneManager.createZoneSet(vsan.getKey(), new
WwnKey(sw.getWwn()), zonsetName); if (newzoneset == null)
System.out.println("Failed to create Zoneset: "+ zonsetName);
Vsan:"+ vsan.getKey().getVsanID() + ",Switch: "+ sw.getName()); return;
}} else
System.out.println("ZoneSet " + zonsetName+ " created in
}}
}}
} catch (Exception e) { exception(e);
}finally{ trailer("CREATE ZONESET");
}
}
/**
* This method displays the Zone member setting data in the fabric.
* ZoneManagerWS:getZoneMembers()
*/ public void displayZonemembers() { try {
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(vsans!=null){ for (Vsan vsan : vsans) {
Zone[] enfZones = getEnfZones(vsan); if (enfZones != null) { for (Zone ezone : enfZones) {
ZoneMember[] zms = getZoneMembers(ezone); for (ZoneMember zm : zms)
System.out.println("vsan id:"+ vsan.getKey().getVsanID()+
",vsan wwn:"+ vsan.getKey().getPWwn().getValue()+ ",Zone Name:" + ezone.getName()
+ ", ZoneMemberType: " + zm.getType()+ ",
ZoneMemberId: "+ ZoneWsUtil.toHexString(zm.getId())+ ",Status:" + ezone.isActive());
}
}
}} if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
Zone[] zones = getZones(vsan, sw); if (zones == null) return; for (Zone zone : zones) {
ZoneMember[] zms = getZoneMembers(zone); for (ZoneMember zm : zms)
System.out.println("vsan id:"+ vsan.getKey().getVsanID()+
",vsan wwn:"+ vsan.getKey().getPWwn().getValue()+ ",Zone Name:" + zone.getName()
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
+ ", ZoneMemberType: " + zm.getType()+ ",
ZoneMemberId: "+ ZoneWsUtil.toHexString(zm.getId())+ ",Status:" + zone.isActive());
}
}}
}}
}}
} catch (Exception e) { exception(e);
}finally{ trailer("Zone Members");
}
} private ZoneMember[] getZoneMembers(Zone zone) { header("Now getting ZoneMembers for Zone " + zone.getName());
ZoneMember[] zoneMemz = null; try { zoneMemz = zone.getMembers(); if (zoneMemz != null)
System.out.println(zoneMemz.length+ " ZoneMembers found for the Zone " + zone.getName()); else
System.out.println("No ZoneMembers found for the Zone "+ zone.getName()); return zoneMemz;
} catch (Exception e) { exception(e);
} return null;
}
/**
* This method displays the active and local zonesets in the fabric.
* ZoneManagerWS:getZoneSets()
*/ public void displayZonesets() { try {
Fabric[] fabrics = getFabrics(); if(fabrics!=null){ for (Fabric fab : fabrics) {
_switch[] sws = getSwitchesByFabric(fab);
Vsan[] vsans = getVsans(fab); if(vsans!=null){ for (Vsan vsan : vsans) { getEnfZonesets(vsan);
}} if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
ZoneSet[] zoneSets = zoneManager.getZoneSets(vsan.getKey(), new
WwnKey(sw.getWwn())); header("Now getting local ZoneSets for Vsan "+ vsan.getKey().getVsanID()); if (zoneSets == null) {
System.out.println("No Zoneset found for switch"+ sw.getName()
+ " Vsan "+ vsan.getKey().getVsanID());
} else{
System.out.println(zoneSets.length+ " Zonesets found for the switch
"+ sw.getName() + " Vsan "+ vsan.getKey().getVsanID()); for (ZoneSet zoneset : zoneSets) {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-9
A-10
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
System.out.println("VsanId:"+ vsan.getKey().getVsanID() +
",Vsan WWN:"+ vsan.getKey().getPWwn().getValue()+ ",ZonesetName:" + zoneset.getName()+
",Status:" + zoneset.isActive());
}
}
}}
}}
}}
} catch (Exception e) { exception(e);
}finally{ trailer("ZONESETS");
}
} private static Fabric[] getFabrics() { try {
Fabric[] fabrics = san.getFabrics(); if (fabrics == null) {
System.out.println("fabrics is null" + fabrics.length); trailer("No Fabric - Return to Main Menu"); menu();
} return fabrics;
} catch (Exception e) { exception(e);
} return null;
} private static _switch[] getSwitchesByFabric(Fabric fabric) { try {
_switch[] sws = san.getSwitchesByFabric(fabric.getFabricKey()); if (sws == null)
System.out.println("No switches found for fabric"); else { header(sws.length + " switch(es) found for fabric"); for (_switch sw : sws) {
System.out.println("Name:" + sw.getName() + ",IP:"+ sw.getIpAddress() +
",WWN:"+ sw.getWwn().getValue());
}
} return sws;
} catch (Exception e) { exception(e);
} return null;
} private static Vsan[] getVsans(Fabric fabric) { try {
Vsan[] vsans = san.getVsans(fabric.getFabricKey()); if (vsans == null)
System.out.println("No vsans found for fabric"); else { header(vsans.length + " vsan(s) found for fabric"); for (Vsan vsan : vsans) {
System.out.println("VanID:" + vsan.getKey().getVsanID()+ ",VsanWWN:" + vsan.getKey().getPWwn().getValue());
}
}
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
} return vsans;
} catch (Exception e) { exception(e);
} return null;
78-xxxxx-xx
/**
* This method displays all the active and local zones in the fabric.
* ZoneManagerWS:getEnfZones()
* ZoneManagerWS:getZones()
*/ public void displayZone() throws Exception {
Fabric[] fabrics=getFabrics(); if(fabrics!=null){ for (Fabric fabric : fabrics) {
System.out.println("Discovered the Fabric with WWN:" + fabric.getSeedSwWwn().getValue());
_switch[] sws = getSwitchesByFabric(fabric);
Vsan[] vsans = getVsans(fabric); if(vsans!=null){ for (Vsan vsan : vsans) {
Zone[] enfZones = getEnfZones(vsan); if (enfZones != null) { for (Zone ezone : enfZones) {
System.out.println("vsan id:"+ vsan.getKey().getVsanID() + ",vsan wwn:"+ vsan.getKey().getPWwn().getValue()+ ",Zone Name:" + ezone.getName() + ",Status:"+ ezone.isActive());
}
}
}} if(sws!=null){ for (_switch sw : sws) { if(vsans!=null){ for (Vsan vsan : vsans) {
Zone[] zones = getZones(vsan, sw);
System.out.println("vsan id:"+ vsan.getKey().getVsanID() + ",vsan wwn:"+ vsan.getKey().getPWwn().getValue()+ ",Zone Name:" + zone.getName() + ",Status:"+ zone.isActive()); if (zones == null) continue; for (Zone zone : zones) {
}
}}
}}
}} trailer("ZONES");
} private Zone[] getEnfZones(Vsan vsan) throws Exception { header(" Getting active zones for Vsan " + vsan.getKey().getVsanID());
Zone[] enfZones = null; try { enfZones = zoneManager.getEnfZoneSet(vsan.getKey()); if (enfZones != null)
System.out.println(enfZones.length+ " Active zones found for the Vsan "+ vsan.getKey().getVsanID()); else
System.out.println("No Active zones found"); return enfZones;
} catch (Exception e) {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
A-11
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L exception(e);
} return null;
} private ZoneSet getEnfZonesets(Vsan vsan) throws Exception { header("Now getting active ZoneSets for Vsan " + vsan.getKey().getVsanID());
ZoneSet enfZoneset = null; try { enfZoneset = zoneManager.getEnfZoneSetDO(vsan.getKey()); if (enfZoneset != null)
System.out.println("Active zoneset for the VsanId: "+ vsan.getKey().getVsanID() + ", Pwwn: "+ vsan.getKey().getPWwn().getValue() enfZoneset.isActive());
+ ", ZonesetName: " + enfZoneset.getName()+ ", Status " + else
System.out.println("Active zoneset is null"); return enfZoneset;
} catch (Exception e) { exception(e);
} return null;
} private static Zone[] getZones(Vsan vsan, _switch sw) { header("Now getting Local Zones for switch " + sw.getName() + " vsan "+ vsan.getKey().getVsanID()); try {
Zone[] zones = zoneManager.getZones(vsan.getKey(), new WwnKey(sw.getWwn())); if (zones != null) else
System.out.println("Found " + zones.length + " zones");
System.out.println("No zones found "); return zones;
} catch (Exception e) { exception(e);
} return null;
} static { getCredentials(); getLoginService(); getLogin(); getZoneManagerService(); getSanService();
}
} public class ZoneWsUtil { public static String url = null; public static String username = null; public static String password = null; public static String token = null; public static Logon logon = null; public static San san = null; public static ZoneManager zoneManager = null;
A-12
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L static BufferedReader input_ = null; static byte[] fromHexString(String hexStr, boolean hasColon) throws NumberFormatException { hexStr = hexStr.toLowerCase(); int len = hexStr.length(); byte bytes[] = new byte[hasColon ? ((len / 3) + 1) : (len / 2)]; int sPos = 0; // position in hexStr int bPos = 0; // position in bytes try { while (sPos < len) { char a = hexStr.charAt(sPos); char b = hexStr.charAt(sPos + 1); if (hasColon && (a == ':' || b == ':')) throw new NumberFormatException("bad Hex format"); int v1 = Character.digit(a, 16); int v2 = Character.digit(b, 16); if (v1 < 0 || v2 < 0)
}
} catch (Exception ex) { throw new NumberFormatException("bad Hex format");
} throw new NumberFormatException("bad Hex format"); int v3 = (int) (v1 * 16 + v2); bytes[bPos] = (byte) v3; sPos += hasColon ? 3 : 2; bPos++; if (bPos < bytes.length) throw new NumberFormatException("bad Hex format"); return bytes;
} static String toHexString(byte[] inputByte) { char[] HEX_DIGIT = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
'a', 'b', 'c', 'd', 'e', 'f' }; if (inputByte == null || inputByte.length == 0) return null;
StringBuffer outputstr = new StringBuffer(inputByte.length * 3); for (int i = 0; i < inputByte.length; i++) { int n = (int) (inputByte[i] & 0xFF); outputstr.append(HEX_DIGIT[(n >> 4) & 0x0F]); outputstr.append(HEX_DIGIT[n & 0x0F]); if (i + 1 < inputByte.length) outputstr.append(':');
} return outputstr.toString();
} static void header(String text) {
System.out.println(" ");
System.out.println(text);
} static void trailer(String string) {
System.out.println("\n******************************** END OF "
+ string + " ******************************** ");
}
/**
* This static method is used read the login credentials from the properties
* file named "configuration.properties"
*/ public static void getCredentials() {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-13
A-14
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Properties props = new Properties(); try { if(props!=null){
System.out.println("Reading credentials from the 'configuration.properties' file");
} catch (FileNotFoundException fe) {
System.out.println("ZoneWsClient: 'configuration.properties' File Not found!!"); props.load(new FileInputStream("configuration.properties")); url = props.getProperty("FMServer-ipadress"); username = props.getProperty("UserName"); password = props.getProperty("Password");
}
} catch (IOException e) { exception(e);
} url="localhost"; username="admin"; password="cisco123";
}
/**
* This method is to check LogonWSService is available or not. If available
* bind to the stub.
*/ public static void getLoginService() { try {
String loginServiceAddr = "http://" + url
+ "/LogonWSService/LogonWS";
LogonServiceLocator logonService = new LogonServiceLocator(); logonService.setEndpointAddress("LogonPort", loginServiceAddr); logon = logonService.getLogonPort(); if (logon == null)
System.out.println("login service not available" + logon); else
System.out.println("Logon success.");
} catch (Exception e) { e.printStackTrace();
}
}
/**
* This method is to get login token.
*/ public static void getLogin() { try { if(logon!=null){ token = logon.requestToken(username, password, 1000000000L); if (token == null)
}
}
System.out.println("Token not found" + token); else {
System.out.println("Token found for configured user. ");
} catch (Exception e) {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L e.printStackTrace();
}
}
/**
* This method is to check SanWSService is available or not. If available
* bind to the stub.
*/ public static void getZoneManagerService() { try {
String zmServiceAddr = "http://" + url
+ "/ZoneManagerWSService/ZoneManagerWS";
ZoneManagerServiceLocator zmService = new ZoneManagerServiceLocator(); zmService.setEndpointAddress("ZoneManagerPort", zmServiceAddr); zoneManager = zmService.getZoneManagerPort(); if (zoneManager == null) {
System.out.println("zonemanager service not available"); return;
}
SOAPHeaderElement hdrElement = setSoapHeader(token);
ZoneManagerBindingStub zmStub = (ZoneManagerBindingStub) zoneManager; zmStub.setHeader(hdrElement);
} catch (Exception e) { e.printStackTrace();
}
}
/**
* This method is to check ZoneManagerWSService is available or not. If
* available bind to the stub.
*/ public static void getSanService() { try {
String sanServiceAddr = "http://" + url + "/SanWSService/SanWS";
SanServiceLocator sanService = new SanServiceLocator(); sanService.setEndpointAddress("SanPort", sanServiceAddr); san = sanService.getSanPort(); if (san == null) {
System.out.println("service not available"); return;
}
SOAPHeaderElement hdrElement = setSoapHeader(token);
SanBindingStub sStub = (SanBindingStub) san; sStub.setHeader(hdrElement);
} catch (Exception e) { e.printStackTrace();
}
} private static SOAPHeaderElement setSoapHeader(String token) {
SOAPHeaderElement hdrElement = new SOAPHeaderElement(
"http://ep.cisco.dcbu.cisco.com", "token"); hdrElement.setPrefix("m"); hdrElement.setMustUnderstand(false); hdrElement.setValue(token); return hdrElement;
}
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx A-15
Appendix A Sample Client Program
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L static void exception(Exception e){ header("ZonwWsWclient: Some exception occurred!! \n"+e.toString()+"\nEnter [y] to view the stack trace or any key to continue..."); try {
String view=input_.readLine(); if(view.equalsIgnoreCase("y")){ e.printStackTrace();
}
} catch (IOException e1) { exception(e);
}
}
}
A-16
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
A P P E N D I X
B
Perl Client
This appendix provides information about the Perl client, installing ActiveState Perl, and the SOAP:Lite package.
This appendix contains the following sections:
•
•
•
•
•
Before executing the Perl script, install ActiveState Perl and the SOAP:Lite package.
Installing Perl
Step 1 Download Perl from http://www.perl.org/get.html
Note Choose and download the appropriate Perl version for your operating system.
Step 2
Step 3
Run the downloaded executable file to install Perl.
To verify whether Perl has been installed properly, use the perl -v CLI command in the command prompt.
If the installation is proper, the details of the installed version of Perl are displayed.
Installing SOAP:Lite
Download SOAP:Lite from http://search.cpan.org/dist/SOAP-Lite/ .
Note Choose and download the appropriate SOAP:Lite version for your operating system.
To install SOAP:lite, follow these steps:
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-17
Running the Perl Clients
Appendix B Perl Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Step 1
Step 2
Step 3
Step 4
Step 5
Using the command prompt, browse to the directory where the Makefile.PL is located in the downloaded
SOAP:Lite package.
Use the perl Makefile.PL -noprompt CLI command to install the SOAP:Lite package.
Download nmake utility for Windows from ftp://ftp.microsoft.com/Softlib/MSLFILES/Nmake15.exe
.
Extract the downloaded Nmake15.exe
You will find two files, NMAKE.exe and NMAKE.ERR.
Copy both the NMAKE.exe and NMAKE.ERR files to the installed Perl bin directory.
Complete the SOAP:Lite installation by entering the following commands for Windows and Linux machines: nmake nmake test nmake install
For more information on installing SOAP:Lite, see http://soaplite.com/install.html
.
Running the Perl Clients
Note To run a Perl client, the client file and its module file need to be in the same Perl folder.
From the Perl folder where the source files exist, enter the following command: perl Client-File-Name FM-Server-IP Username password
Figure B-1 Running a Perl Client
Running the Zone Client
To run the zone client, the files zoneClient.plx and zoneModule.plx need to be in same directory.
From the Perl folder where the source files exist, enter the following command: perl zoneClient.plx FM-Server-IP Username password
Running the Statistics Client
To run the statistics client, the files statistics.plx and statisticsModule.plx need to be in same directory.
From the Perl folder where the source files exist, enter the following command:
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-18 78-xxxxx-xx
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L perl statistics.plx FM-Server-IP Username password
Sample Code
Note •
•
The sample code provided here works only with DCNM release 6.1(x) and later. For prior DCNM versions, you need to make changes to the namespace base on the WSDL.
To collect statistics related data, you need to turn on the PM.
Example B-1 ZoneClient.plx
# File: zoneClient.plx
# Name: Shailin Saraiya
# Description: zoneClient
# Variables my $username; my $password; my $vsanId = 01; my $vsan_wwn = '20:01:00:0d:ec:19:6a:81'; my $wwn = '20:00:00:0d:ec:19:6a:80'; my $zoneName = 'test5'; my $readOnly = 0; my $broadcast = 0; my $qos = 0; my $qosPriority = -1; my $zoneMemberType = 1; my $zoneMemberFormat = 1; my $zoneMemberIvrFabricIndex = -1; my $zoneMemberIvrVsanIndex = -1; my $zoneMemberId = 'b1a2334455667788'; my $zoneLastModtime = 0; my $zoneMemberLunId = ''; my $zoneMemberDbId = 0; my $zoneisIvr = 0; my $zoneSetName = 'ZoneSet5'; my $active = 0; require 'zoneModule.plx';
($url,$username,$password) = @ARGV;
# Getting Token my $token = getToken($url,$username,$password); if(!$token) { print "\nError in getToken call \n"; goto exit;
}
# Creating Zone my $zoneIndex = createZone($token,$vsanId,$vsan_wwn,$wwn,$zoneName,$readOnly,$broadcast,$qos,$qosPriority)
; if(!$zoneIndex) { print "\nError in createZone call \n"; goto exit;
}
# Adding Member to Zone
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-19
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $status = addZoneMemberToZone($token,$vsanId,$vsan_wwn,$wwn,$zoneName,$zoneMemberType,$zoneMemberFor mat,$zoneMemberIvrFabricIndex,$zoneMemberIvrVsanIndex,$zoneMemberId,$zoneMemberLunId); if(!$status) { print "\nError in addZoneMemberToZone call \n"; goto exit;
}
# Creating ZoneSet my $zoneSetIndex = createZoneSet($token,$vsanId,$vsan_wwn,$wwn,$zoneSetName);
if(!$zoneSetIndex) {
print "\nError in createZoneSet call \n";
goto exit;
}
# Add Zone to ZoneSet my $status = addZoneToZoneset($token,$vsanId,$vsan_wwn,$wwn,$zoneIndex,$zoneName,$readOnly,$broadcast,$ qos,$qosPriority,$zoneMemberDbId,$zoneMemberType,$zoneLastModtime,$zoneMemberLunId,$zoneis
Ivr,$zoneSetIndex,$zoneSetName,$active); if(!$status) { print "\nError in addZoneToZoneset call \n"; goto exit;
}
# Activate ZoneSet
$status = activateZoneset($token,$vsanId,$vsan_wwn,$wwn,$zoneSetName); if(!$status) { print "\nError in activateZoneset call \n"; goto exit;
} else { print "successful \n";
} exit:
Example B-2 ZoneModule.plx
use SOAP::Lite;
# Get Token sub getToken {
my $url;
my $username;
my $password;
($url,$username,$password) = @_;
# Setting uri and proxy
my $client = SOAP::Lite
#->uri('http://ep.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/LogonWSService/LogonWS?wsdl')
->ns('http://ep.jaxws.dcbu.cisco.com/','namesp1');
my $username = SOAP::Data->type('string')->name('username')->value($username);
my $password = SOAP::Data->type('string')->name('password')->value($password);
my $expiration = SOAP::Data->type('long')->name('expiration')->value(100000000);
# Calling requestToken method
my $result = $client->requestToken($username,$password,$expiration);
# check for error
unless ($result->fault) {
my $token = $result->result();
return $token;
} else {
# error handling
print join ', ',
$result->faultcode,
B-20
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
$result->faultstring,
$result->faultdetail;
return 0
}
}
# Create Zone sub createZone { my $token; my $arg_vsanId; my $arg_vsanwwn; my $arg_wwn; my $arg_zoneName; my $arg_readOnly; my $arg_broadcast; my $arg_qos; my $arg_qosPriority;
($token,$arg_vsanId,$arg_vsanwwn,$arg_wwn,$arg_zoneName,$arg_readOnly,$arg_broadcast,$arg_ qos,$arg_qosPriority) = @_; my $VsanKey = SOAP::Data->name("vsanKey" => \SOAP::Data->value(
SOAP::Data->name("vsanID" => $arg_vsanId),
SOAP::Data->name("pWwn" => \SOAP::Data->value(SOAP::Data->name("value" =>
$arg_vsanwwn)))->type("Wwn")))->type("VsanKey"); my $Wwn = SOAP::Data->name("switchKey" => \SOAP::Data->value(
SOAP::Data->name("wwn" =>
\SOAP::Data->value(SOAP::Data->name("value"=>$arg_wwn)))->type("Wwn")))->type("WwnKey"); my $zName = SOAP::Data->name("zoneName"=>$arg_zoneName); my $readOnly = SOAP::Data->name("readOnly")->value($arg_readOnly); my $broadcast = SOAP::Data->name("broadcast")->value($arg_broadcast); my $qos = SOAP::Data->type('boolean')->name("qos")->value($arg_qos); my $qosPriority =
SOAP::Data->type('int')->name("qosPriority")->value($arg_qosPriority);
# Setting header
my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string'); my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/ZoneManagerWSService/ZoneManagerWS?wsdl')
->ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp2');
# Calling createZone method my $result =
$client->createZone($header,$VsanKey,$Wwn,$zName,$readOnly,$broadcast,$qos,$qosPriority); unless ($result->fault) {
return $result->valueof('//index');
} else { print join ', ',
$result->faultcode, return 0;
}
}
$result->faultstring,
$result->faultdetail;
# Adding Zone Member To Zone sub addZoneMemberToZone { my $token; my $arg_vsanId;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx B-21
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $arg_wwn; my $arg_vsanwwn; my $arg_zoneName; my $arg_zoneMemberType; my $arg_zoneMemberFormat; my $arg_zoneMemberIvrFabricIndex; my $arg_zoneMemberIvrVsanIndex; my $arg_zoneMemberId; my $arg_zoneMemberLunId;
($token,$arg_vsanId,$arg_vsanwwn,$arg_wwn,$arg_zoneName,$arg_zoneMemberType,$arg_zoneMembe rFormat,$arg_zoneMemberIvrFabricIndex,$arg_zoneMemberIvrVsanIndex,$arg_zoneMemberId,$arg_z oneMemberLunId) = @_; my @hex = ($arg_zoneMemberId =~ /(..)/g); my @dec = map { hex($_) } @hex; my @zoneMemberId = map { pack('C',$_) } @dec; my $arg_zoneMemberId = join("",@zoneMemberId); my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/ZoneManagerWSService/ZoneManagerWS?wsdl')
->ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp3'); my $VsanKey = SOAP::Data->name("vsanKey" => \SOAP::Data->value(
SOAP::Data->name("vsanID" => $arg_vsanId),
SOAP::Data->name("pWwn" => \SOAP::Data->value(SOAP::Data->name("value" =>
$arg_vsanwwn)))->type("Wwn")))->type("VsanKey"); my $Wwn = SOAP::Data->name("switchKey" => \SOAP::Data->value(
SOAP::Data->name("wwn" =>
\SOAP::Data->value(SOAP::Data->name("value"=>$arg_wwn)))->type("Wwn")))->type("WwnKey"); my $zName = SOAP::Data->name("zoneName"=>$arg_zoneName); my $zMemberType = SOAP::Data->name("zoneMemberType")->value($arg_zoneMemberType); my $zMemberFormat =
SOAP::Data->name("zoneMemberFormat")->value($arg_zoneMemberFormat); my $zMemberIvrFabricIndex =
SOAP::Data->name('zoneMemberIvrFabricIndex')->value($arg_zoneMemberIvrFabricIndex); my $zMemberIvrVsanIndex =
SOAP::Data->type('int')->name("zoneMemberIvrVsanIndex")->value($arg_zoneMemberIvrVsanIndex
); my $zMemberId = SOAP::Data->name("zoneMemberId")->value($arg_zoneMemberId); my $zMemberLunId = SOAP::Data->name("zoneMemberLunId")->value(arg_zoneMemberLunId); my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string');
my $result =
$client->addZoneMemberToZone($header,$VsanKey,$Wwn,$zName,$zMemberType,$zMemberFormat,$zMe mberIvrFabricIndex,$zMemberIvrVsanIndex,$zMemberId,$zMemberLunId); unless ($result->fault) {
return 1;
} else { print join ', ',
$result->faultcode,
$result->faultstring,
$result->faultdetail; return 0;
}
}
# Creating ZoneSet sub createZoneSet {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-22 78-xxxxx-xx
Appendix B Perl Client
78-xxxxx-xx
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $token; my $arg_vsanId; my $arg_vsanwwn; my $arg_wwn; my $arg_zoneSetName;
($token,$arg_vsanId,$arg_vsanwwn,$arg_wwn,$arg_zoneSetName) = @_; my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/ZoneManagerWSService/ZoneManagerWS?wsdl')
->ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp4');
# Creating complex data type my $VsanKey = SOAP::Data->name("vsanKey" => \SOAP::Data->value(
SOAP::Data->name("vsanID" => $arg_vsanId),
SOAP::Data->name("pWwn" => \SOAP::Data->value(SOAP::Data->name("value" =>
$arg_vsanwwn)))->type("Wwn")))->type("VsanKey"); my $Wwn = SOAP::Data->name("switchKey" => \SOAP::Data->value(
SOAP::Data->name("wwn" =>
\SOAP::Data->value(SOAP::Data->name("value"=>$arg_wwn)))->type("Wwn")))->type("WwnKey"); my $zSetName = SOAP::Data->name("zoneSetName"=>$arg_zoneSetName);
# Setting header my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string');
# Calling createZone method my $result = $client->createZoneSet($header,$VsanKey,$Wwn,$zSetName); unless ($result->fault) {
return $result->valueof('//index')."\n";
} else { print join ', ',
$result->faultcode,
$result->faultstring,
$result->faultdetail; return 0;
}
}
# Adding Zone to ZoneSet sub addZoneToZoneset { my $token; my $arg_vsanId; my $arg_vsanwwn; my $arg_wwn; my $arg_index; my $arg_zoneName; my $arg_readOnly; my $arg_broadcast; my $arg_qos; my $arg_qosPriority; my $arg_zoneMemberDbId; my $arg_zoneLastModtime; my $arg_memberType; my $arg_zoneMemberLunId; my $arg_isIvr; my $arg_zoneSetindex; my $arg_zoneSetName;
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-23
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $active;
($token,$arg_vsanId,$arg_vsanwwn,$arg_wwn,$arg_index,$arg_zoneName,$arg_readOnly,$arg_broa dcast,$arg_qos,$arg_qosPriority,$arg_zoneMemberDbId,$arg_memberType,$arg_zoneLastModtime,$ arg_zoneMemberLunId,$arg_isIvr,$arg_zoneSetindex,$arg_zoneSetName,$active) = @_; my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/ZoneManagerWSService/ZoneManagerWS?wsdl')
->ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp5');
# Creating complex data type my $VsanKey = SOAP::Data->name("vsanKey" => \SOAP::Data->value(
SOAP::Data->name("vsanID" => $arg_vsanId),
SOAP::Data->name("pWwn" => \SOAP::Data->value(SOAP::Data->name("value" =>
$arg_vsanwwn)))->type("Wwn")))->type("VsanKey"); my $Wwn = SOAP::Data->name("switchKey" => \SOAP::Data->value(
SOAP::Data->name("wwn" =>
\SOAP::Data->value(SOAP::Data->name("value"=>$arg_wwn)))->type("Wwn")))->type("WwnKey"); my $zoneDO = SOAP::Data->name("zoneDo"=> \SOAP::Data->value(
SOAP::Data->name("index"=>$arg_index),
SOAP::Data->name("name"=>$arg_zoneName),
SOAP::Data->name("readonly"=>$arg_readonly),
SOAP::Data->name("qos"=>$arg_qos),
SOAP::Data->name("qosPriority"=>arg_qosPriority),
SOAP::Data->name("broadcast"=>$arg_broadcast),
SOAP::Data->name("active"=>$active),
SOAP::Data->name("zoneLastModtime"=>arg_zoneLastModtime),
SOAP::Data->name("zoneMemberDbId"=>$arg_zoneMemberDbId),
SOAP::Data->name("vsanId"=>$arg_vsanId),
SOAP::Data->name("isIvr"=>$arg_isIvr),
SOAP::Data->name("memberType"=>$arg_memberType),
SOAP::Data->name("lunId"=>$arg_zoneMemberLunId)))->type("zone"); my $zoneSetDO = SOAP::Data->name("zoneSetDo"=> \SOAP::Data->value(
SOAP::Data->name("index"=>$arg_zoneSetindex),
SOAP::Data->name("name"=>$arg_zoneSetName),
SOAP::Data->name("active"=>$active),
SOAP::Data->name("zoneLastModified"=>$arg_zoneLastModtime)))->type("ZoneSet");
# Setting header my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string');
# Calling addZonetoZoneSet method my $result = $client->addZoneToZoneset($header,$VsanKey,$Wwn,$zoneDO,$zoneSetDO); unless ($result->fault) { return 1;
} else { print join ', ',
$result->faultcode,
return 0;
}
}
$result->faultstring,
$result->faultdetail;
#Actvating ZoneSet sub activateZoneset {
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-24 78-xxxxx-xx
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $token; my $arg_vsanId; my $arg_vsanwwn; my $arg_wwn; my $arg_zoneSetName;
($token,$arg_vsanId,$arg_vsanwwn,$arg_wwn,$arg_zoneSetName) = @_; my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/ZoneManagerWSService/ZoneManagerWS?wsdl')
->ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp6');
# Creating complex data type
my $VsanKey = SOAP::Data->name("vsanKey" => \SOAP::Data->value(
SOAP::Data->name("vsanID" => $arg_vsanId),
SOAP::Data->name("pWwn" => \SOAP::Data->value(SOAP::Data->name("value"
=> $arg_vsanwwn)))->type("Wwn")))->type("VsanKey"); my $Wwn = SOAP::Data->name("switchKey" => \SOAP::Data->value(
SOAP::Data->name("wwn" =>
\SOAP::Data->value(SOAP::Data->name("value"=>$arg_wwn)))->type("Wwn")))->type("WwnKey"); my $zSetName = SOAP::Data->name("zoneSetName"=>$arg_zoneSetName);
# Setting header my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string');
# Calling activateZoneset method
my $result = $client->activateZoneset($header,$VsanKey,$Wwn,$zSetName);
unless ($result->fault) {
return 1;
} else {
print join ', ',
$result->faultcode,
$result->faultstring,
$result->faultdetail;
return 0;
}
}
1;
Example B-3 StatisticsClient.plx
# File: StatisticsClient.plx
# Name: Shailin Saraiya
# Description: Statistics Client
# Variables my $username; my $password; my $url; my $fabricDbId = -1; my $switchDbId = -1; my $vsanDbId = -1; my $sortField = 'rxTxStr'; my $sortType = 'DESC';
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-25
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L my $limit = NaN; my $groupId = -1; my $isGroup = 0; my $networkType ='SAN'; my $filterStr = ''; my $temp = '24 Hours'; my $startIdx = 0; my $recordSize = 45; my $interval = 1; require 'statisticsModule.plx';
($url,$username,$password) = @ARGV;
# Getting Token my $token = getToken($url,$username,$password);
($rrdFile,$fid,$pmType) = getIslStatList($token,$fabricDbId,$switchDbId,$vsanDbId,$sortField,$sortType,$limit,$group
Id,$isGroup,$networkType,$filterStr,$temp,$startIdx,$recordSize); for (my $i=0;$i<1;$i++) { getPmChartData($token,@$rrdFile[$i],@$pmType[$i],@$fid[$i],$interval) . "\n";
}
Example B-4 StatisticsModule.plx
use SOAP::Lite; use Time::Local;
# Get Token
$url = ''; sub getToken {
my $username;
my $password;
($url,$username,$password) = @_;
# Setting uri and proxy
my $client = SOAP::Lite
#->uri('http://ep.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/LogonWSService/LogonWS?wsdl')
-> ns('http://ep.jaxws.dcbu.cisco.com/','namesp1');
#-> autotype(0)
#-> readable(1);
my $username = SOAP::Data->type('string')->name('username')->value($username);
my $password = SOAP::Data->type('string')->name('password')->value($password);
my $expiration = SOAP::Data->type('long')->name('expiration')->value(100000000);
# Calling requestToken method
my $result = $client->requestToken($username,$password,$expiration);
# check for error
unless ($result->fault) {
my $token = $result->result();
$token;
} else {
# error handling
print join ', ',
$result->faultcode,
$result->faultstring,
B-26
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
$result->faultdetail;
}
} sub getIslStatList { my $token; my $arg_fabricDbId; my $arg_switchDbId; my $arg_vsanDbId; my $arg_sortField; my $arg_sortType; my $arg_limit; my $arg_groupId; my $arg_isGroup; my $arg_networkType; my $arg_filterStr; my $arg_interval; my $arg_startIdx; my $arg_recordSize;
78-xxxxx-xx
($token,$arg_fabricDbId,$arg_switchDbId,$arg_vsanDbId,$arg_sortField,$arg_sortType,$arg_li mit,$arg_groupId,$arg_isGroup,$arg_networkType,$arg_filterStr,$arg_interval,$arg_startIdx,
$arg_recordSize) = @_; my $DbFilter= SOAP::Data->name("arg0" => \SOAP::Data->value(
SOAP::Data->name("fabricDbId" => $arg_fabricDbId),
SOAP::Data->name("switchDbId" => $arg_switchDbId),
SOAP::Data->name("vsanDbId" => $arg_vsanDbId),
SOAP::Data->name("sortField" => $arg_sortField),
SOAP::Data->name("sortType" => $arg_sortType),
SOAP::Data->name("limit" => $arg_limit),
SOAP::Data->name("groupId" => $arg_groupId),
SOAP::Data->name("isGroup" => $arg_isGroup)->type("boolean"),
SOAP::Data->name("networkType" => $arg_networkType),
SOAP::Data->name("filterStr" => $arg_filterStr)))->type("DbFilter"); my $interval = SOAP::Data->type("string")->name("arg1")->value($arg_interval); my $data_startIdx = SOAP::Data->name("arg2"=>$arg_startIdx); my $data_recordSize = SOAP::Data->name("arg3"=>$arg_recordSize);
# Setting header my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string');
#my $header = SOAP::Header->name('token')->prefix('m')->value($token)->type('string'); my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/StatisticsWSService/StatisticsWS?wsdl')
-> ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp2');
#-> autotype(0)
#-> readable(1);
# Calling getIslStatDataLength method
my $result =
$client->getIslStatList($header,$DbFilter,$interval,$data_startIdx,$data_recordSize); unless ($result->fault) { print "\ngetIslStatList\n\n";
my @fabric = $result->valueof('//item/fabric');
my @title = $result->valueof('//item/title');
my @maxTxStr = $result->valueof('//item/maxTxStr');
my @maxRxStr = $result->valueof('//item/rxTxStr');
my @rxTx = $result->valueof('//item/rxTx');
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-27
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
my $count = @fabric;
for(my $i=0;$i<10;$i++)
{
print "---------------------------------------------------------\n";
print "Fabric -> " . $fabric[$i] . "\n";
print "Title -> " . $title[$i] . "\n";
print "maxTxStr -> " . $maxTxStr[$i] . "\n";
print "maxRxStr -> " . $maxRxStr[$i] . "\n";
print "rxTx -> " . $rxTx[$i] . "\n";
print "---------------------------------------------------------\n";
}
my @rrdFile = $result->valueof('//item/rrdFile');
my @fid = $result->valueof('//item/fid');
my @pmType = $result->valueof('//item/pmtype');
return (\@rrdFile,\@fid,\@pmType);
} else { print join ', ',
$result->faultcode,
$result->faultstring,
$result->faultdetail;
}
} sub getPmChartData { my $token; my $arg_rrd; my $arg_pmType; my $arg_fid; my $arg_interval;
($token,$arg_rrd,$arg_pmType,$arg_fid,$arg_interval) = @_; my $data_rrd = SOAP::Data->type("string")->name("arg0")->value($arg_rrd); my $data_pmType = SOAP::Data->name("arg1")->value($arg_pmType); my $data_fid = SOAP::Data->name("arg2"=>$arg_fid); my $data_interval = SOAP::Data->name("arg3"=>$arg_interval);
# Setting header my $header =
SOAP::Header->name('token')->prefix('m')->value($token)->uri('http://ep.cisco.dcbu.cisco.c
om')->type('string'); my $client = SOAP::Lite
#->uri('http://ep.san.jaxws.dcbu.cisco.com/')
->proxy('https://'.$url.'/StatisticsWSService/StatisticsWS?wsdl')
-> ns('http://ep.san.jaxws.dcbu.cisco.com/','namesp3');
#-> autotype(0)
#-> readable(1);
# Calling getPmChartData method
my $result =
$client->getPmChartData($header,$data_rrd,$data_pmType,$data_fid,$data_interval); unless ($result->fault) { print "\n\nGetPmChartData\n\n";
my @item = $result->valueof('//item/item');
for(my $i=2;$i<30;$i=$i+3) {
print "---------------------------------------------------------\n";
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-28 78-xxxxx-xx
Appendix B Perl Client
Running the Statistics Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
}
1;
print "Rx -> ".$item[$i-2]."\n";
print "Tx -> ".$item[$i-1]."\n";
print "Time -> ".scalar localtime($item[$i]) . "\n";
print "---------------------------------------------------------\n";
}
} else { print join ', ',
$result->faultcode,
$result->faultstring,
$result->faultdetail;
}
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
B-29
Running the Statistics Client
Appendix B Perl Client
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
B-30
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
A P P E N D I X
C
Command Line Storage Dumps Tool
Command Line storage dumps tool is used get Dumps of Storage arrays by passing details through command line arguments. These dumps are further used to analyze for required purpose.
This appendix contains the following sections:
•
Installing Command Line Storage Dumps Tool
•
Using Command Line Storage Dumps Tool
Installing Command Line Storage Dumps Tool
The Command Line Storage Dumps Tool is integrated into DCNM. Also it can be installed as a standalone application. Follow below steps to run the tool in both the ways.
Installing with DCNM
Step 1
Step 2
After installation of Cisco DCNM, the Command Line Storage Dumps Tool can be found in <DCNM install dir>/dcnm/smis/client/bin .
Batch files to execute the Command Line Storage Dumps Tool are located:
• On Windows at < DCNM install di r> /dcm/smis/client/bin/StorageDiscovery.bat
.
• On Linux at StorageDiscovery.sh
.
Installing as Standalone Tool
Step 1
Step 2
After installation of Cisco DCNM, the standalone Command Line Storage Dumps Tool can be found in
< DCNM install di r>/dcm/smis/client/standaloneTools.
Zip files to execute the Command Line Storage Dumps Tool are located:
• On Windows at< DCNM install di r> /dcm/smis/client/standaloneTools/smisclient_standalone.zip.
Contents of smisclient_standalone.zip can be extracted to any directory and
StorageDiscovery.bat/StorageDiscovery.sh
can be run from the extracted bin directory.
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
C-31 78-xxxxx-xx
Appendix C Command Line Storage Dumps Tool
Using Command Line Storage Dumps Tool
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
Note Standalone tool requires JAVA_HOME to be set to 1.7 version to execute successfully.
Using Command Line Storage Dumps Tool
To use the Command Line Storage Dumps Tool, enter the following commands:
Windows
< DCNM install di r>/dcm/smis/client/bin> StorageDiscovery.bat http://0.0.0.0:5988/namespace -u username -p password -v vendorName
-u: username
-p: password
-v: vendor name(emc or netapp or hds or others)
Linux
< DCNM install di r>/dcm/smis/client/bin> StorageDiscovery.sh http://0.0.0.0:5988/namespace -u username -p password -v vendorName
-u: username
-p: password
-v: vendor name(emc or netapp or hds or others)
Once dumps are collected, the dumps are stored under <DCNM install dir>/dcm/smis/client/bin /results or
<DCNM install dir>/dcm/smis/client/bin /results directory. The related logs can also be found under the results directory.
C-32
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
I N D E X
A
Access Point subprofile description
using Access Point subprofile classes (table)
F
Fabric profile description
discovery and performance data
using Fabric profile classes (table)
B
Blade subprofile using Blade subprofile classes (table)
C
CIM client/server communications path (figure)
configuring the server
Operations over HTTP
sample scenarios for using objects
closeFabric
Configuring and Using the DCNM SMI-S Server
configuring the CIM server
D
discoverFabric
discovery and performance data 3-3
documentation related documents
E
Error Codes
G getEnclosureByKey
getEnclosureByPWwn
getEndPortAttachedToSw
getEndPortByKey
getEndports
getFabricByIP
getFabricByKey
getFabricBySwitchKey
getFabrics
getHost
getHostByFabric
getHosts
getIsls
getNeighborSwitches
getStorageByFabric
getStorages
getSwitch
getSwitchByKey
getSwitchIPByKey
getSwitchIPByName
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx IN-1
Index getVsan
getVsans
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L profiles
Fabric
Server
Switch
purgeFabric
I
H
HTTP
Installing Cisco DCNM SMI-S Server
Introduction to Cisco DCNM for SAN SMI-S
L
Logon Services
M
Managed Object Format files. See MOFs
managing zones
module, modeling
MOFs
S
Server profile, description 2-2
Service Location Protocol. See SLP
SLP, description
SMI-S description
1-2 in multivendor SAN (figure) 1-2
managing SANs
support in Cisco MDS 9000 Family 1-4
SOAP
standards, supported
Storage Management Initiative Specification. See SMI-S
subprofiles
Access Point
Switch profile description
discovery and performance data
using Switch profile classes (table)
N new and changed information (table)
P performance data, gathering
procedures configuring the CIM server
configuring zoning
gathering performance data
U
UML description
diagram of UML example (figure)
Unified Modeling Language
unManageFabric
updateEnclosure
updateEndportEnclosure
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
IN-2 78-xxxxx-xx
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
W
WBEM description
WDSL
Web-Based Enterprise Management Initiative. See WBEM
X
XML
xmlCIM Encoding Specification
Z zoning configuring
extrinsic methods (table)
modeling
using the Zoning subprofile classes (table)
Index
78-xxxxx-xx
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
IN-3
Index
R E V I E W D R A F T — C I S C O C O N F I D E N T I A L
IN-4
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 10.1(x)
78-xxxxx-xx
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement