OpenLMI documentation suite

Russell Doty rdoty at redhat.com
Wed Oct 2 13:52:50 UTC 2013


On Wed, 2013-10-02 at 15:41 +0200, Jan Synacek wrote:
> On 10/02/2013 03:35 PM, Russell Doty wrote:
> > On Wed, 2013-10-02 at 08:00 +0200, Jan Synacek wrote:
> >> On 10/01/2013 07:37 PM, Russell Doty wrote:
> >>> Excellent work!
> >>>
> >>> I was looking at the Account Provider, specifically page
> >>> http://jsafrane.fedorapeople.org/openlmi-storage/scratch/doc/admin/all/clones/openlmi-providers/src/account/doc/source/usage.html#list-users
> >>>
> >>> In the example there is extensive us of name/value pairs. I can't find
> >>> where the available names and allowed values are documented; can you
> >>> point me to this?
> >>>
> >>> Thanks,
> >>> Russ
> >>>
> >>
> >> It's the old way how filtering was done (it should still work). The key
> >> parameter should be a property name of the instance/class you query, the value
> >> parameter should be its value.
> >>
> >> There is a bit of documentation about it at [1].
> >>
> >> In the recent lmishell, the named parameters have been replaced by python
> >> dictonaries. Instead of writing
> >>
> >> c.root.cimv2.LMI_Account.first_instance(key="name", value="root")
> >>
> >> you can use
> >>
> >> c.root.cimv2.LMI_Account.first_instance({"name": "root"})
> >>
> >> [1] https://fedorahosted.org/openlmi/wiki/shell/class#Filtering
> >>
> >> Cheers,
> > 
> > OK. Where/how do you find the available parameters?
> > 
> > I pulled the follow code fragment out of
> > http://jsafrane.fedorapeople.org/openlmi-storage/scratch/doc/admin/openlmi-storage/latest/usage-partitioning.html
> > 
> > # Find the disk
> > sda = root.LMI_StorageExtent.first_instance(
> >         Key="DeviceID",
> >         Value="/dev/sda")
> > 
> > How do I find out what parameters LMI_StorageExtent accepts? And what
> > values it expects for each parameter?
> > 
> > 
> 
> Possible key values are class properties. In your example, properties of
> LMI_StorageExtent. You can find those in mof files. Also, you can access the
> information via lmishell:
> 
> root.LMI_StorageExtent.doc()
> 
> Does this help?
Yes, it does.

Where do we cover this in the documentation? Do we have examples in
using lmishell that show how to get the available parameters? 

Assume a new to OpenLMI sysadmin who is searching the documentation and
Googling to try to do something. He sees this fragment and says "Aha!
That is close to what I need to do. What other parameters does it expect
and what is it looking for?"

We can't expect sysadmins to read the mof files...
> 




More information about the openlmi-devel mailing list