Tony Asleson
2014-11-25 22:40:55 UTC
Hi Gris,
In general I believe having a man page for each plugin would be good.
However, I don't like the idea of putting supported hardware in the
man page itself. This will be changing often and thus will likely
be out of sync with reality.
See this patch for some suggested edits.
Thanks,
Tony
Signed-off-by: Tony Asleson <***@redhat.com>
---
doc/man/smispy_lsmplugin.1.in | 98 +++++++------------------------------------
1 file changed, 14 insertions(+), 84 deletions(-)
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
index 37260fc..72c9427 100644
--- a/doc/man/smispy_lsmplugin.1.in
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -4,12 +4,12 @@ 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
+arrays like: EMC VNX/VMAX, HDS AMS and LSI MegaRAID etc. via
SNIA SMI-S standard. The 'smispy_lsmplugin' executable file is for
-LibstorageMgmt daemon to execute when get requests.
+LibstorageMgmt daemon to execute when client user requests SMI-S plugin.
.SH URI
-To use this plugin, LibstorageMgmt should set their URI to this format:
+To use this plugin, user should set their URI to this format:
.nf
# HTTP connection
@@ -33,12 +33,12 @@ 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
+By default, SMI-S plugin will use port \fB5988\fR for HTTP connection and
+port \fB5989\fR 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.
+For non-default ports, SELinux will likely prevent the SMI-S plugin from making
+a network connection.
.TP
\fBuri_parameters\fR
@@ -48,12 +48,11 @@ These URI parameters are supported by this plugin:
.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
+For those SMI-S providers which support multi-systems(Example EMC ECIM),
+this URI parameter can 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)
@@ -61,89 +60,20 @@ specified system only. The \fBsystem_id\fR is the ID if the system:
.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.
+This URI parameter is for HTTPS connections only. With this URI parameter,
+the SMI-S plugin will not validate SMI-S provider's server SSL certificate.
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
+.SH Supported Hardware
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:
+, SNIA SMI-S 1.4 or later. Any storage system that implements that profile
+may be supported. Detailed support status can be queried 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)
In general I believe having a man page for each plugin would be good.
However, I don't like the idea of putting supported hardware in the
man page itself. This will be changing often and thus will likely
be out of sync with reality.
See this patch for some suggested edits.
Thanks,
Tony
Signed-off-by: Tony Asleson <***@redhat.com>
---
doc/man/smispy_lsmplugin.1.in | 98 +++++++------------------------------------
1 file changed, 14 insertions(+), 84 deletions(-)
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
index 37260fc..72c9427 100644
--- a/doc/man/smispy_lsmplugin.1.in
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -4,12 +4,12 @@ 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
+arrays like: EMC VNX/VMAX, HDS AMS and LSI MegaRAID etc. via
SNIA SMI-S standard. The 'smispy_lsmplugin' executable file is for
-LibstorageMgmt daemon to execute when get requests.
+LibstorageMgmt daemon to execute when client user requests SMI-S plugin.
.SH URI
-To use this plugin, LibstorageMgmt should set their URI to this format:
+To use this plugin, user should set their URI to this format:
.nf
# HTTP connection
@@ -33,12 +33,12 @@ 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
+By default, SMI-S plugin will use port \fB5988\fR for HTTP connection and
+port \fB5989\fR 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.
+For non-default ports, SELinux will likely prevent the SMI-S plugin from making
+a network connection.
.TP
\fBuri_parameters\fR
@@ -48,12 +48,11 @@ These URI parameters are supported by this plugin:
.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
+For those SMI-S providers which support multi-systems(Example EMC ECIM),
+this URI parameter can 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)
@@ -61,89 +60,20 @@ specified system only. The \fBsystem_id\fR is the ID if the system:
.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.
+This URI parameter is for HTTPS connections only. With this URI parameter,
+the SMI-S plugin will not validate SMI-S provider's server SSL certificate.
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
+.SH Supported Hardware
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:
+, SNIA SMI-S 1.4 or later. Any storage system that implements that profile
+may be supported. Detailed support status can be queried 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)
--
1.8.2.1
1.8.2.1