Gris Ge
2015-06-11 08:26:20 UTC
* Added manpage for these plugin binaries:
nstor_lsmpluging
ontap_lsmpluging
sim_lsmpluging
simc_lsmpluging
smispy_lsmpluging
targetd_lsmpluging
* Auto-tool files updated.
* RPM SPEC file updated by adding these manpage to their own rpm sub-package.
Changes in V2:
* Add the all plugin manpages.
* Remove known issue and detail support status section from smispy_lsmpluging
manpage.
Changes in V3:
* Merged Tony's patch into this.(Detailed changes listed below)
* Changed capital binary name in manpage title to lower case.
* Updated date from November to December.
* Fixed some typo and grammar issues.
* Added port URI argument to nstor_lsmplugin manpage.
* New section 'FIREWALL RULES' to indicate which default network access
requirement for each plugin.
* Added Tony and his email into 'AUTHOR' section.
* Removed white space.
Changes in V4:
* Rebased to current master.
* Update date string to 'June 2015'.
* Updated sim_lsmplugin.1.in for statefile description as we move to sqlite.
* Move URI parameters under(indented) 'URI parameters' section.
Check sim_lsmplugin.1.in and smispy_lsmplugin.1.in for example.
Signed-off-by: Gris Ge <***@redhat.com>
Signed-off-by: Tony Asleson <***@redhat.com>
---
configure.ac | 6 +++
doc/man/Makefile.am | 9 +++-
doc/man/nstor_lsmplugin.1.in | 68 ++++++++++++++++++++++++++++++
doc/man/ontap_lsmplugin.1.in | 67 +++++++++++++++++++++++++++++
doc/man/sim_lsmplugin.1.in | 55 ++++++++++++++++++++++++
doc/man/simc_lsmplugin.1.in | 42 +++++++++++++++++++
doc/man/smispy_lsmplugin.1.in | 91 ++++++++++++++++++++++++++++++++++++++++
doc/man/targetd_lsmplugin.1.in | 67 +++++++++++++++++++++++++++++
packaging/libstoragemgmt.spec.in | 6 +++
9 files changed, 409 insertions(+), 2 deletions(-)
create mode 100644 doc/man/nstor_lsmplugin.1.in
create mode 100644 doc/man/ontap_lsmplugin.1.in
create mode 100644 doc/man/sim_lsmplugin.1.in
create mode 100644 doc/man/simc_lsmplugin.1.in
create mode 100644 doc/man/smispy_lsmplugin.1.in
create mode 100644 doc/man/targetd_lsmplugin.1.in
diff --git a/configure.ac b/configure.ac
index a6cda95..e057e3f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -276,6 +276,12 @@ AC_OUTPUT(libstoragemgmt.pc \
doc/Makefile \
doc/man/lsmcli.1 \
doc/man/lsmd.1 \
+ doc/man/sim_lsmplugin.1 \
+ doc/man/simc_lsmplugin.1 \
+ doc/man/smispy_lsmplugin.1 \
+ doc/man/ontap_lsmplugin.1 \
+ doc/man/targetd_lsmplugin.1 \
+ doc/man/nstor_lsmplugin.1 \
doc/doxygen.conf \
doc/man/lsmd.conf.5 \
doc/man/megaraid_lsmplugin.1 \
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 19b536c..dc7e8ac 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,5 +1,10 @@
-notrans_dist_man1_MANS = lsmcli.1 lsmd.1
-
+notrans_dist_man1_MANS = lsmcli.1 lsmd.1 \
+ sim_lsmplugin.1 \
+ simc_lsmplugin.1 \
+ smispy_lsmplugin.1 \
+ ontap_lsmplugin.1 \
+ targetd_lsmplugin.1 \
+ nstor_lsmplugin.1
if WITH_MEGARAID
notrans_dist_man1_MANS += megaraid_lsmplugin.1
endif
diff --git a/doc/man/nstor_lsmplugin.1.in b/doc/man/nstor_lsmplugin.1.in
new file mode 100644
index 0000000..b39cd2e
--- /dev/null
+++ b/doc/man/nstor_lsmplugin.1.in
@@ -0,0 +1,68 @@
+.TH nstor_lsmplugin "1" "June 2015" "nstor_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+nstor_lsmplugin -- LibstorageMgmt nstor plugin
+
+.SH DESCRIPTION
+LibstorageMgmt nstor plugin allows user to manage NexentaStor 3.x
+storage software [1]. The 'nstor_lsmplugin' executable file is for libStorageMgmt
+daemon to execute when client user specifies nstor plugin in the URI.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBnstor://<username>@<nstor_server>:<port>\fR
+
+ # HTTPS connection
+ \fBnstor+ssl://<username>@<nstor_server>:<port>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account with 'Can_use_restapi' permission.
+
+.TP
+\fBnstor_server\fR
+
+The \fBnstor_server\fR is IP address or DNS name of
+NexentaStor server.
+
+.TP
+\fBport number\fR
+
+The \fBport number\fR is the listening port of the nexenta server REST API.
+The default port of 2000 is used if none is supplied on the URI.
+
+For non-default ports, SELinux will likely prevent the SMI-S plugin from making
+a network connection.
+
+.TP
+\fBURI parameters\fR
+No additional URI parameters are supported by this plugin.
+
+
+.SH SUPPORTED SOFTWARE
+NexentaStor 3.x is 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).
+
+.SH FIREWALL RULES
+By default, this plugin requires the access to the nstor array's TCP 2000 port.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), [1] http://nexentastor.org
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/ontap_lsmplugin.1.in b/doc/man/ontap_lsmplugin.1.in
new file mode 100644
index 0000000..ef0cd12
--- /dev/null
+++ b/doc/man/ontap_lsmplugin.1.in
@@ -0,0 +1,67 @@
+.TH ontap_lsmplugin "1" "June 2015" "ontap_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+ontap_lsmplugin -- LibstorageMgmt ONTAP Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt ontap plugin allows user to manage NetApp ONTAP storage arrays.
+The 'ontap_lsmplugin' executable file is for libStorageMgmt daemon to execute
+when client specifies ontap plugin in the URI
+
+This plugin requires NetApp ONTAP storage array to enable these options:
+
+ \fBoptions httpd.enable on\fR
+ \fBoptions httpd.admin.enable on\fR
+
+This options is required for HTTPS connection:
+
+ \fBoptions httpd.admin.ssl.enable on\fR
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBontap://<username>@<ontap_filer>\fR
+
+ # HTTPS connection
+ \fBontap+ssl://<username>@<ontap_filer>\fR
+
+.fi
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account with administration privilege.
+
+.TP
+\fBontap_filer_ip\fR
+
+The \fBontap_filer_ip\fR is the NetApp ONTAP filer IP address or DNS name.
+
+.TP
+\fBURI parameters\fR
+
+No additional URI parameters are supported by this plugin.
+
+.SH Supported Hardware
+NetApp ONTAP 8.x is 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).
+
+.SH FIREWALL RULES
+This plugin requires the access to the NetApp ONTAP Filer's TCP 80 port for
+HTTP connection and TCP 443 port for HTTPS connection.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/sim_lsmplugin.1.in b/doc/man/sim_lsmplugin.1.in
new file mode 100644
index 0000000..901761d
--- /dev/null
+++ b/doc/man/sim_lsmplugin.1.in
@@ -0,0 +1,55 @@
+.TH sim_lsmplugin "1" "June 2015" "sim_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+sim_lsmplugin -- LibStorageMgmt simulator python plugin
+
+.SH DESCRIPTION
+LibstorageMgmt simulator plugin is for development or test use only. The plugin
+simulates an array which supports most features of the library. State is stored
+in a file, default is '/tmp/lsm_sim_data'. The 'sim_lsmplugin' executable file is
+for libStorageMgmt daemon to execute when client user specifies sim plugin in
+the URI.
+
+This plugin is written in pure Python and is intended to be an example of a
+python plugin for the library.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # All that is required
+ sim://
+
+ # Optional statefile
+ sim://?statefile=<file path and name>
+
+.fi
+No password is required for this plugin.
+
+.TP
+\fBURI parameters\fR
+
+.RS 7
+.TP
+\fBstatefile\fR
+
+Use specified file to store simulator state data. Example URI:
+.nf
+ \fBsim://?statefile=/tmp/other_lsm_sim_data\fR
+.fi
+
+The statefile is a sqlite3 data base file.
+
+.SH FIREWALL RULES
+This plugin requires not network access.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/simc_lsmplugin.1.in b/doc/man/simc_lsmplugin.1.in
new file mode 100644
index 0000000..32484ad
--- /dev/null
+++ b/doc/man/simc_lsmplugin.1.in
@@ -0,0 +1,42 @@
+.TH simc_lsmplugin "1" "June 2015" "simc_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+simc_lsmplugin -- LibstorageMgmt Simulator C Plugin
+
+.SH DESCRIPTION
+LibStorageMgmt simulator C plugin is for development use. The plugin simulates
+an array which supports most features of the library. The simulator is memory
+based, state will be discarded once the plugin exits. The 'simc_lsmplugin'
+executable file is for the libStorageMgmt daemon to execute when client user
+specifies simc plugin in the URI.
+
+Since every command of lsmcli is a standalone libStorageMgmt session, this
+plugin is essentially useless for this purpose. In this use case, the
+libStorageMgmt simulator plugin \fBsim_lsmplugin(1)\fR is suggested.
+
+This plugin is written in pure C and is intended to be an example of a
+C plugin for the library.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ simc://
+
+.fi
+No password is required for this plugin.
+No URI parameters are supported by this plugin.
+
+.SH FIREWALL RULES
+This plugin requires not network access.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), \fBsim_lsmplugin\fR(1)
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
new file mode 100644
index 0000000..b07d428
--- /dev/null
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -0,0 +1,91 @@
+.TH smispy_lsmplugin "1" "June 2015" "smispy_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+smispy_lsmplugin -- LibstorageMgmt SMI-S Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt SMI-S Plugin allows LibstorageMgmt user to manage storage
+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 client user requests SMI-S plugin.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBsmispy://<username>@<smis_provder_host>:<port>?<uri_parameters>\fR
+
+ # HTTPS connection
+ \fBsmispy+ssl://<username>@<smis_provder_host>:<port>?<uri_parameters>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the SMI-S provider user account.
+
+.TP
+\fBsmis_provder_host\fR
+
+The \fBsmis_provder_host\fR is the SMI-S provider's IP address or DNS name.
+
+.TP
+\fBport\fR
+
+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-default ports, SELinux will likely prevent the SMI-S plugin from making
+a 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.
+
+.TP
+\fBsystem=<system_id>\fR
+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 of 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 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 Hardware
+The LibstorageMgmt SMI-S plugin is based on 'Block Services Package' profile
+, SNIA SMI-S 1.4 or later. Any storage system which 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).
+
+.SH FIREWALL RULES
+By default, this plugin requires access to the SMI-S provider's TCP 5988 port
+for HTTP conenction and TCP 5989 port for HTTPS connection.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/targetd_lsmplugin.1.in b/doc/man/targetd_lsmplugin.1.in
new file mode 100644
index 0000000..290efc9
--- /dev/null
+++ b/doc/man/targetd_lsmplugin.1.in
@@ -0,0 +1,67 @@
+.TH targetd_lsmplugin "1" "June 2015" "targetd_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+targetd_lsmplugin -- libStorageMgmt targetd plugin
+
+.SH DESCRIPTION
+LibStorageMgmt targetd plugin allows user to manage storage using
+the targetd storage API [1]. The 'targetd_lsmplugin' executable file is for
+libStorageMgmt daemon to execute when client user specifies targetd plugin in
+the URI.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBtargetd://<username>@<targetd_server>:<port number>\fR
+
+ # HTTPS connection
+ \fBtargetd+ssl://<username>@<targetd_server>:<port number>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account configured in targetd configuration
+file.
+
+.TP
+\fBtargetd_server\fR
+
+The \fBtargetd_server\fR is the IP address or DNS name of server running
+targetd daemon.
+
+.TP
+\fBport number\fR
+
+The \fBport number\fR is the listening port of the targetd daemon. The default
+port of 18700 is used if none is supplied on the URI.
+
+.TP
+\fBURI parameters\fR
+No additional URI parameters are supported by this plugin.
+
+.SH SUPPORTED SOFTWARE
+Linux targetd 0.7.1 or later version.
+Detailed support status can be queried via:
+
+ * \fBlsm.Client.capabilities()\fR (Python API)
+ * \fBlsm_capabilities()\fR (C API)
+ * \fBlsmcli capabilities\fR (lsmcli command line).
+
+.SH FIREWALL RULES
+By default, this plugin requires access to the targetd server's TCP 18700
+port.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), [1] https://github.com/agrover/targetd
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/packaging/libstoragemgmt.spec.in b/packaging/libstoragemgmt.spec.in
index b1392b6..92920e8 100644
--- a/packaging/libstoragemgmt.spec.in
+++ b/packaging/libstoragemgmt.spec.in
@@ -506,6 +506,7 @@ fi
%{_sysconfdir}/lsm/lsmd.conf
%dir %{_sysconfdir}/lsm
%dir %{_sysconfdir}/lsm/pluginconf.d
+%{_mandir}/man1/simc_lsmplugin.1*
%if 0%{?rhel} == 6
%{_sysconfdir}/bash_completion.d/lsmcli
@@ -556,6 +557,7 @@ fi
%{python_sitelib}/lsm/lsmcli/cmdline.*
%{_bindir}/sim_lsmplugin
%{_sysconfdir}/lsm/pluginconf.d/sim.conf
+%{_mandir}/man1/sim_lsmplugin.1*
%files -n %{libstoragemgmt}-smis-plugin
%defattr(-,root,root,-)
@@ -572,6 +574,7 @@ fi
%{python_sitelib}/lsm/plugin/smispy/smis_vol.*
%{python_sitelib}/lsm/plugin/smispy/smis_ag.*
%{_bindir}/smispy_lsmplugin
+%{_mandir}/man1/smispy_lsmplugin.1*
%files -n %{libstoragemgmt}-netapp-plugin
%defattr(-,root,root,-)
@@ -580,6 +583,7 @@ fi
%{python_sitelib}/lsm/plugin/ontap/na.*
%{python_sitelib}/lsm/plugin/ontap/ontap.*
%{_bindir}/ontap_lsmplugin
+%{_mandir}/man1/ontap_lsmplugin.1*
%files -n %{libstoragemgmt}-targetd-plugin
%defattr(-,root,root,-)
@@ -587,6 +591,7 @@ fi
%{python_sitelib}/lsm/plugin/targetd/__init__.*
%{python_sitelib}/lsm/plugin/targetd/targetd.*
%{_bindir}/targetd_lsmplugin
+%{_mandir}/man1/targetd_lsmplugin.1*
%files -n %{libstoragemgmt}-nstor-plugin
%defattr(-,root,root,-)
@@ -594,6 +599,7 @@ fi
%{python_sitelib}/lsm/plugin/nstor/__init__.*
%{python_sitelib}/lsm/plugin/nstor/nstor.*
%{_bindir}/nstor_lsmplugin
+%{_mandir}/man1/nstor_lsmplugin.1*
%if 0%{?with_megaraid}
%files -n %{libstoragemgmt}-megaraid-plugin
nstor_lsmpluging
ontap_lsmpluging
sim_lsmpluging
simc_lsmpluging
smispy_lsmpluging
targetd_lsmpluging
* Auto-tool files updated.
* RPM SPEC file updated by adding these manpage to their own rpm sub-package.
Changes in V2:
* Add the all plugin manpages.
* Remove known issue and detail support status section from smispy_lsmpluging
manpage.
Changes in V3:
* Merged Tony's patch into this.(Detailed changes listed below)
* Changed capital binary name in manpage title to lower case.
* Updated date from November to December.
* Fixed some typo and grammar issues.
* Added port URI argument to nstor_lsmplugin manpage.
* New section 'FIREWALL RULES' to indicate which default network access
requirement for each plugin.
* Added Tony and his email into 'AUTHOR' section.
* Removed white space.
Changes in V4:
* Rebased to current master.
* Update date string to 'June 2015'.
* Updated sim_lsmplugin.1.in for statefile description as we move to sqlite.
* Move URI parameters under(indented) 'URI parameters' section.
Check sim_lsmplugin.1.in and smispy_lsmplugin.1.in for example.
Signed-off-by: Gris Ge <***@redhat.com>
Signed-off-by: Tony Asleson <***@redhat.com>
---
configure.ac | 6 +++
doc/man/Makefile.am | 9 +++-
doc/man/nstor_lsmplugin.1.in | 68 ++++++++++++++++++++++++++++++
doc/man/ontap_lsmplugin.1.in | 67 +++++++++++++++++++++++++++++
doc/man/sim_lsmplugin.1.in | 55 ++++++++++++++++++++++++
doc/man/simc_lsmplugin.1.in | 42 +++++++++++++++++++
doc/man/smispy_lsmplugin.1.in | 91 ++++++++++++++++++++++++++++++++++++++++
doc/man/targetd_lsmplugin.1.in | 67 +++++++++++++++++++++++++++++
packaging/libstoragemgmt.spec.in | 6 +++
9 files changed, 409 insertions(+), 2 deletions(-)
create mode 100644 doc/man/nstor_lsmplugin.1.in
create mode 100644 doc/man/ontap_lsmplugin.1.in
create mode 100644 doc/man/sim_lsmplugin.1.in
create mode 100644 doc/man/simc_lsmplugin.1.in
create mode 100644 doc/man/smispy_lsmplugin.1.in
create mode 100644 doc/man/targetd_lsmplugin.1.in
diff --git a/configure.ac b/configure.ac
index a6cda95..e057e3f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -276,6 +276,12 @@ AC_OUTPUT(libstoragemgmt.pc \
doc/Makefile \
doc/man/lsmcli.1 \
doc/man/lsmd.1 \
+ doc/man/sim_lsmplugin.1 \
+ doc/man/simc_lsmplugin.1 \
+ doc/man/smispy_lsmplugin.1 \
+ doc/man/ontap_lsmplugin.1 \
+ doc/man/targetd_lsmplugin.1 \
+ doc/man/nstor_lsmplugin.1 \
doc/doxygen.conf \
doc/man/lsmd.conf.5 \
doc/man/megaraid_lsmplugin.1 \
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 19b536c..dc7e8ac 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -1,5 +1,10 @@
-notrans_dist_man1_MANS = lsmcli.1 lsmd.1
-
+notrans_dist_man1_MANS = lsmcli.1 lsmd.1 \
+ sim_lsmplugin.1 \
+ simc_lsmplugin.1 \
+ smispy_lsmplugin.1 \
+ ontap_lsmplugin.1 \
+ targetd_lsmplugin.1 \
+ nstor_lsmplugin.1
if WITH_MEGARAID
notrans_dist_man1_MANS += megaraid_lsmplugin.1
endif
diff --git a/doc/man/nstor_lsmplugin.1.in b/doc/man/nstor_lsmplugin.1.in
new file mode 100644
index 0000000..b39cd2e
--- /dev/null
+++ b/doc/man/nstor_lsmplugin.1.in
@@ -0,0 +1,68 @@
+.TH nstor_lsmplugin "1" "June 2015" "nstor_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+nstor_lsmplugin -- LibstorageMgmt nstor plugin
+
+.SH DESCRIPTION
+LibstorageMgmt nstor plugin allows user to manage NexentaStor 3.x
+storage software [1]. The 'nstor_lsmplugin' executable file is for libStorageMgmt
+daemon to execute when client user specifies nstor plugin in the URI.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBnstor://<username>@<nstor_server>:<port>\fR
+
+ # HTTPS connection
+ \fBnstor+ssl://<username>@<nstor_server>:<port>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account with 'Can_use_restapi' permission.
+
+.TP
+\fBnstor_server\fR
+
+The \fBnstor_server\fR is IP address or DNS name of
+NexentaStor server.
+
+.TP
+\fBport number\fR
+
+The \fBport number\fR is the listening port of the nexenta server REST API.
+The default port of 2000 is used if none is supplied on the URI.
+
+For non-default ports, SELinux will likely prevent the SMI-S plugin from making
+a network connection.
+
+.TP
+\fBURI parameters\fR
+No additional URI parameters are supported by this plugin.
+
+
+.SH SUPPORTED SOFTWARE
+NexentaStor 3.x is 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).
+
+.SH FIREWALL RULES
+By default, this plugin requires the access to the nstor array's TCP 2000 port.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), [1] http://nexentastor.org
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/ontap_lsmplugin.1.in b/doc/man/ontap_lsmplugin.1.in
new file mode 100644
index 0000000..ef0cd12
--- /dev/null
+++ b/doc/man/ontap_lsmplugin.1.in
@@ -0,0 +1,67 @@
+.TH ontap_lsmplugin "1" "June 2015" "ontap_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+ontap_lsmplugin -- LibstorageMgmt ONTAP Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt ontap plugin allows user to manage NetApp ONTAP storage arrays.
+The 'ontap_lsmplugin' executable file is for libStorageMgmt daemon to execute
+when client specifies ontap plugin in the URI
+
+This plugin requires NetApp ONTAP storage array to enable these options:
+
+ \fBoptions httpd.enable on\fR
+ \fBoptions httpd.admin.enable on\fR
+
+This options is required for HTTPS connection:
+
+ \fBoptions httpd.admin.ssl.enable on\fR
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBontap://<username>@<ontap_filer>\fR
+
+ # HTTPS connection
+ \fBontap+ssl://<username>@<ontap_filer>\fR
+
+.fi
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account with administration privilege.
+
+.TP
+\fBontap_filer_ip\fR
+
+The \fBontap_filer_ip\fR is the NetApp ONTAP filer IP address or DNS name.
+
+.TP
+\fBURI parameters\fR
+
+No additional URI parameters are supported by this plugin.
+
+.SH Supported Hardware
+NetApp ONTAP 8.x is 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).
+
+.SH FIREWALL RULES
+This plugin requires the access to the NetApp ONTAP Filer's TCP 80 port for
+HTTP connection and TCP 443 port for HTTPS connection.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/sim_lsmplugin.1.in b/doc/man/sim_lsmplugin.1.in
new file mode 100644
index 0000000..901761d
--- /dev/null
+++ b/doc/man/sim_lsmplugin.1.in
@@ -0,0 +1,55 @@
+.TH sim_lsmplugin "1" "June 2015" "sim_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+sim_lsmplugin -- LibStorageMgmt simulator python plugin
+
+.SH DESCRIPTION
+LibstorageMgmt simulator plugin is for development or test use only. The plugin
+simulates an array which supports most features of the library. State is stored
+in a file, default is '/tmp/lsm_sim_data'. The 'sim_lsmplugin' executable file is
+for libStorageMgmt daemon to execute when client user specifies sim plugin in
+the URI.
+
+This plugin is written in pure Python and is intended to be an example of a
+python plugin for the library.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # All that is required
+ sim://
+
+ # Optional statefile
+ sim://?statefile=<file path and name>
+
+.fi
+No password is required for this plugin.
+
+.TP
+\fBURI parameters\fR
+
+.RS 7
+.TP
+\fBstatefile\fR
+
+Use specified file to store simulator state data. Example URI:
+.nf
+ \fBsim://?statefile=/tmp/other_lsm_sim_data\fR
+.fi
+
+The statefile is a sqlite3 data base file.
+
+.SH FIREWALL RULES
+This plugin requires not network access.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/simc_lsmplugin.1.in b/doc/man/simc_lsmplugin.1.in
new file mode 100644
index 0000000..32484ad
--- /dev/null
+++ b/doc/man/simc_lsmplugin.1.in
@@ -0,0 +1,42 @@
+.TH simc_lsmplugin "1" "June 2015" "simc_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+simc_lsmplugin -- LibstorageMgmt Simulator C Plugin
+
+.SH DESCRIPTION
+LibStorageMgmt simulator C plugin is for development use. The plugin simulates
+an array which supports most features of the library. The simulator is memory
+based, state will be discarded once the plugin exits. The 'simc_lsmplugin'
+executable file is for the libStorageMgmt daemon to execute when client user
+specifies simc plugin in the URI.
+
+Since every command of lsmcli is a standalone libStorageMgmt session, this
+plugin is essentially useless for this purpose. In this use case, the
+libStorageMgmt simulator plugin \fBsim_lsmplugin(1)\fR is suggested.
+
+This plugin is written in pure C and is intended to be an example of a
+C plugin for the library.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ simc://
+
+.fi
+No password is required for this plugin.
+No URI parameters are supported by this plugin.
+
+.SH FIREWALL RULES
+This plugin requires not network access.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), \fBsim_lsmplugin\fR(1)
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/smispy_lsmplugin.1.in b/doc/man/smispy_lsmplugin.1.in
new file mode 100644
index 0000000..b07d428
--- /dev/null
+++ b/doc/man/smispy_lsmplugin.1.in
@@ -0,0 +1,91 @@
+.TH smispy_lsmplugin "1" "June 2015" "smispy_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+smispy_lsmplugin -- LibstorageMgmt SMI-S Plugin
+
+.SH DESCRIPTION
+LibstorageMgmt SMI-S Plugin allows LibstorageMgmt user to manage storage
+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 client user requests SMI-S plugin.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBsmispy://<username>@<smis_provder_host>:<port>?<uri_parameters>\fR
+
+ # HTTPS connection
+ \fBsmispy+ssl://<username>@<smis_provder_host>:<port>?<uri_parameters>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the SMI-S provider user account.
+
+.TP
+\fBsmis_provder_host\fR
+
+The \fBsmis_provder_host\fR is the SMI-S provider's IP address or DNS name.
+
+.TP
+\fBport\fR
+
+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-default ports, SELinux will likely prevent the SMI-S plugin from making
+a 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.
+
+.TP
+\fBsystem=<system_id>\fR
+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 of 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 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 Hardware
+The LibstorageMgmt SMI-S plugin is based on 'Block Services Package' profile
+, SNIA SMI-S 1.4 or later. Any storage system which 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).
+
+.SH FIREWALL RULES
+By default, this plugin requires access to the SMI-S provider's TCP 5988 port
+for HTTP conenction and TCP 5989 port for HTTPS connection.
+
+.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
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/doc/man/targetd_lsmplugin.1.in b/doc/man/targetd_lsmplugin.1.in
new file mode 100644
index 0000000..290efc9
--- /dev/null
+++ b/doc/man/targetd_lsmplugin.1.in
@@ -0,0 +1,67 @@
+.TH targetd_lsmplugin "1" "June 2015" "targetd_lsmplugin @VERSION@" "libStorageMgmt"
+.SH NAME
+targetd_lsmplugin -- libStorageMgmt targetd plugin
+
+.SH DESCRIPTION
+LibStorageMgmt targetd plugin allows user to manage storage using
+the targetd storage API [1]. The 'targetd_lsmplugin' executable file is for
+libStorageMgmt daemon to execute when client user specifies targetd plugin in
+the URI.
+
+.SH URI
+To use this plugin, users should set their URI to this format:
+.nf
+
+ # HTTP connection
+ \fBtargetd://<username>@<targetd_server>:<port number>\fR
+
+ # HTTPS connection
+ \fBtargetd+ssl://<username>@<targetd_server>:<port number>\fR
+
+.fi
+
+.TP
+\fBusername\fR
+
+The \fBusername\fR is the user account configured in targetd configuration
+file.
+
+.TP
+\fBtargetd_server\fR
+
+The \fBtargetd_server\fR is the IP address or DNS name of server running
+targetd daemon.
+
+.TP
+\fBport number\fR
+
+The \fBport number\fR is the listening port of the targetd daemon. The default
+port of 18700 is used if none is supplied on the URI.
+
+.TP
+\fBURI parameters\fR
+No additional URI parameters are supported by this plugin.
+
+.SH SUPPORTED SOFTWARE
+Linux targetd 0.7.1 or later version.
+Detailed support status can be queried via:
+
+ * \fBlsm.Client.capabilities()\fR (Python API)
+ * \fBlsm_capabilities()\fR (C API)
+ * \fBlsmcli capabilities\fR (lsmcli command line).
+
+.SH FIREWALL RULES
+By default, this plugin requires access to the targetd server's TCP 18700
+port.
+
+.SH SEE ALSO
+\fBlsmcli\fR(1), \fBlsmd\fR(1), [1] https://github.com/agrover/targetd
+
+.SH BUGS
+Please report bugs to
+\fI<libstoragemgmt-***@lists.sourceforge.net>\fR
+
+.SH AUTHOR
+Gris Ge \fI<***@redhat.com>\fR
+.br
+Tony Asleson \fI<***@redhat.com>\fR
diff --git a/packaging/libstoragemgmt.spec.in b/packaging/libstoragemgmt.spec.in
index b1392b6..92920e8 100644
--- a/packaging/libstoragemgmt.spec.in
+++ b/packaging/libstoragemgmt.spec.in
@@ -506,6 +506,7 @@ fi
%{_sysconfdir}/lsm/lsmd.conf
%dir %{_sysconfdir}/lsm
%dir %{_sysconfdir}/lsm/pluginconf.d
+%{_mandir}/man1/simc_lsmplugin.1*
%if 0%{?rhel} == 6
%{_sysconfdir}/bash_completion.d/lsmcli
@@ -556,6 +557,7 @@ fi
%{python_sitelib}/lsm/lsmcli/cmdline.*
%{_bindir}/sim_lsmplugin
%{_sysconfdir}/lsm/pluginconf.d/sim.conf
+%{_mandir}/man1/sim_lsmplugin.1*
%files -n %{libstoragemgmt}-smis-plugin
%defattr(-,root,root,-)
@@ -572,6 +574,7 @@ fi
%{python_sitelib}/lsm/plugin/smispy/smis_vol.*
%{python_sitelib}/lsm/plugin/smispy/smis_ag.*
%{_bindir}/smispy_lsmplugin
+%{_mandir}/man1/smispy_lsmplugin.1*
%files -n %{libstoragemgmt}-netapp-plugin
%defattr(-,root,root,-)
@@ -580,6 +583,7 @@ fi
%{python_sitelib}/lsm/plugin/ontap/na.*
%{python_sitelib}/lsm/plugin/ontap/ontap.*
%{_bindir}/ontap_lsmplugin
+%{_mandir}/man1/ontap_lsmplugin.1*
%files -n %{libstoragemgmt}-targetd-plugin
%defattr(-,root,root,-)
@@ -587,6 +591,7 @@ fi
%{python_sitelib}/lsm/plugin/targetd/__init__.*
%{python_sitelib}/lsm/plugin/targetd/targetd.*
%{_bindir}/targetd_lsmplugin
+%{_mandir}/man1/targetd_lsmplugin.1*
%files -n %{libstoragemgmt}-nstor-plugin
%defattr(-,root,root,-)
@@ -594,6 +599,7 @@ fi
%{python_sitelib}/lsm/plugin/nstor/__init__.*
%{python_sitelib}/lsm/plugin/nstor/nstor.*
%{_bindir}/nstor_lsmplugin
+%{_mandir}/man1/nstor_lsmplugin.1*
%if 0%{?with_megaraid}
%files -n %{libstoragemgmt}-megaraid-plugin
--
1.8.3.1
1.8.3.1