Gris Ge
2014-11-24 13:06:05 UTC
* Auto-tool files updated.
* RPM SPEC file updated.
* The manpage of SMI-S plugin is named with it's binary file name
smispy_lsmplugin.
* The manpage contains:
* URI explanation.
* Supported Hardwares. (With quick notes)
* Known issues.
* Test for 'make dist' and 'make rpm' passed.
Signed-off-by: Gris Ge <***@redhat.com>
---
configure.ac | 1 +
doc/man/Makefile.am | 2 +-
doc/man/smispy_lsmplugin.1.in | 155 +++++++++++++++++++++++++++++++++++++++
packaging/libstoragemgmt.spec.in | 1 +
4 files changed, 158 insertions(+), 1 deletion(-)
create mode 100644 doc/man/smispy_lsmplugin.1.in
diff --git a/configure.ac b/configure.ac
index a96cedb..9de1dee 100644
--- a/configure.ac
+++ b/configure.ac
@@ -205,6 +205,7 @@ AC_OUTPUT(libstoragemgmt.pc \
doc/Makefile \
doc/man/lsmcli.1 \
doc/man/lsmd.1 \
+ doc/man/smispy_lsmplugin.1 \
doc/doxygen.conf \
tools/Makefile \
tools/udev/Makefile \
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 17abcee..d9e915d 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,2 +1,2 @@
-notrans_dist_man1_MANS = lsmcli.1 lsmd.1
+notrans_dist_man1_MANS = lsmcli.1 lsmd.1 smispy_lsmplugin.1
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
new file mode 100644
index 0000000..37260fc
--- /dev/null
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -0,0 +1,155 @@
+.TH LSMCLI "1" "November 2014" "lsmcli @VERSION@" "libStorageMgmt"
+.SH NAME
+smispy_lsmplugin -- LibstorageMgmt SMI-S Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt SMI-S Plugin allows LibstorageMgmt user to manage storage
+array (like EMC VNX/VMAX, NetApp ONTAP, HDS AMS, LSI MegaRAID and etc) via
+SNIA SMI-S standard. The 'smispy_lsmplugin' executable file is for
+LibstorageMgmt daemon to execute when get requests.
+
+.SH URI
+To use this plugin, LibstorageMgmt should set their URI to this format:
+.nf
+
+ # HTTP connection
+ smispy://<username>@<smis_provder_host>:<port>?<uri_parameters>
+
+ # HTTPS connection
+ smispy+ssl://<username>@<smis_provder_host>:<port>?<uri_parameters>
+
+.fi
+
+.TP
+\fBusername\R
+
+The \fBusername\fR is the SMI-S provider user account.
+
+.TP
+\fBsmispy_lsmplugin\R
+
+The \fBsmis_provder_host\fR is the SMI-S provider's IP address or DNS name.
+
+.TP
+\fBport\R
+
+By default, SMI-S plugin is using \fB5988\fR port for HTTP connection and
+\fB5989\fR port for HTTPS connection. You can skip this in URI if your
+SMI-S provider is using default ports.
+
+For non-defaults ports, The SELinux might stop the SMI-S plugin to make
+network connection.
+
+.TP
+\fBuri_parameters\fR
+These URI parameters are supported by this plugin:
+
+.RS 7
+.TP
+\fBnamespace=<name_space>\fR
+This URI parameter is for LSI MegaRAID and NetApp E-Series only.
+Please check 'Supported Hardwares' sections for detail.
+
+.TP
+\fBsystem=<system_id>\fR
+For those SMI-S provider which support multi-systems(Example EMC ECIM),
+this URI parameter could be used to limit network communication for
+specified system only. The \fBsystem_id\fR is the ID if the system:
+ * \fBlsm.System.id\fR (Python API)
+ * \fBlsm_system_id_get()\fR (C API)
+ * \fBlsmcli list --systems\fR (lsmcli command line)
+
+.TP
+\fBno_ssl_verify=yes\fR
+This URI parameter is for HTTPS connection only. With this URI parameter,
+the SMI-S plugin will not validate SMI-S provider's server SSL.
+It's often used for self-signed CA environment, but it's strongly suggested to
+remove this URI parameter and install self-signed CA properly.
+
+.SH Supported Hardwares
+The LibstorageMgmt SMI-S plugin is based on 'Block Services Package' profile
+, SNIA SMI-S 1.4 or above. Any storage system implemented that profile
+might be support. Detailed support status could be query via:
+
+ * \fBlsm.Client.capabilities()\fR (Python API)
+ * \fBlsm_capabilities()\fR (C API)
+ * \fBlsmcli capabilities\fR (lsmcli command line).
+
+This is a short list of tested arrays:
+
+.TP
+ * EMC VNX, CLARiiON, VMAX, Symmetrix
+
+A dedicate server running EMC SMI-S provider(aka ECIM) is required.
+The user account passing to LibstorageMgmt should be the user account define
+in ECIM, not the administrator account of the array.
+
+.TP
+ * HP 3PAR
+
+The SMI-S provider for the HP 3PAR Disk Storage Systems is integrated and
+delivered with the storage array firmware.
+
+.TP
+ * Dot Hill AssuredSAN
+The SMI-S provider is integrated and delivered with the storage array.
+
+.TP
+ * NetApp ONTAP
+
+A dedicate server running NetApp ONTAP SMI-S provider is required.
+
+.TP
+ * NetApp E-Series
+The SMI-S provider is integrated and delivered with the storage array
+firmware.
+
+The URI parameter 'namespace=root/lsiarray13' is required. Example URI:
+.nf
+ smispy+ssl://***@e-smi:5989?namespace=root/lsiarray13
+.fi
+
+.TP
+ * HDS VSP
+
+The SMI-S provider for HDS VSP is integrated and delivered with the storage
+array firmware.
+
+.TP
+ * HDS AMS
+A dedicate server running the Hitachi Device Manager SMI-S Provider is
+required.
+
+.TP
+ * LSI MegaRAID
+The server with MegaRAID card must install and setup LSI MegaRAID SMI-S
+provider before using LibstorageMgmt SMI-S plugin.
+
+The URI parameter 'namespace=root/LsiMr13' is also required. Example URI:
+.nf
+ smispy+ssl://***@lsip?namespace=root/LsiMr13
+.fi
+
+.SH Known issues
+.TP
+ * Cannot create or edit access group of EMC VNX/CLARiiON.
+
+EMC VNX/CLARiiON requires WWNN(World Wide Node Name) of initiator defined
+on access group create or edit call, while LibstorageMgmt currently does not
+support that. Please use EMC vendor specific tool to do so.
+
+.TP
+ * No VPD83 information of HDS AMS Volumes.
+
+Currently, HDS AMS SMI-S provider does not expose NAA VPD83 information yet.
+
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1)
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
diff --git a/packaging/libstoragemgmt.spec.in b/packaging/libstoragemgmt.spec.in
index d7f132d..86201c9 100644
--- a/packaging/libstoragemgmt.spec.in
+++ b/packaging/libstoragemgmt.spec.in
@@ -418,6 +418,7 @@ fi
%defattr(-,root,root,-)
%doc README COPYING.LIB
%{_mandir}/man1/lsmcli.1*
+%{_mandir}/man1/smispy_lsmplugin.1*
%{_mandir}/man1/lsmd.1*
%{_libdir}/*.so.*
%{_bindir}/lsmcli
* RPM SPEC file updated.
* The manpage of SMI-S plugin is named with it's binary file name
smispy_lsmplugin.
* The manpage contains:
* URI explanation.
* Supported Hardwares. (With quick notes)
* Known issues.
* Test for 'make dist' and 'make rpm' passed.
Signed-off-by: Gris Ge <***@redhat.com>
---
configure.ac | 1 +
doc/man/Makefile.am | 2 +-
doc/man/smispy_lsmplugin.1.in | 155 +++++++++++++++++++++++++++++++++++++++
packaging/libstoragemgmt.spec.in | 1 +
4 files changed, 158 insertions(+), 1 deletion(-)
create mode 100644 doc/man/smispy_lsmplugin.1.in
diff --git a/configure.ac b/configure.ac
index a96cedb..9de1dee 100644
--- a/configure.ac
+++ b/configure.ac
@@ -205,6 +205,7 @@ AC_OUTPUT(libstoragemgmt.pc \
doc/Makefile \
doc/man/lsmcli.1 \
doc/man/lsmd.1 \
+ doc/man/smispy_lsmplugin.1 \
doc/doxygen.conf \
tools/Makefile \
tools/udev/Makefile \
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 17abcee..d9e915d 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,2 +1,2 @@
-notrans_dist_man1_MANS = lsmcli.1 lsmd.1
+notrans_dist_man1_MANS = lsmcli.1 lsmd.1 smispy_lsmplugin.1
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
new file mode 100644
index 0000000..37260fc
--- /dev/null
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -0,0 +1,155 @@
+.TH LSMCLI "1" "November 2014" "lsmcli @VERSION@" "libStorageMgmt"
+.SH NAME
+smispy_lsmplugin -- LibstorageMgmt SMI-S Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt SMI-S Plugin allows LibstorageMgmt user to manage storage
+array (like EMC VNX/VMAX, NetApp ONTAP, HDS AMS, LSI MegaRAID and etc) via
+SNIA SMI-S standard. The 'smispy_lsmplugin' executable file is for
+LibstorageMgmt daemon to execute when get requests.
+
+.SH URI
+To use this plugin, LibstorageMgmt should set their URI to this format:
+.nf
+
+ # HTTP connection
+ smispy://<username>@<smis_provder_host>:<port>?<uri_parameters>
+
+ # HTTPS connection
+ smispy+ssl://<username>@<smis_provder_host>:<port>?<uri_parameters>
+
+.fi
+
+.TP
+\fBusername\R
+
+The \fBusername\fR is the SMI-S provider user account.
+
+.TP
+\fBsmispy_lsmplugin\R
+
+The \fBsmis_provder_host\fR is the SMI-S provider's IP address or DNS name.
+
+.TP
+\fBport\R
+
+By default, SMI-S plugin is using \fB5988\fR port for HTTP connection and
+\fB5989\fR port for HTTPS connection. You can skip this in URI if your
+SMI-S provider is using default ports.
+
+For non-defaults ports, The SELinux might stop the SMI-S plugin to make
+network connection.
+
+.TP
+\fBuri_parameters\fR
+These URI parameters are supported by this plugin:
+
+.RS 7
+.TP
+\fBnamespace=<name_space>\fR
+This URI parameter is for LSI MegaRAID and NetApp E-Series only.
+Please check 'Supported Hardwares' sections for detail.
+
+.TP
+\fBsystem=<system_id>\fR
+For those SMI-S provider which support multi-systems(Example EMC ECIM),
+this URI parameter could be used to limit network communication for
+specified system only. The \fBsystem_id\fR is the ID if the system:
+ * \fBlsm.System.id\fR (Python API)
+ * \fBlsm_system_id_get()\fR (C API)
+ * \fBlsmcli list --systems\fR (lsmcli command line)
+
+.TP
+\fBno_ssl_verify=yes\fR
+This URI parameter is for HTTPS connection only. With this URI parameter,
+the SMI-S plugin will not validate SMI-S provider's server SSL.
+It's often used for self-signed CA environment, but it's strongly suggested to
+remove this URI parameter and install self-signed CA properly.
+
+.SH Supported Hardwares
+The LibstorageMgmt SMI-S plugin is based on 'Block Services Package' profile
+, SNIA SMI-S 1.4 or above. Any storage system implemented that profile
+might be support. Detailed support status could be query via:
+
+ * \fBlsm.Client.capabilities()\fR (Python API)
+ * \fBlsm_capabilities()\fR (C API)
+ * \fBlsmcli capabilities\fR (lsmcli command line).
+
+This is a short list of tested arrays:
+
+.TP
+ * EMC VNX, CLARiiON, VMAX, Symmetrix
+
+A dedicate server running EMC SMI-S provider(aka ECIM) is required.
+The user account passing to LibstorageMgmt should be the user account define
+in ECIM, not the administrator account of the array.
+
+.TP
+ * HP 3PAR
+
+The SMI-S provider for the HP 3PAR Disk Storage Systems is integrated and
+delivered with the storage array firmware.
+
+.TP
+ * Dot Hill AssuredSAN
+The SMI-S provider is integrated and delivered with the storage array.
+
+.TP
+ * NetApp ONTAP
+
+A dedicate server running NetApp ONTAP SMI-S provider is required.
+
+.TP
+ * NetApp E-Series
+The SMI-S provider is integrated and delivered with the storage array
+firmware.
+
+The URI parameter 'namespace=root/lsiarray13' is required. Example URI:
+.nf
+ smispy+ssl://***@e-smi:5989?namespace=root/lsiarray13
+.fi
+
+.TP
+ * HDS VSP
+
+The SMI-S provider for HDS VSP is integrated and delivered with the storage
+array firmware.
+
+.TP
+ * HDS AMS
+A dedicate server running the Hitachi Device Manager SMI-S Provider is
+required.
+
+.TP
+ * LSI MegaRAID
+The server with MegaRAID card must install and setup LSI MegaRAID SMI-S
+provider before using LibstorageMgmt SMI-S plugin.
+
+The URI parameter 'namespace=root/LsiMr13' is also required. Example URI:
+.nf
+ smispy+ssl://***@lsip?namespace=root/LsiMr13
+.fi
+
+.SH Known issues
+.TP
+ * Cannot create or edit access group of EMC VNX/CLARiiON.
+
+EMC VNX/CLARiiON requires WWNN(World Wide Node Name) of initiator defined
+on access group create or edit call, while LibstorageMgmt currently does not
+support that. Please use EMC vendor specific tool to do so.
+
+.TP
+ * No VPD83 information of HDS AMS Volumes.
+
+Currently, HDS AMS SMI-S provider does not expose NAA VPD83 information yet.
+
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1)
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
diff --git a/packaging/libstoragemgmt.spec.in b/packaging/libstoragemgmt.spec.in
index d7f132d..86201c9 100644
--- a/packaging/libstoragemgmt.spec.in
+++ b/packaging/libstoragemgmt.spec.in
@@ -418,6 +418,7 @@ fi
%defattr(-,root,root,-)
%doc README COPYING.LIB
%{_mandir}/man1/lsmcli.1*
+%{_mandir}/man1/smispy_lsmplugin.1*
%{_mandir}/man1/lsmd.1*
%{_libdir}/*.so.*
%{_bindir}/lsmcli
--
1.8.3.1
1.8.3.1