Search Device Management Policy
Searches for a device management policy with a policy name.
Path Parameters
- clientId
Describes the clientId of the tenant
Query Parameters
- name
Device management policy name.
Responses
- matchType
(Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.
- Enum:
- ALLANY
- rules
(Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource
- actions
- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response
- id
- name
Name of the policy.
- resourceType
Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER
- executionOrder
- clientMatchingType
- The clientMatchingType field is optional and when not passed defaults to the following "clientMatchingType": "ALL" - The clientMatchingType field is applicable at partner-level DMP only. - If clientMatchingType EXCLUDE/INCLUDE, then the clients field is mandatory. - On policy update, if clientMatchingType is not passed then clientMatchingType will be updated to ALL and client selection will be removed.
- Enum:
- EXCLUDEINCLUDEALL
Default: ALL
- clients
Response Samples
[
{
"id": 210,
"name": "test-Mysql-policyWeb",
"resourceType": "DEVICE",
"matchType": "ALL",
"rules": [
{
"id": 155833,
"key": "Name",
"operator": "Contains",
"value": "mysql",
"isNativeAttribute": true
}
],
"actions": [
{
"action": "ASSIGN MONITORINGTEMPLATE",
"items": [
{
"item": "4053",
"parameters": {
"Packet Count": "3",
"Packet interval": "1000",
"Data Bytes": "64"
},
"instances": {}
}
],
"forceAssignOrUnassign": false
},
{
"action": "ASSIGN KNOWLEDGEARTICLE",
"items": [
{
"item": "7188"
}
],
"forceAssignOrUnassign": true
}
],
"executionOrder": 0
},
{
"id": 209,
"name": "test-Mysql-policy-Web",
"resourceType": "DEVICE",
"matchType": "ALL",
"rules": [
{
"id": 155863,
"key": "Name",
"operator": "Contains",
"value": "mysql",
"isNativeAttribute": true
}
],
"actions": [
{
"action": "Assign Jobs",
"items": [
{
"item": "asset info",
"itemType": "assetinfo",
"itemUid": "c072cd67-779a-4206-a3d9-7c761fd563d8"
}
],
"forceAssignOrUnassign": true
},
{
"action": "Assign Availability Rule",
"items": [
{
"item": "AND"
}
]
}
],
"executionOrder": 0
},
{
"id": 205,
"name": "test-Mysql-policy-Web-name",
"resourceType": "DEVICE",
"matchType": "ALL",
"rules": [
{
"id": 154833,
"key": "Name",
"operator": "Contains",
"value": "mysql",
"isNativeAttribute": true
}
],
"actions": [
{
"action": "ASSIGN CREDENTIALSET",
"items": [
{
"item": "36218"
}
],
"forceAssignOrUnassign": true
},
{
"action": "ASSIGN CUSTOMATTRIBUTES",
"items": [
{
"item": "264313"
}
],
"forceAssignOrUnassign": true
}
],
"executionOrder": 0
}
]