1 mateus.baur 1.5 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1.Z/cimprovider.1,v 1.4 2004/12/08 09:40:38 a.arora Exp $

  2 alagaraja   1.3 .\" .TA c \" lowercase initial letter of .TH name
  3                 .TH "cimprovider" "1" "" "" ""
  4                 .SH "NAME"
  5                 cimprovider \- disable, enable, remove , list or display status of registered CIM providers or 
  6                 CIM provider modules
  7                 .SH "SYNOPSIS"

  8 a.arora     1.4 \fBcimprovider\fP \fB\-d\fP \fB\-m\fP module
  9                 
 10                 \fBcimprovider\fP \fB\-e\fP \fB\-m\fP module
 11                 
 12                 \fBcimprovider\fP \fB\-r\fP \fB\-m\fP module [ \fB\-p\fP provider ]
 13                 
 14                 \fBcimprovider\fP \fB\-l\fP  [ \fB\-s\fP | \fB\-m\fP module ]
 15                 
 16                 \fBcimprovider\fP \fB\-h\fP
 17                 
 18                 \fBcimprovider\fP \fB\-\-help\fP
 19                 
 20                 \fBcimprovider\fP \fB\-\-version\fP

 21 kumpf       1.2 
 22                 .SS Remarks
 23                 The

 24 alagaraja   1.3 .B \-l

 25 kumpf       1.2 option for this command
 26                 can be executed by any user(s). All other options require superuser permissions.

 27 alagaraja   1.3 .PP 

 28 kumpf       1.2 This command disables, enables, or removes one CIM provider
 29                 module or CIM provider at a time.

 30 alagaraja   1.3 .SH "DESCRIPTION"

 31 kumpf       1.2 The 
 32                 .B cimprovider 
 33                 command provides a command line interface to disable, enable, unregister, and
 34                 list registered CIM providers.  If a CIM provider is disabled, the CIM Server 
 35                 rejects any requests to the provider.  If a CIM provider is enabled, the CIM 
 36                 Server forwards requests to the provider.  And if a CIM provider is 
 37                 unregistered, the CIM Server will no longer have any information about the 
 38                 provider.

 39 alagaraja   1.3 .PP 

 40 kumpf       1.2 In order to use the 
 41                 .B cimprovider 
 42                 command, 
 43                 .B cimserver
 44                 has to be running and 
 45                 the specified provider module (a grouping of providers 
 46                 in the same shared library) or provider has to be registered with WBEM Services.

 47 alagaraja   1.3 .PP 

 48 kumpf       1.2 The first form of 
 49                 .B cimprovider 
 50                 disables the specified provider module.  
 51                 When a specified provider module is in the disabled state, any
 52                 new requests to the providers that are contained in the specified provider module will be rejected.

 53 alagaraja   1.3 .PP 

 54 kumpf       1.2 The second form of 
 55                 .B cimprovider 
 56                 enables the providers that are contained in the specified provider module. 
 57                 The providers that are contained in the 
 58                 specified provider module are now ready to accept new requests.

 59 alagaraja   1.3 .PP 

 60 kumpf       1.2 The third form of 
 61                 .B cimprovider 

 62 alagaraja   1.3 removes (un\-registers) the specified provider module and all of its contained 

 63 kumpf       1.2 providers or the specified provider in the specified provider module.
 64                 Once removed, a provider or provider module

 65 alagaraja   1.3 must be re\-registered (typically by loading its registration schema via the 

 66 kumpf       1.2 .B cimmof 
 67                 command).

 68 alagaraja   1.3 .PP 

 69 kumpf       1.2 The last form of 
 70                 .B cimprovider 
 71                 lists all the registered provider modules and module status or 
 72                 all the providers in the specified provider module. To list all providers in 
 73                 all modules, issue 
 74                 a 

 75 alagaraja   1.3 .B cimprovider \-l 

 76 kumpf       1.2 command, followed by 

 77 alagaraja   1.3 .B cimprovider \-l \-m 

 78 kumpf       1.2 for each listed module.

 79 alagaraja   1.3 .PP 

 80 kumpf       1.2 Specifying no options with the 
 81                 .B cimprovider 
 82                 command displays the command
 83                 usage.
 84                 .SS Options
 85                 The 
 86                 .B cimprovider 
 87                 command recognizes the following options:
 88                 .RS
 89                 .TP 15

 90 alagaraja   1.3 .B \-d

 91 kumpf       1.2 Disables the specified CIM provider 

 92 alagaraja   1.3 .I R module . 

 93 kumpf       1.2 If user(s) try to disable a module that is already 
 94                 disabled, an error message is returned and no action is taken.

 95 alagaraja   1.3 .TP 
 96                 .B \-e

 97 kumpf       1.2 Enables the specified CIM provider 

 98 alagaraja   1.3 .I R module . 

 99 kumpf       1.2 If user(s) try to enable a module that is already enabled 
100                 or try to enable a module that is disabling, an error message is returned and 
101                 no action is taken.

102 alagaraja   1.3 .TP 
103                 .B \-h, \-\-help
104                 Display command usage information.
105                 .TP 
106                 .B \-l 
107                 Displays all the registered provider modules.
108                 .TP 
109                 \fB\-m\fP module
110                 Specifies the provider
111                 .I module
112                 for the operation.
113                 .TP 
114                 \fB\-p\fP provider
115                 Specifies the
116                 .I provider
117                 for the operation.
118                 .TP 
119                 .B \-r

120 kumpf       1.2 Removes the specified provider 
121                 .I module 
122                 and all of its contained providers.  If
123                 .I provider
124                 is specified, removes the specified 
125                 .I provider
126                 in the specified provider
127                 .I module
128                 (not affecting any other providers in that module).

129 alagaraja   1.3 .TP 
130                 .B \-s

131 kumpf       1.2 Displays the status of provider modules.

132 alagaraja   1.3 .TP 
133                 .B \-\-version
134                 Display CIM Server version number.
135                 .SH "EXIT STATUS"
136                 .PP 

137 kumpf       1.2 When an error occurs, an error message is written to stderr and an
138                 error value 1 is returned.  The following return values are returned:
139                 .RS

140 alagaraja   1.3 .TP 

141 kumpf       1.2 .B 0
142                 Successful completion
143                 .PD 0

144 alagaraja   1.3 .TP 

145 kumpf       1.2 .B 1
146                 Error
147                 .PD
148                 .RE

149 mateus.baur 1.5 .SH "USAGE NOTES"

150 alagaraja   1.3 .PP 
151                 The 
152                 .B cimprovider 

153 mateus.baur 1.5 command requires that the CIM Server is running. If an operation requires
154                 more than two minutes to be processed, the
155                 .B cimprovider 
156                 command prints a timeout message and returns an error value.

157 alagaraja   1.3 .SH "EXAMPLES "
158                 .PP 

159 kumpf       1.2 Disable provider module "OperatingSystemProvider" and 
160                 all of its contained providers (placing them in a stopped state).

161 alagaraja   1.3 .IP 
162                 .B cimprovider \-d \-m OperatingSystemProvider
163                 .PP 

164 kumpf       1.2 Enable provider module "OperatingSystemProvider" and 
165                 all of its contained providers (placing them in an OK state).

166 alagaraja   1.3 .IP 
167                 .B cimprovider \-e \-m OperatingSystemProvider
168                 .PP 
169                 Remove (un\-register) the "OperatingSystemProvider" 

170 kumpf       1.2 provider module and all of its contained providers.

171 alagaraja   1.3 .IP 
172                 .B cimprovider \-r \-m OperatingSystemProvider
173                 .PP 
174                 Remove (un\-register) the "PG_OperatingSystemProvider" 

175 kumpf       1.2 provider that is contained in the "OperatingSystemProvider" provider module.

176 alagaraja   1.3 .IP 
177                 .B cimprovider \-r \-m OperatingSystemProvider \-p PG_OperatingSystemProvider
178                 .PP 

179 kumpf       1.2 List the registered provider modules.

180 alagaraja   1.3 .IP 
181                 .B cimprovider \-l
182                 .PP 

183 kumpf       1.2 List the registered provider modules and their status 
184                 (such as OK, Stopping, Stopped).

185 alagaraja   1.3 .IP 
186                 .B cimprovider \-l \-s
187                 .PP 

188 kumpf       1.2 List the registered providers which are contained in the 
189                 "OperatingSystemProvider" provider module.

190 alagaraja   1.3 .IP 
191                 .B cimprovider \-l \-m OperatingSystemProvider
192                 .SH "SEE ALSO"
193                 .PP 
194                 cimmof(1), cimserver(1).