Summary:
List the OS Service rules on a specified config set, and add a new OS Service rule to a config set.
URL:
http(s)://{server hostname}/api/cfg/serverGroupConfig/{serverGroupId}/osservices
Methods summary
- GET Method - list the OS Service rules on the specified config set.
- POST Method - add a new OS Service rule to the specified config set.
GET Method detail
List the OS Service rules on the 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?media=json -H "content-type:application/json"
OUTPUT
{
"items": [
{
"uuid": "8f51971c-c4f9-498f-925c-5cf616106553",
"name": "Test OS Service rule 1",
"serviceName": "Test Windows",
"description": "test 1",
"filterUsing": 0,
"operatingSystem": 0,
"enabled": true,
"allProfiles": false,
"profilesUUID": [
"28d8b244-d740-48df-887d-d6684bc92ef3"
]
},
{
"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"
]
},
{
"uuid": "0ab1e3c1-dcd4-4ca5-b670-8b778ff340f2",
"name": "Test OS Service rule 3",
"serviceName": "Test Linux 2",
"description": "test 3",
"filterUsing": 0,
"operatingSystem": 1,
"enabled": true,
"allProfiles": true,
"profilesUUID": []
}
],
"count": 3
}
POST Method detail
Add a new OS Service rule to the 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:
Success or failure.
Example:
INPUT
curl -v -u -k admin:admin https://localhost/api/cfg/serverGroupConfig/a28a4692-2693-4c7f-97ee-4ecef7025c69/osservices?media=json -X POST -H "content-type:application/json" -d \
{
"name": "Test OS Service rule 4",
"serviceName": "Test Linux 3",
"description": "test 4",
"filterUsing": 0,
"operatingSystem": 1,
"enabled": true,
"allProfiles": true,
"profilesUUID": [
"28d8b244-d740-48df-887d-d6684bc92ef3"
]
}
OUTPUT
{
"errorCode": "SUCCESS",
"errorDetails": null,
"data": {
"configurationChangeId": 10,
"serverGroupId": "a28a4692-2693-4c7f-97ee-4ecef7025c69",
"timestampSec": 1700236233,
"modifiedBy": "admin",
"syncing": false
}
}
Comments
0 comments
Please sign in to leave a comment.