diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-03-16 13:05:40 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-03-16 13:05:40 -0400 |
| commit | 70e0348a4585de4fa95d31eab218d96bfbcd3928 (patch) | |
| tree | 5d92b02b16dff6eb915f475f255d4a5f5908f88f /doc | |
| parent | 0c290ce54d1be854ebc60eedfff89ef16d998727 (diff) | |
| download | bcfg2-70e0348a4585de4fa95d31eab218d96bfbcd3928.tar.gz bcfg2-70e0348a4585de4fa95d31eab218d96bfbcd3928.tar.bz2 bcfg2-70e0348a4585de4fa95d31eab218d96bfbcd3928.zip | |
improved MetadataQuery docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/server/plugins/grouping/metadata.txt | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/doc/server/plugins/grouping/metadata.txt b/doc/server/plugins/grouping/metadata.txt index c52ac7612..305857578 100644 --- a/doc/server/plugins/grouping/metadata.txt +++ b/doc/server/plugins/grouping/metadata.txt @@ -276,22 +276,37 @@ A special client metadata class is available to the MetadataQuery ------------- -This class provides query routines for the servers Metadata. +This class provides query methods for the metadata of all clients +known to the Bcfg2 server. Note that ``*by_groups()`` and +``*by_profiles()`` behave differently; for a client to be included in +the return value of a ``by_groups()`` method, it must be a member of +*all* groups listed in the argument; for a client to be included in +the return value of a ``by_profiles()`` method, it must have any group +listed as its profile group. +------------------------------+------------------------------------------------+-------------------+ | Method | Description | Value | +==============================+================================================+===================+ | by_name(client) | Get ClientMetadata object for 'client' | ClientMetadata | +------------------------------+------------------------------------------------+-------------------+ -| names_by_groups(groups) | All client names in the list of 'groups' | List | +| by_groups(groups) | Get ClientMetadata object for clients in all | List of | +| | listed groups | ClientMetadata | +------------------------------+------------------------------------------------+-------------------+ -| names_by_profiles(profiles) | All client names in the list of 'profiles' | List | +| by_profiles(client) | Get ClientMetadata objects for clients whose | List of | +| | profile matches any listed profile group | ClientMetadata | +------------------------------+------------------------------------------------+-------------------+ -| all_clients() | All known client hostnames | List | +| names_by_groups(groups) | Get the names of all clients in all listed | List of strings | +| | groups | | +------------------------------+------------------------------------------------+-------------------+ -| all_groups() | All known group names | List | +| names_by_profiles(profiles) | Get the names of clients whose profile matches | List of strings | +| | any listed profile group | | +------------------------------+------------------------------------------------+-------------------+ -| all_groups_in_category(cat) | All groups in category 'cat' | List | +| all_clients() | All known client hostnames | List of strings | +------------------------------+------------------------------------------------+-------------------+ -| all() | Get ClientMetadata for all clients | List | +| all_groups() | All known group names | List of strings | ++------------------------------+------------------------------------------------+-------------------+ +| all_groups_in_category(cat) | The names of all groups in category 'cat' | List of strings | ++------------------------------+------------------------------------------------+-------------------+ +| all() | Get ClientMetadata for all clients | List of | +| | | ClientMetadata | +------------------------------+------------------------------------------------+-------------------+ |