Control class
Control of the collector instance. Requires the Administrator (BA) privileges.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Provider("BootEventCollectorWmiProvider"), AMENDMENT]
class Control
{
};
Members
The Control class has these types of members:
Methods
The Control class has these methods.
| Method | Description |
|---|---|
| Checkpoint | If the current configuration is a result of the Undo/Redo/Restore, marks it as if it has been set explicitly, so that the history will preserve the time when it was set, and a backup file will be created for it on the next configuration change. If the current configuration was already set explicitly, has no effect. Returns 1 on success, 0 on error. |
| DumpDiagnostics | Dump the diagnostic information into the log. |
| FastShutdown | Stop the collector quickly, discarding all the queued data. |
| Flush | Flush the forwarder buffers. |
| GetConfiguration | Read the active configuration of the collector. |
| IsConfigurationEqual | Compare the argument with the active configuration of the collector. Returns 1 if they match, 0 if they don't. |
| ListBackups | Return the list of the saved backup configuration files that can be restored. |
| Redo | Reset the active configuration of the collector from the later backup file (determined by going forward from the current original timestamp). If the configuration has been undone, this means redoing the undone change. Returns 1 on success, 0 on error. |
| RestoreFile | Restore the active configuration of the collector from a backup file. Returns 1 on success, 0 on error. |
| RestoreFromTime | Restore the active configuration of the collector from a backup file, selected by a timestamp. Returns 1 on success, 0 on error. |
| SetConfiguration | Set the new active configuration of the collector. Returns 1 on success, 0 on error. |
| Shutdown | Stop the collector. If the collector is running as a service, stopping the service is the better approach. |
| Undo | Restore the active configuration of the collector from the previous backup file (determined by going back from the current original timestamp). If the configuration has been just set, this means undoing that change. The consecutive calls will undo to the earlier and earlier configurations. Returns 1 on success, 0 on error. |
| ValidateConfiguration | Validate a configuration text for correctness without setting it active. Returns 1 on success, 0 on error. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 10 [desktop apps only] |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\Microsoft\Windows\BootEventCollector |
| MOF |
|
| DLL |
|