local_lsmplugin(1)

1local_lsmplugin(1)              libStorageMgmt              local_lsmplugin(1)
2
3
4

NAME

6       local_lsmplugin -- LibstorageMgmt Local Pseudo plugin
7
8

DESCRIPTION

10       LibstorageMgmt  local plugin allows user to manage locally storage sys‐
11       tem  without  caring  which  real  plugin(s)  should  be   used.    The
12       'local_lsmplugin'  executable file is for libStorageMgmt daemon to exe‐
13       cute when client user specifies local plugin in the URI.
14
15       Currently, local plugin wraps these plugins:
16
17           * MegaRAID plugin -- `megariad_lsmplugin(1)`.
18           * SmartArray plugin -- `hpsa_lsmplugin(1)`.
19           * Adaptec plugin -- `arcconf_lsmplugin(1)`.
20           * NFS plugin -- `nfs_lsmplugin(1)`.
21
22       Specific binary tool may be required, please  check  error  message  or
23       manpage of above plugins.
24
25       To load NFS plugin, kernel module 'nfsd' should be loaded.
26
27

URI

29       To use this plugin, users should set their URI to this format:
30
31           local://
32               or
33           local://?parameter_name=<value>
34
35
36
37
38       URI parameters
39              These URI parameters are supported by this plugin:
40
41
42              ignore_init_error=true
43
44                     The  'ignore_init_error'  URI parameter is used to ignore
45                     errors when initializing real plugins. But  if  no  valid
46                     system are found, an error will still be raised.
47
48                     By default, all errors will be raised.
49
50
51              only=<plugin_name>
52
53                     The  'only'  URI  parameter is used to force local plugin
54                     only load specific real plugin.
55
56                     By default, all plugins will be loaded if supported hard‐
57                     ware has been found.
58
59
60              <plugin_name>_<uri_parameter_name>=<value>
61
62                     This  URI parameter format is used to pass URI parameters
63                     to  real   plugin.    For   example,   to   pass   'stor‐
64                     cli=/usr/bin/storcli'  URI  parameter to MegaRAID plugin,
65                     you would use 'megaraid_storcli=/usr/bin/storcli'.
66
67

ROOT PRIVILEGE

69       This plugin requires both lsmd daemon and API client  running  as  root
70       user. Please check manpage lsmd.conf [4m(5) for details.
71
72

SUPPORTED HARDWARES

74       Please refer to these manpages for hardware support status.
75           * MegaRAID plugin -- `megariad_lsmplugin(1)`.
76           * SmartArray plugin -- `hpsa_lsmplugin(1)`.
77           * Adaptec plugin -- `arcconf_lsmplugin(1)`.
78           * NFS plugin -- `nfs_lsmplugin(1)`.
79
80       Detailed support status can be queried via:
81
82        * lsm.Client.capabilities()  (Python API)
83        * lsm_capabilities()         (C API)
84        * lsmcli capabilities        (lsmcli command line).
85
86

FIREWALL RULES

88       This  plugin  only  executes  tools on localhost. No network connection
89       required.
90
91

BUGS

97       Please report bugs to <libstoragemgmt-devel@lists.fedorahosted.org>
98
99

AUTHOR

101       Gris Ge <fge@redhat.com>
102
103
104
105local_lsmplugin 1.7.3              July 2017                local_lsmplugin(1)