WiseMo Guest Component API
Services

Back to Index

This page describes param to InvokeRmOperation call and returned value from OnRmOperationResult for snapinId = 15005.

Note

When operation fails, OnRmOperationResult comes with non-zero status and Error object in value:

{
"Error" : {
"code" : 4101,
"message" : "Failed to send RM command"
}
}


When status is zero, value is as provided in following documentation.

Paged output

RM requests may yield lots of data so responses are restricted in size.
That's where StartAt, UpTo and Total are used.


StartAt


UpTo says which StartAt use next to continue data retrieval


Total says how many data at all. When UpTo equals to Total, then all data has been retrieved.

Operation: Check if supported

snapinId=15005 opId=0

Check if host supports Services subsystem (Snap-In) for RM calls.

Parameters

{}

Returns

{
"Supported" : 1
}


Supported 1 if supports, 0 if not

Operation: Get services

snapinId=15005 opId=601

Note
This operation should be issued at least once before snapin operations described further below.

Parameters

{"StartAt":-1}

Returns

{
"Services" : [
{
"AcceptedControls" : 5,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Provides task scheduling for Acronis applications.",
"DisplayName" : "Acronis Scheduler2 Service",
"ServiceName" : "AcrSch2Svc",
"ServicePath" : "\"C:\\Program Files\\Common Files\\Acronis\\Schedule2\\schedul2.exe\"",
"ServiceType" : 16,
"StartName" : "LocalSystem",
"StartupType" : 2,
"State" : 4,
"SysAccount" : 1
},
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Notifies selected users and computers of administrative alerts. If the service is stopped, programs that use administrative alerts will not receive them. If this service is disabled, any services that explicitly depend on it will fail to start.",
"DisplayName" : "Alerter",
"ServiceName" : "Alerter",
"ServicePath" : "C:\\WINDOWS\\system32\\svchost.exe -k LocalService",
"ServiceType" : 32,
"StartName" : "NT AUTHORITY\\LocalService",
"StartupType" : 4,
"State" : 1,
"SysAccount" : 0
},
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Provides support for 3rd party protocol plug-ins for Internet Connection Sharing and the Windows Firewall.",
"DisplayName" : "Application Layer Gateway Service",
"ServiceName" : "ALG",
"ServicePath" : "C:\\WINDOWS\\System32\\alg.exe",
"ServiceType" : 16,
"StartName" : "NT AUTHORITY\\LocalService",
"StartupType" : 3,
"State" : 1,
"SysAccount" : 0
},
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Provides software installation services such as Assign, Publish, and Remove.",
"DisplayName" : "Application Management",
"ServiceName" : "AppMgmt",
"ServicePath" : "C:\\WINDOWS\\system32\\svchost.exe -k netsvcs",
"ServiceType" : 32,
"StartName" : "LocalSystem",
"StartupType" : 3,
"State" : 1,
"SysAccount" : 1
},
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Provides support for out-of-process session states for ASP.NET. If this service is stopped, out-of-process requests will not be processed. If this service is disabled, any services that explicitly depend on it will fail to start.",
"DisplayName" : "ASP.NET State Service",
"ServiceName" : "aspnet_state",
"ServicePath" : "C:\\WINDOWS\\Microsoft.NET\\Framework\\v4.0.30319\\aspnet_state.exe",
"ServiceType" : 16,
"StartName" : "NT AUTHORITY\\NetworkService",
"StartupType" : 3,
"State" : 1,
"SysAccount" : 0
},
{
"AcceptedControls" : 132,
"AllowInteract" : 1,
"Dependents" : [],
"Description" : "",
"DisplayName" : "Ati HotKey Poller",
"ServiceName" : "Ati HotKey Poller",
"ServicePath" : "C:\\WINDOWS\\system32\\Ati2evxx.exe",
"ServiceType" : 272,
"StartName" : "LocalSystem",
"StartupType" : 2,
"State" : 4,
"SysAccount" : 1
},
{
"AcceptedControls" : 129,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Manages audio devices for Windows-based programs. If this service is stopped, audio devices and effects will not function properly. If this service is disabled, any services that explicitly depend on it will fail to start.",
"DisplayName" : "Windows Audio",
"ServiceName" : "AudioSrv",
"ServicePath" : "C:\\WINDOWS\\System32\\svchost.exe -k netsvcs",
"ServiceType" : 32,
"StartName" : "LocalSystem",
"StartupType" : 2,
"State" : 4,
"SysAccount" : 1
},
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Dependents" : [],
"Description" : "Transfers data between clients and servers in the background. If BITS is disabled, features such as Windows Update will not work correctly.",
"DisplayName" : "Background Intelligent Transfer Service",
"ServiceName" : "BITS",
"ServicePath" : "C:\\WINDOWS\\system32\\svchost.exe -k netsvcs",
"ServiceType" : 32,
"StartName" : "LocalSystem",
"StartupType" : 3,
"State" : 1,
"SysAccount" : 1
}
],
"StartAt" : -1,
"Total" : 113,
"UpTo" : 8
}
at MSDN, CreateService Function

  • ServiceType, see dwServiceType
  • AcceptedControls, see dwControlsAccepted
  • State, see dwCurrentState
at MSDN, SERVICE_STATUS Structure

Operation: Save service

snapinId=15005 opId=602

{
"AllowInteract" : 0,
"Description" : "Manages an uninterruptible power supply (UPS) connected to the computer.",
"DisplayName" : "Uninterruptible Power Supply",
"ServiceName" : "UPS",
"ServicePath" : "C:\\WINDOWS\\System32\\ups.exe",
"StartName" : "LocalSystem",
"StartupType" : 3,
"SysAccount" : 1
"Password" : "foo"
}
at MSDN, ChangeServiceConfig Function

Returns

null

Operation: Action service

snapinId=15005 opId=603

Parameters

{
"ServiceName" : "UPS",
"Action" : 1
"Params" : ""
}

Returns

null

Operation: New service

snapinId=15005 opId=604

Parameters

{
"ServiceName" : "UPS",
"DisplayName" : "Uninterruptible Power Supply",
"StartupType" : 3,
"ServicePath" : "C:\\WINDOWS\\System32\\ups.exe",
"StartName" : "LocalSystem",
"Password" : "foo"
"SysAccount" : 1
"AllowInteract" : 0,
"StartAfterInstall" : 0
}
at MSDN, CreateService Function

  • StartAfterInstall, whether to start service
Returns
null

Operation: Remove service

snapinId=15005 opId=605

Parameters

{
"ServiceName":"UPS"
}

Returns

null

Operation: Get service

snapinId=15005 opId=606

Parameters

{
"ServiceName":"Alerter"
}

Returns

{
"Service" :
{
"AcceptedControls" : 0,
"AllowInteract" : 0,
"Description" : "Notifies selected users and computers of administrative alerts. If the service is stopped, programs that use administrative alerts will not receive them. If this service is disabled, any services that explicitly depend on it will fail to start.",
"Dependents" : [],
"DisplayName" : "Alerter",
"ServiceName" : "Alerter",
"ServicePath" : "C:\\WINDOWS\\system32\\svchost.exe -k LocalService",
"ServiceType" : 32,
"StartName" : "NT AUTHORITY\\LocalService",
"StartupType" : 4,
"State" : 1,
"SysAccount" : 0
}
}
at MSDN, CreateService Function

  • ServiceType, see dwServiceType
  • AcceptedControls, see dwControlsAccepted
  • State, see dwCurrentState
at MSDN, SERVICE_STATUS Structure