HostService

HostService
HostService

Data object that describes a single service that runs on the host.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "label": "string",
    "required": false,
    "uninstallable": false,
    "running": false,
    "ruleset": [
        "string"
    ],
    "policy": "string",
    "sourcePackage": {
        "_typeName": "string",
        "sourcePackageName": "string",
        "description": "string"
    }
}
string
key
Required

Brief identifier for the service.

string
label
Required

Display label for the service.

boolean
required
Required

Flag indicating whether the service is required and cannot be disabled.

boolean
uninstallable
Required

Deprecated this flag is unimplemented and will always be set to false.

Flag indicating whether the service can be uninstalled.

boolean
running
Required

Flag indicating whether the service is currently running.

array of string
ruleset
Optional

List of firewall rulesets used by this service.

Must come from the list of rulesets in ruleset.

string
policy
Required

Service activation policy.

See also HostServicePolicyEnum.

sourcePackage
Optional

The source package associated with the service