summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichal Minar <miminar@redhat.com>2013-11-11 10:36:53 +0100
committerMichal Minar <miminar@redhat.com>2013-11-19 10:24:59 +0100
commit68701bba1abab3211cf115c9634ee19da3e09d78 (patch)
tree35856f8c4d1116ed47aaa311cc28d9dd164d1506 /doc
parent7362cc315112254f1275a9e03286db86f9c13191 (diff)
downloadopenlmi-providers-68701bba1abab3211cf115c9634ee19da3e09d78.tar.gz
openlmi-providers-68701bba1abab3211cf115c9634ee19da3e09d78.tar.xz
openlmi-providers-68701bba1abab3211cf115c9634ee19da3e09d78.zip
software: admin guide corrections
Epoch part can be omitted in InstanceID key property of LMI_SoftwareIdentity only if it's equal to zero. Fixed example explaining package searching. Missing back slash caused that regular expression rendered incorrectly. Removed blanks at line ends. Resolves ticket #175
Diffstat (limited to 'doc')
-rw-r--r--doc/admin/software/dmtf.rst115
-rw-r--r--doc/admin/software/usage.rst2
2 files changed, 59 insertions, 58 deletions
diff --git a/doc/admin/software/dmtf.rst b/doc/admin/software/dmtf.rst
index 9aa460c..d68692c 100644
--- a/doc/admin/software/dmtf.rst
+++ b/doc/admin/software/dmtf.rst
@@ -25,12 +25,12 @@ managed system.
Not implemented optional features
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This implementation does not support:
-
+
Representing a Software Bundle
Software bundle is represented by LMI_SoftwareIndentity instance
having ``"Software Bundle"`` value present in its ``Classifications``
property. It shall prepresent software groups. It extends the profile
- for subclasses of ``CIM_OrderedComponent``.
+ for subclasses of ``CIM_OrderedComponent``.
Representing Installation Dependencies
Dependencies between software packages are also unimplemented. This
@@ -72,7 +72,7 @@ This implementetion composes ``VersionString`` in following way: ::
<Epoch>:<Version>-<Release>.<Architecture>
The algorithm for comparing two RPM packages version is following:
-
+
1. Compare the ``Epoch`` (which is a number) of both packages. The one
with higher epoch is newer. If they match, continue to point 2.
2. Compare their ``Version`` attributes with `rpmvercmp`_ algorithm.
@@ -106,10 +106,11 @@ representing RPM packages. It's composed of following strings: ::
LMI:LMI_SoftwareIdentity:<Name>-<Epoch>:<Version>-<Release>.<Architecture>
-Where the prefix ``"LMI:LMI_SoftwareIdentity:"`` is compared case-insensitively.
-The rest is also known as a *NEVRA*. When calling ``GetInstance()`` on this
-class, the ``"<Epoch>:"`` part can be omitted in the ``InstanceID`` key property
-of passed ``InstanceName``.
+Where the prefix ``"LMI:LMI_SoftwareIdentity:"`` is compared
+case-insensitively. The rest is also known as a *NEVRA*. When calling
+``GetInstance()`` on this class, the ``"<Epoch>:"`` part can be omitted in the
+``InstanceID`` key property of passed ``InstanceName`` in case the epoch is
+zero.
Example
^^^^^^^
@@ -142,7 +143,7 @@ List of additional attributes of ``LMI_SoftwareIdentity``:
List of additional attributes of ``LMI_SoftwareIdentityResource``:
- ``Cost`` : sint32
+ ``Cost`` : sint32
Relative cost of accessing this repository.
``GPGCheck`` : boolean
Whether the GPG signature check should be performed.
@@ -152,28 +153,28 @@ List of additional attributes of ``LMI_SoftwareIdentityResource``:
Class overview
~~~~~~~~~~~~~~
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | Class-name | Parent_class | Type |
- +===============================================================================+=====================================================================+==================+
- | :ref:`LMI_SoftwareIdentity<LMI-SoftwareIdentity>` | :ref:`CIM_SoftwareIdentity<CIM-SoftwareIdentity>` | Plain |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_SystemSoftwareCollection<LMI-SystemSoftwareCollection>` | :ref:`CIM_SystemSpecificCollection<CIM-SystemSpecificCollection>` | Plain |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_SoftwareIdentityResource<LMI-SoftwareIdentityResource>` | :ref:`CIM_SoftwareIdentityResource<CIM-SoftwareIdentityResource>` | Plain |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_HostedSoftwareCollection<LMI-HostedSoftwareCollection>` | :ref:`CIM_HostedCollection<CIM-HostedCollection>` | Association |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_InstalledSoftwareIdentity<LMI-InstalledSoftwareIdentity>` | :ref:`CIM_InstalledSoftwareIdentity<CIM-InstalledSoftwareIdentity>` | Association |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_HostedSoftwareIdentityResource<LMI-HostedSoftwareIdentityResource>` | :ref:`CIM_HostedAccessPoint<CIM-HostedAccessPoint>` | Association |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_ResourceForSoftwareIdentity<LMI-ResourceForSoftwareIdentity>` | :ref:`CIM_SAPAvailableForElement<CIM-SAPAvailableForElement>` | Association |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
- | :ref:`LMI_MemberOfSoftwareCollection<LMI-MemberOfSoftwareCollection>` | :ref:`CIM_MemberOfCollection<CIM-MemberOfCollection>` | Aggregation |
- +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | Class-name | Parent_class | Type |
+ +===============================================================================+=====================================================================+==================+
+ | :ref:`LMI_SoftwareIdentity<LMI-SoftwareIdentity>` | :ref:`CIM_SoftwareIdentity<CIM-SoftwareIdentity>` | Plain |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_SystemSoftwareCollection<LMI-SystemSoftwareCollection>` | :ref:`CIM_SystemSpecificCollection<CIM-SystemSpecificCollection>` | Plain |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_SoftwareIdentityResource<LMI-SoftwareIdentityResource>` | :ref:`CIM_SoftwareIdentityResource<CIM-SoftwareIdentityResource>` | Plain |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_HostedSoftwareCollection<LMI-HostedSoftwareCollection>` | :ref:`CIM_HostedCollection<CIM-HostedCollection>` | Association |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_InstalledSoftwareIdentity<LMI-InstalledSoftwareIdentity>` | :ref:`CIM_InstalledSoftwareIdentity<CIM-InstalledSoftwareIdentity>` | Association |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_HostedSoftwareIdentityResource<LMI-HostedSoftwareIdentityResource>` | :ref:`CIM_HostedAccessPoint<CIM-HostedAccessPoint>` | Association |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_ResourceForSoftwareIdentity<LMI-ResourceForSoftwareIdentity>` | :ref:`CIM_SAPAvailableForElement<CIM-SAPAvailableForElement>` | Association |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
+ | :ref:`LMI_MemberOfSoftwareCollection<LMI-MemberOfSoftwareCollection>` | :ref:`CIM_MemberOfCollection<CIM-MemberOfCollection>` | Aggregation |
+ +-------------------------------------------------------------------------------+---------------------------------------------------------------------+------------------+
.. seealso::
- Class model in :ref:`introduction` where above classes are coloured blue.
+ Class model in :ref:`introduction` where above classes are coloured blue.
.. _software_update_profile:
@@ -256,36 +257,36 @@ allowing to create complex queries on package database.
Class overview
~~~~~~~~~~~~~~
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | Class-name | Parent_class | Type |
- +=====================================================================================================+=========================================================================+====================+
- | :ref:`LMI_SoftwareInstallationService<LMI-SoftwareInstallationService>` | :ref:`CIM_SoftwareInstallationService<CIM-SoftwareInstallationService>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | :ref:`LMI_ConcreteJob<LMI-ConcreteJob>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareInstallationJob<LMI-SoftwareInstallationJob>` | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareVerificationJob<LMI-SoftwareVerificationJob>` | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | Association |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareMethodResult<LMI-SoftwareMethodResult>` | :ref:`LMI_MethodResult<LMI-MethodResult>` | Association |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareIdentityFileCheck<LMI-SoftwareIdentityFileCheck>` | :ref:`CIM_FileSpecification<CIM-FileSpecification>` | Association |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareInstallationServiceAffectsElement<LMI-SoftwareInstallationServiceAffectsElement>` | :ref:`CIM_ServiceAffectsElement<CIM-ServiceAffectsElement>` | Association |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_SoftwareIdentityChecks<LMI-SoftwareIdentityChecks>` | | Aggregation |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_HostedSoftwareInstallationService<LMI-HostedSoftwareInstallationService>` | :ref:`CIM_HostedService<CIM-HostedService>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_AffectedSoftwareJobElement<LMI-AffectedSoftwareJobElement>` | :ref:`CIM_AffectedJobElement<CIM-AffectedJobElement>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_OwningSoftwareJobElement<LMI-OwningSoftwareJobElement>` | :ref:`LMI_OwningJobElement<LMI-OwningJobElement>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
- | :ref:`LMI_AssociatedSoftwareJobMethodResult<LMI-AssociatedSoftwareJobMethodResult>` | :ref:`LMI_AssociatedJobMethodResult<LMI-AssociatedJobMethodResult>` | Plain |
- +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | Class-name | Parent_class | Type |
+ +=====================================================================================================+=========================================================================+====================+
+ | :ref:`LMI_SoftwareInstallationService<LMI-SoftwareInstallationService>` | :ref:`CIM_SoftwareInstallationService<CIM-SoftwareInstallationService>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | :ref:`LMI_ConcreteJob<LMI-ConcreteJob>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareInstallationJob<LMI-SoftwareInstallationJob>` | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareVerificationJob<LMI-SoftwareVerificationJob>` | :ref:`LMI_SoftwareJob<LMI-SoftwareJob>` | Association |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareMethodResult<LMI-SoftwareMethodResult>` | :ref:`LMI_MethodResult<LMI-MethodResult>` | Association |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareIdentityFileCheck<LMI-SoftwareIdentityFileCheck>` | :ref:`CIM_FileSpecification<CIM-FileSpecification>` | Association |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareInstallationServiceAffectsElement<LMI-SoftwareInstallationServiceAffectsElement>` | :ref:`CIM_ServiceAffectsElement<CIM-ServiceAffectsElement>` | Association |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_SoftwareIdentityChecks<LMI-SoftwareIdentityChecks>` | | Aggregation |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_HostedSoftwareInstallationService<LMI-HostedSoftwareInstallationService>` | :ref:`CIM_HostedService<CIM-HostedService>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_AffectedSoftwareJobElement<LMI-AffectedSoftwareJobElement>` | :ref:`CIM_AffectedJobElement<CIM-AffectedJobElement>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_OwningSoftwareJobElement<LMI-OwningSoftwareJobElement>` | :ref:`LMI_OwningJobElement<LMI-OwningJobElement>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
+ | :ref:`LMI_AssociatedSoftwareJobMethodResult<LMI-AssociatedSoftwareJobMethodResult>` | :ref:`LMI_AssociatedJobMethodResult<LMI-AssociatedJobMethodResult>` | Plain |
+ +-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+--------------------+
.. seealso::
- Class model in :ref:`introduction` where above classes are coloured blue.
+ Class model in :ref:`introduction` where above classes are coloured blue.
..
***************************************************************************
@@ -295,6 +296,6 @@ Class overview
------------------------------------------------------------------------------
-.. [1] Precisely they must match following regular expression `r"[\w.+{}]+"`.
+.. [1] Precisely they must match following regular expression `r"[\\w.+{}]+"`.
.. [2] Because internally the query is executed upon the list obtained by
enumeration of instances.
diff --git a/doc/admin/software/usage.rst b/doc/admin/software/usage.rst
index 251b4e2..1ae0493 100644
--- a/doc/admin/software/usage.rst
+++ b/doc/admin/software/usage.rst
@@ -155,7 +155,7 @@ we may query package database in the following way.
::
c = connect("host", "user", "pass")
- service = LMI_SoftwareInstallationService.first_instance()
+ service = c.root.cimv2.LMI_SoftwareInstallationService.first_instance()
# let's find all packages with "openlmi" in Name or Summary without
# architecture specific code
ret = service.FindIdentity(Name="openlmi", Architecture="noarch")