1 kumpf 1.2 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1m.Z/Attic/cimprovider.1m,v 1.1.2.1 2002/12/19 00:56:51 kumpf Exp $
  2           .TA c \" lowercase initial letter of .TH name
  3           .TH cimprovider 1M
  4           .SH NAME
  5           cimprovider \- disable, enable, remove or list registered CIM providers or 
  6           CIM provider modules and module status
  7           .SH SYNOPSIS
  8           
  9           \fBcimprovider -d -m\fP  module
 10           
 11           \fBcimprovider -e -m\fP module
 12           
 13           \fBcimprovider -r -m\fP module [ \fB-p\fP provider ]
 14           
 15           \fBcimprovider -l\fP [ \fB-s\fP | \fB-m\fP module ]
 16           .SS Remarks
 17           The
 18           .B -l
 19           option for this command
 20           can be executed by any user(s). All other options require superuser permissions.
 21           .PP
 22 kumpf 1.2 This command disables, enables, or removes one CIM provider
 23           module or CIM provider at a time.
 24           .SH DESCRIPTION
 25           The 
 26           .B cimprovider 
 27           command provides a command line interface to disable, enable, unregister, and
 28           list registered CIM providers.  If a CIM provider is disabled, the CIM Server 
 29           rejects any requests to the provider.  If a CIM provider is enabled, the CIM 
 30           Server forwards requests to the provider.  And if a CIM provider is 
 31           unregistered, the CIM Server will no longer have any information about the 
 32           provider.
 33           .PP
 34           In order to use the 
 35           .B cimprovider 
 36           command, 
 37           .B cimserver
 38           has to be running and 
 39           the specified provider module (a grouping of providers 
 40           in the same shared library) or provider has to be registered with WBEM Services.
 41           .PP
 42           The first form of 
 43 kumpf 1.2 .B cimprovider 
 44           disables the specified provider module.  
 45           When a specified provider module is in the disabled state, any
 46           new requests to the providers that are contained in the specified provider module will be rejected.
 47           .PP
 48           The second form of 
 49           .B cimprovider 
 50           enables the providers that are contained in the specified provider module. 
 51           The providers that are contained in the 
 52           specified provider module are now ready to accept new requests.
 53           .PP
 54           The third form of 
 55           .B cimprovider 
 56           removes (un-registers) the specified provider module and all of its contained 
 57           providers or the specified provider in the specified provider module.
 58           Once removed, a provider or provider module
 59           must be re-registered (typically by loading its registration schema via the 
 60           .B cimmof 
 61           command).
 62           .PP
 63           The last form of 
 64 kumpf 1.2 .B cimprovider 
 65           lists all the registered provider modules and module status or 
 66           all the providers in the specified provider module. To list all providers in 
 67           all modules, issue 
 68           a 
 69           .C "cimprovider -l"
 70           command, followed by 
 71           .C "cimprovider -l -m" 
 72           for each listed module.
 73           .PP
 74           Specifying no options with the 
 75           .B cimprovider 
 76           command displays the command
 77           usage.
 78           .SS Options
 79           The 
 80           .B cimprovider 
 81           command recognizes the following options:
 82           .RS
 83           .TP 15
 84           .B -d
 85 kumpf 1.2 Disables the specified CIM provider 
 86           .IR module . 
 87           If user(s) try to disable a module that is already 
 88           disabled, an error message is returned and no action is taken.
 89           .TP
 90           .B -e
 91           Enables the specified CIM provider 
 92           .IR module . 
 93           If user(s) try to enable a module that is already enabled 
 94           or try to enable a module that is disabling, an error message is returned and 
 95           no action is taken.
 96           .TP
 97           .B -r
 98           Removes the specified provider 
 99           .I module 
100           and all of its contained providers.  If
101           .I provider
102           is specified, removes the specified 
103           .I provider
104           in the specified provider
105           .I module
106 kumpf 1.2 (not affecting any other providers in that module).
107           .TP
108           .B -l 
109           Displays all the registered provider modules.
110           .TP
111           .CI -m \0module
112           Specifies the provider
113           .I module
114           for the operation.
115           .TP
116           .CI -p \0provider
117           Specifies the
118           .I provider
119           for the operation.
120           .TP
121           .CI -s
122           Displays the status of provider modules.
123           .SH EXIT STATUS
124           .PP
125           When an error occurs, an error message is written to stderr and an
126           error value 1 is returned.  The following return values are returned:
127 kumpf 1.2 .RS
128           .TP
129           .B 0
130           Successful completion
131           .PD 0
132           .TP
133           .B 1
134           Error
135           .PD
136           .RE
137           .SH EXAMPLES 
138           .PP
139           Disable provider module "OperatingSystemProvider" and 
140           all of its contained providers (placing them in a stopped state).
141           .IP
142           .B " cimprovider -d -m OperatingSystemProvider"
143           .PP
144           Enable provider module "OperatingSystemProvider" and 
145           all of its contained providers (placing them in an OK state).
146           .IP
147           .B "cimprovider -e -m OperatingSystemProvider"
148 kumpf 1.2 .PP
149           Remove (un-register) the "OperatingSystemProvider" 
150           provider module and all of its contained providers.
151           .IP
152           .B "cimprovider -r -m OperatingSystemProvider"
153           .PP
154           Remove (un-register) the "PG_OperatingSystemProvider" 
155           provider that is contained in the "OperatingSystemProvider" provider module.
156           .IP
157           .B "cimprovider -r -m OperatingSystemProvider -p PG_OperatingSystemProvider"
158           .PP
159           List the registered provider modules.
160           .IP
161           .B "cimprovider -l"
162           .PP
163           List the registered provider modules and their status 
164           (such as OK, Stopping, Stopped).
165           .IP
166           .B "cimprovider -l -s"
167           .PP
168           List the registered providers which are contained in the 
169 kumpf 1.2 "OperatingSystemProvider" provider module.
170           .IP
171           .B "cimprovider -l -m OperatingSystemProvider"
172           .SH SEE ALSO
173           .PP
174           cimmof(1), cimserver(1M).