|
435 | 435 | <error name="JOURNALVARIABLEALIASALREADYEXISTS" code="435" description="Journal variable alias already exists." />
|
436 | 436 | <error name="INVALIDALIASINDEX" code="436" description="Invalid alias index" />
|
437 | 437 | <error name="SOURCEOFJOURNALALIASNOTFOUND" code="437" description="Source of Journal Alias not found" />
|
| 438 | + <error name="COULDNOTFINDMACHINECONFIGURATIONTYPE" code="438" description="Could not find machine configuration type." /> |
| 439 | + |
438 | 440 |
|
439 | 441 | </errors>
|
440 | 442 |
|
|
880 | 882 | <method name="GetSHA2" description="returns the sha256 checksum of a storage stream.">
|
881 | 883 | <param name="SHA2" type="string" pass="return" description="SHA1 String" />
|
882 | 884 | </method>
|
| 885 | + |
| 886 | + <method name="EnsureSHA256IsValid" description="checks if the SHA256 is matching the computed SHA256 on disk. Will fail if there is a mismatch. Attention: Computation will take some time."> |
| 887 | + </method> |
| 888 | + |
883 | 889 |
|
884 | 890 | <method name="GetSize" description="returns the size of a storage stream.">
|
885 | 891 | <param name="Size" type="uint64" pass="return" description="Size" />
|
|
1497 | 1503 | </class>
|
1498 | 1504 |
|
1499 | 1505 |
|
1500 |
| - |
1501 | 1506 | <!-- The UserList class is not thread safe and MUST ONLY be used in a single thread context... -->
|
1502 | 1507 | <class name="UserList" parent="Base" description="List of users">
|
1503 | 1508 |
|
|
1741 | 1746 |
|
1742 | 1747 | </class>
|
1743 | 1748 |
|
| 1749 | + <!-- The MachineConfigurationVersion class is not thread safe and MUST ONLY be used in a single thread context... --> |
| 1750 | + <class name="MachineConfigurationVersion" parent="Base" description="Machine configuration XSD instance."> |
| 1751 | + |
| 1752 | + <method name="GetVersionUUID" description="Returns the UUID."> |
| 1753 | + <param name="VersionUUID" type="string" pass="return" description="UUID of the configuration version." /> |
| 1754 | + </method> |
| 1755 | + |
| 1756 | + <method name="GetXSDUUID" description="Returns the UUID."> |
| 1757 | + <param name="XSDUUID" type="string" pass="return" description="UUID of the configuration XSD." /> |
| 1758 | + </method> |
| 1759 | + |
| 1760 | + <method name="GetTypeUUID" description="Returns the UUID of the corresponding Configuration type."> |
| 1761 | + <param name="TypeUUID" type="string" pass="return" description="UUID of the configuration type." /> |
| 1762 | + </method> |
| 1763 | + |
| 1764 | + <method name="GetParentUUID" description="Returns the UUID of the parent Configuration Version."> |
| 1765 | + <param name="ParentUUID" type="string" pass="return" description="UUID of the configuration version that is the parent of this version. Returns 00000000-0000-0000-0000-000000000000, if Version is the default configuration." /> |
| 1766 | + </method> |
| 1767 | + |
| 1768 | + <method name="GetSchemaType" description="Returns the Schema type of the configuration."> |
| 1769 | + <param name="SchemaType" type="string" pass="return" description="Schema type of the configuration type." /> |
| 1770 | + </method> |
| 1771 | + |
| 1772 | + <method name="GetXSDVersion" description="Returns the version number of the XSD in use.."> |
| 1773 | + <param name="XSDVersion" type="uint32" pass="return" description="Returns the XSD version." /> |
| 1774 | + </method> |
| 1775 | + |
| 1776 | + <method name="GetXSDString" description="Returns the XSD in use as string.."> |
| 1777 | + <param name="XSDString" type="string" pass="return" description="XSD String." /> |
| 1778 | + </method> |
| 1779 | + |
| 1780 | + <method name="GetConfigurationXMLString" description="Returns the configuration XML as String."> |
| 1781 | + <param name="XMLString" type="string" pass="return" description="XML String." /> |
| 1782 | + </method> |
| 1783 | + |
| 1784 | + <method name="CreateNewVersion" description="Creates a new configuration version from this version with the same XSD."> |
| 1785 | + <param name="XMLString" type="string" pass="in" description="New XML Configuration String. MUST conform to current XSD." /> |
| 1786 | + <param name="UserUUID" type="string" pass="in" description="User UUID for logging the user who initiated the change." /> |
| 1787 | + <param name="TimeStampUTC" type="string" pass="in" description="Current time in UTC." /> |
| 1788 | + <param name="CurrentInstance" type="class" class="MachineConfigurationVersion" pass="return" description="returns the MachineConfigurationVersion instance."/> |
| 1789 | + </method> |
| 1790 | + |
| 1791 | + <method name="MigrateToNewXSD" description="Creates a new configuration version from this version with another XSD."> |
| 1792 | + <param name="NewXSD" type="class" class="MachineConfigurationXSD" pass="in" description="New XSD to use. MUST be of the same type as the current. MUST have an increased version number."/> |
| 1793 | + <param name="XMLString" type="string" pass="in" description="New XML Configuration String. MUST conform to new XSD." /> |
| 1794 | + <param name="UserUUID" type="string" pass="in" description="User UUID for logging the user who initiated the change." /> |
| 1795 | + <param name="TimeStampUTC" type="string" pass="in" description="Current time in UTC." /> |
| 1796 | + <param name="CurrentInstance" type="class" class="MachineConfigurationVersion" pass="return" description="returns the MachineConfigurationVersion instance."/> |
| 1797 | + </method> |
| 1798 | + |
| 1799 | + </class> |
| 1800 | + |
| 1801 | + |
| 1802 | + <!-- The AlertIterator class is not thread safe and MUST ONLY be used in a single thread context... --> |
| 1803 | + <class name="MachineConfigurationVersionIterator" parent="Iterator"> |
| 1804 | + <method name="GetCurrentVersion" description="Returns the version the iterator points at."> |
| 1805 | + <param name="CurrentInstance" type="handle" class="MachineConfigurationVersion" pass="return" description="returns the MachineConfigurationVersion instance."/> |
| 1806 | + </method> |
| 1807 | + </class> |
| 1808 | + |
| 1809 | + <!-- The MachineConfigurationType class is not thread safe and MUST ONLY be used in a single thread context... --> |
| 1810 | + <class name="MachineConfigurationXSD" parent="Base" description="Machine configuration XSD instance."> |
| 1811 | + |
| 1812 | + <method name="GetUUID" description="Returns the UUID."> |
| 1813 | + <param name="XSDUUID" type="string" pass="return" description="UUID of the configuration XSD." /> |
| 1814 | + </method> |
| 1815 | + |
| 1816 | + <method name="GetTypeUUID" description="Returns the UUID of the corresponding Configuration type."> |
| 1817 | + <param name="TypeUUID" type="string" pass="return" description="UUID of the configuration type." /> |
| 1818 | + </method> |
| 1819 | + |
| 1820 | + <method name="GetSchemaType" description="Returns the Schema type of the configuration."> |
| 1821 | + <param name="SchemaType" type="string" pass="return" description="Schema type of the configuration type." /> |
| 1822 | + </method> |
| 1823 | + |
| 1824 | + <method name="GetXSDVersion" description="Returns the version number of the XSD.."> |
| 1825 | + <param name="XSDVersion" type="uint32" pass="return" description="Returns the XSD version." /> |
| 1826 | + </method> |
| 1827 | + |
| 1828 | + <method name="GetXSDString" description="Returns the XSD as string.."> |
| 1829 | + <param name="XSDString" type="string" pass="return" description="XSD String." /> |
| 1830 | + </method> |
| 1831 | + |
| 1832 | + <method name="ListVersions" description="Lists all known Configuration version of the current XSD."> |
| 1833 | + <param name="VersionIterator" type="class" class="MachineConfigurationVersionIterator" pass="return" description="Returns a list of versions." /> |
| 1834 | + </method> |
| 1835 | + |
| 1836 | + </class> |
| 1837 | + |
| 1838 | + <!-- The MachineConfigurationType class is not thread safe and MUST ONLY be used in a single thread context... --> |
| 1839 | + <class name="MachineConfigurationType" parent="Base" description="Machine configuration type instance."> |
| 1840 | + |
| 1841 | + <method name="GetUUID" description="Returns the UUID."> |
| 1842 | + <param name="TypeUUID" type="string" pass="return" description="UUID of the configuration type." /> |
| 1843 | + </method> |
| 1844 | + |
| 1845 | + <method name="GetName" description="Returns the Name."> |
| 1846 | + <param name="Name" type="string" pass="return" description="Name of the configuration type." /> |
| 1847 | + </method> |
| 1848 | + |
| 1849 | + <method name="GetSchemaType" description="Returns the Schema type of the configuration."> |
| 1850 | + <param name="SchemaType" type="string" pass="return" description="Schema type of the configuration type." /> |
| 1851 | + </method> |
| 1852 | + |
| 1853 | + <method name="GetLatestXSD" description="Returns the latest Machine Configuration XSD."> |
| 1854 | + <param name="XSDInstance" type="class" class="MachineConfigurationXSD" pass="return" description="Returns the latest XSD of the configuration type." /> |
| 1855 | + </method> |
| 1856 | + |
| 1857 | + <method name="GetLatestXSDVersion" description="Returns the latest Machine Configuration XSD Version."> |
| 1858 | + <param name="XSDVersion" type="uint32" pass="return" description="Returns the latest XSD version, or 0 if no XSD exists." /> |
| 1859 | + </method> |
| 1860 | + |
| 1861 | + <method name="FindXSDByUUID" description="Finds Machine Configuration XSD by UUID."> |
| 1862 | + <param name="XSDUUID" type="string" pass="in" description="UUID of the configuration XSD." /> |
| 1863 | + <param name="XSDInstance" type="class" class="MachineConfigurationXSD" pass="return" description="Returns the latest XSD of the configuration type." /> |
| 1864 | + </method> |
| 1865 | + |
| 1866 | + <method name="CreateNewXSD" description="Creates a new XSD Version. Fails if version already exists or is not incrementing."> |
| 1867 | + <param name="XSDString" type="string" pass="in" description="XSD String of the version. MUST be incremental." /> |
| 1868 | + <param name="XSDVersion" type="uint32" pass="in" description="New Version to add. MUST be larger than GetLatestXSDVersion." /> |
| 1869 | + <param name="DefaultConfigurationXML" type="string" pass="in" description="Default configuration XML to use for this XSD. MUST conform to XSD in question." /> |
| 1870 | + <param name="XSDInstance" type="class" class="MachineConfigurationXSD" pass="return" description="Returns the new XSD of the configuration type." /> |
| 1871 | + </method> |
| 1872 | + |
| 1873 | + <method name="GetXSDVersion" description="Returns an Configuration XSD Version."> |
| 1874 | + <param name="XSDVersion" type="uint32" pass="in" description="Version to retrieve." /> |
| 1875 | + <param name="XSDInstance" type="class" class="MachineConfigurationXSD" pass="return" description="Returns the XSD of the configuration type with the appropriate version number or null if it does not exist." /> |
| 1876 | + </method> |
| 1877 | + |
| 1878 | + <method name="ListVersions" description="Lists all known Configuration version of the current type."> |
| 1879 | + <param name="VersionIterator" type="class" class="MachineConfigurationVersionIterator" pass="return" description="Returns a list of versions." /> |
| 1880 | + </method> |
| 1881 | + |
| 1882 | + <method name="FindVersionByUUID" description="Finds a Configuration version by UUID."> |
| 1883 | + <param name="VersionUUID" type="string" pass="in" description="UUID of the configuration version." /> |
| 1884 | + <param name="Version" type="optionalclass" class="MachineConfigurationVersion" pass="return" description="Returns the specific version or null if version does not exist or is of a different type." /> |
| 1885 | + </method> |
| 1886 | + |
| 1887 | + <method name="GetActiveVersion" description="Returns the active Configuration version."> |
| 1888 | + <param name="VersionUUID" type="string" pass="in" description="UUID of the configuration version." /> |
| 1889 | + <param name="Version" type="optionalclass" class="MachineConfigurationVersion" pass="return" description="Returns the specific version or null if no active version exists for this type." /> |
| 1890 | + </method> |
| 1891 | + |
| 1892 | + <method name="GetLatestVersion" description="Returns the latest Configuration version by Timestamp."> |
| 1893 | + <param name="Version" type="optionalclass" class="MachineConfigurationVersion" pass="return" description="Returns the specific version or null if no version exists for this type." /> |
| 1894 | + </method> |
| 1895 | + |
| 1896 | + </class> |
| 1897 | + |
| 1898 | + |
1744 | 1899 | <!-- The InstallationInformation class is not thread safe and MUST ONLY be used in a single thread context... -->
|
1745 | 1900 | <class name="InstallationInformation" parent="Base" description="Installation information instance. Gives a snapshot of the installation information at creation of the instance. Does not update in the unlikely event of them changing.">
|
1746 | 1901 |
|
|
1834 | 1989 | <param name="HasCallback" type="bool" pass="return" description="Flag if log callback has been set." />
|
1835 | 1990 | </method>
|
1836 | 1991 |
|
| 1992 | + <method name="FindConfigurationTypeBySchema" description="Retrieves a configuration type by schema."> |
| 1993 | + <param name="SchemaType" type="string" pass="in" description="Configuration Schema Type String" /> |
| 1994 | + <param name="IteratorInstance" type="optionalclass" class="MachineConfigurationType" pass="return" description="Returns the Configuration Type instance, if it exists, NULL otherwise." /> |
| 1995 | + </method> |
| 1996 | + |
| 1997 | + <method name="FindConfigurationTypeByUUID" description="Retrieves a configuration type by uuid."> |
| 1998 | + <param name="UUID" type="string" pass="in" description="UUID String. Fails if not a proper UUID formatted string." /> |
| 1999 | + <param name="IteratorInstance" type="optionalclass" class="MachineConfigurationType" pass="return" description="Returns the Configuration Type instance, if it exists, NULL otherwise." /> |
| 2000 | + </method> |
| 2001 | + |
| 2002 | + <method name="CreateConfigurationType" description="Create a new configuration type for a schema. Fails if schema already exists.."> |
| 2003 | + <param name="SchemaType" type="string" pass="in" description="Configuration Schema Type String" /> |
| 2004 | + <param name="Name" type="string" pass="in" description="Name of the type." /> |
| 2005 | + <param name="IteratorInstance" type="class" class="MachineConfigurationType" pass="return" description="Returns the Configuration Type instance." /> |
| 2006 | + </method> |
| 2007 | + |
1837 | 2008 | <method name="TriggerLogCallback" description="Triggers the log callback. Fails if no log callback has been set.">
|
1838 | 2009 | <param name="LogMessage" type="string" pass="in" description="Log message to be logged."/>
|
1839 | 2010 | <param name="SubSystem" type="string" pass="in" description="SubSystem of Log Message."/>
|
|
0 commit comments