Summary:
List details of, modify, or delete an OS Service in a specified config set.
URL:
http(s)://{server hostname}/api/cfg/serverGroupConfig/{serverGroupId}/osservices/{osserviceName}
Note, for {osserviceName}, both the name and the UUID of the OS Service Rule can be used.
Methods summary
- GET Method - return details of the OS Service rule in a specified config set.
- PUT Method - modify an OS Service rule in a specified config set.
- DELETE Method - delete an OS Service rule from a specified config set.
GET Method detail
Return details of the OS Service rule in a specified config set.
Response:
Name | Description |
---|---|
uuid | unique universal ID of this OS Service rule. |
name | name of the OS Service rule. |
serviceName | name of the OS Service to which the rule applies. This is the OS Service name for which the rule filters, and is case insensitive. |
description | user-specified description of the OS Service. |
filterUsing | how the filter is used, either Equals (0) or Contains (1). |
operatingSystem | OS to collect from, either Windows (0) or Linux (1). |
enabled | if this OS Service rule is enabled. If disabled, the rule is treated as if it is not in hte whitelist when polling. |
allProfiles | if this OS Service rule is run against the entire network (true) or if profiles are specified (false). |
profilesUUID | list of profiles associated with this OS Service, by profile unique universal ID. |
Example:
INPUT
curl -v -u -k admin:admin https://localhost/api/cfg/serverGroupConfig/a28a4692-2693-4c7f-97ee-4ecef7025c69/osservices/09aaee3c-ea9d-4739-9123-440d05ad51e8?media=json -H "content-type:application/json"
OUTPUT
{
"uuid": "09aaee3c-ea9d-4739-9123-440d05ad51e8",
"name": "Test OS Service rule 2",
"serviceName": "Test Linux",
"description": "test 2",
"filterUsing": 1,
"operatingSystem": 1,
"enabled": true,
"allProfiles": false,
"profilesUUID": [
"28e94196-d5a2-4496-8af6-051c4695f4fc"
]
}
PUT Method detail
Modify an OS Service rule in a specified config set.
Request:
Name | Description |
---|---|
name | name of the OS Service rule. |
serviceName | name of the OS Service to which the rule applies. This is the OS Service name for which the rule filters, and is case insensitive. |
description | user-specified description of the OS Service. |
filterUsing | how the filter is used, either Equals (0) or Contains (1). |
operatingSystem | OS to collect from, either Windows (0) or Linux (1). |
enabled | if this OS Service rule is enabled. If disabled, the rule is treated as if it is not in hte whitelist when polling. |
allProfiles | if this OS Service rule is run against the entire network (true) or if profiles are specified (false). |
profilesUUID | list of profiles associated with this OS Service, by profile unique universal ID. |
Response:
Details of the modified OS Service rule, as the GET Method above would return.
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroupConfig/a28a4692-2693-4c7f-97ee-4ecef7025c69/osservices/09aaee3c-ea9d-4739-9123-440d05ad51e8?media=json -X PUT -H "content-type:application/json" -d '
{
"name": "Test OS Service rule 4 - Renamed",
"serviceName": "Test Linux 3",
"description": "test 4",
"filterUsing": 0,
"operatingSystem": 1,
"enabled": true,
"allProfiles": true,
"profilesUUID": []
}
OUTPUT
{
"uuid": "09aaee3c-ea9d-4739-9123-440d05ad51e8",
"name": "Test OS Service rule 4 - Renamed",
"serviceName": "Test Linux 3",
"description": "test 4",
"filterUsing": 0,
"operatingSystem": 1,
"enabled": true,
"allProfiles": true,
"profilesUUID": []
}
DELETE Method detail
Delete an OS Service rule from a specified config set.
Success message on completion.
Comments
0 comments
Please sign in to leave a comment.