This operation updates the users and user groups associated with a laptop plan.
Request
Syntax
PUT <webservice>/Plan/{planId}/Users HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
Content-type: application/json
<update_plan_user_template.json>where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description | Required |
|---|---|---|
planId | The plan ID for the plan. If the plan ID is not known, use the GET Plan API to retrieve it. | Yes |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type | The media type contained in the request body. |
Request Body
Download the JSON file required for this request: update_plan_user_template.json. The following table displays the parameters for the request body.
Name | Description | Elements |
|---|---|---|
userOperationType | The operation to perform on the users and user groups. Valid values are:
| |
sendInvite | The option to send users and user groups an invitation to download the laptop package. Valid values are true or false. | users |
userName | The name of the user. To add, overwrite, or delete a user association, you can use the userName parameter or the userId parameter. | user |
userId | The system-generated ID assigned to the user. To add, overwrite, or delete a user association, you can use the userName parameter or the userId parameter. | user |
userGroupName | The name of the user group. To add, overwrite, or delete a user group association, you can use the userGroupName parameter or the userGroupId parameter. | userGroup |
userGroupId | The system-generated ID assigned to the user group. To add, overwrite, or delete a user group association, you can use the userGroupName parameter or the userGroupId parameter. | userGroup |
externalGroupName | The name of the external user group. To add, overwrite, or delete an external user group association, you can use the externalGroupName parameter or the groupId parameter. | externalUserGroup |
groupId | The system-generated ID assigned to the external user group. To add, overwrite, or delete an external user group association, you can use the externalGroupName parameter or the groupId parameter. | externalUserGroup |
providerDomainName | The NetBIOS name of the domain, for example, mydomain. | externalUserGroup |
Response
Response Parameters
Parameter | Description | Element |
|---|---|---|
planId | The system-generated ID assigned to the plan. | plan |
planName | The name of the plan. | plan |
errorMessage | The description of the error code. Not all error codes have an error message. | status |
errorCode | The possible error codes. Valid values are:
| status |
Examples
Sample Request
This request deletes a user.
PUT <webservice>/Plan/5/Users HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{ "userOperationType": "DELETE", "users": [{ "user": { "userId": 4 } }]
}This request deletes an external user group.
PUT <webservice>/Plan/5/Users HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/json
{ "userOperationType": "DELETE", "users": [{ "externalUserGroup": { "externalGroupName": "Dev-Documentation-US", "providerDomainName": "company-nj" } }]
}Sample Response
{ "plan": { "summary": { "slaInMinutes": 780, "restrictions": 1, "type": 2, "slaInterval": 0, "planStatusFlag": 0, "numDevices": 0, "rpoInMinutes": 780, "subtype": 33554439, "numUsers": 0, "permissions": [ { "permissionId": 1 }, { "permissionId": 2 }, { "permissionId": 3 }, { "permissionId": 4 }, { "permissionId": 5 }, { "permissionId": 6 }, { "permissionId": 7 }, { "permissionId": 8 }, { "permissionId": 9 }, { "permissionId": 10 }, { "permissionId": 11 }, { "permissionId": 12 }, { "permissionId": 13 }, { "permissionId": 15 }, { "permissionId": 16 }, { "permissionId": 18 }, { "permissionId": 20 }, { "permissionId": 22 }, { "permissionId": 24 }, { "permissionId": 25 }, { "permissionId": 26 }, { "permissionId": 27 }, { "permissionId": 29 }, { "permissionId": 31 }, { "permissionId": 32 }, { "permissionId": 33 }, { "permissionId": 34 }, { "permissionId": 35 }, { "permissionId": 36 }, { "permissionId": 38 }, { "permissionId": 39 }, { "permissionId": 40 }, { "permissionId": 41 }, { "permissionId": 42 }, { "permissionId": 101 }, { "permissionId": 102 }, { "permissionId": 103 }, { "permissionId": 107 }, { "permissionId": 116 }, { "permissionId": 117 }, { "permissionId": 118 }, { "permissionId": 134 }, { "permissionId": 135 }, { "permissionId": 136 }, { "permissionId": 137 }, { "permissionId": 139 }, { "permissionId": 140 }, { "permissionId": 142 }, { "permissionId": 143 }, { "permissionId": 145 }, { "permissionId": 146 }, { "permissionId": 147 }, { "permissionId": 148 }, { "permissionId": 149 }, { "permissionId": 150 }, { "permissionId": 156 }, { "permissionId": 157 }, { "permissionId": 158 }, { "permissionId": 159 }, { "permissionId": 178 }, { "permissionId": 215 }, { "permissionId": 217 } ], "planOwner": { "_type_": 13, "userName": "Administrator", "userId": 1 }, "plan": { "planSubtype": 33554439, "_type_": 158, "planType": 2, "planName": "edge drive plan", "planId": 10 } }, "definesStorage": { "definesEntity": true, "overrideEntity": 0 }, "securityAssociations": { "associations": [ { "userOrGroup": [ { "userId": 1, "_type_": 13, "userName": "admin" } ], "properties": { "isCreatorAssociation": true, "role": { "_type_": 120, "roleId": 10, "roleName": "Plan Creator Role" } } } ], "ownerAssociations": {} }, "featureInfo": { "edgedriveInfo": {}, "definesEdgeDriveInfo": { "definesEntity": false, "overrideEntity": 0 } }, "inheritance": { "isSealed": true }, "storage": { "storagePolicy": { "storagePolicyName": "edge drive plan", "storagePolicyId": 13 }, "copy": [ { "copyType": 0, "active": 1, "isDefault": 1, "copyPrecedence": 1, "retentionRules": { "retainBackupDataForCycles": 1, "jobs": 0, "retainArchiverDataForDays": 0, "retainBackupDataForDays": 730 }, "StoragePolicyCopy": { "copyId": 13, "copyName": "Primary" }, "drivePool": { "drivePoolName": "DrivePool(winterma)2", "drivePoolId": 2 }, "library": { "libraryName": "pool oneLibrary", "libraryId": 2 }, "useGlobalPolicy": { "storagePolicyName": "pool one", "storagePolicyId": 3 } } ] }, "definesSchedule": { "definesEntity": true, "overrideEntity": 0 }, "laptop": { "features": { "role": { "roleId": 27, "roleName": "edge drive plan features" }, "categoryPermission": { "categoriesPermissionList": [ { "permissionId": 145, "permissionName": "Laptop" }, { "permissionId": 148, "permissionName": "DLP" }, { "permissionId": 215, "permissionName": "Archiving" } ] } }, "accessPolicies": { "categoryPermission": {} }, "definesAccessPolicies": { "definesEntity": false, "overrideEntity": 0 }, "content": { "backupContent": [ { "idatype": 2, "subClientPolicy": { "backupSetEntity": { "backupsetId": 11, "_type_": 6, "backupsetName": "edge drive plan Windows subclient policy" }, "subClientList": [ { "hcSubclientProp": {}, "impersonateUser": {}, "proxyClient": {}, "subClientEntity": { "clientName": "winter", "instanceName": "DefaultInstanceName", "backupsetId": 11, "_type_": 7, "instanceId": 1, "subclientGUID": "757eeee5-9A88-eeee-8202-0C8eeee42002", "subclientId": 11, "clientId": 2, "appName": "Subclient Policy", "backupsetName": "edge drive plan Windows subclient policy", "applicationId": 1030, "subclientName": "default" }, "dfsSubclientProp": { "distributedDataAccessNodes": {} }, "fsSubClientProp": { "catalogACL": true, "useGlobalFilters": 2, "forcedArchiving": false, "useVSSForSystemState": false, "olderFileVersionsMode": 2, "backupRetentionMode": 1, "unixCtime": true, "keepVersions": 5, "backupRetention": true, "scanOption": 2, "backupSystemState": false, "afterDeletionKeepItemsForNDays": 730, "unixMtime": true, "runTrueUpJobAfterJobsForFS": 0, "catalogAdditional": false, "oneTouchSubclient": false, "extendRetentionForNDays": -1, "customSubclientFlag": true, "isTrueUpOptionEnabledForFS": false, "enableContentIndexing": false, "retentionPolicy": 0, "contentIndexingPolicy": 0, "archiverRetentionMode": 2, "enableOnePass": true, "runTrueUpJobAfterDaysForFS": 30, "useVSS": true, "isSynthfullRunAfterOnePassEnabledOnSubclient": false, "extendStoragePolicyRetention": true, "keepOlderVersionsForNDays": 0, "ibmiSubclientprop": {}, "backupConfiguration": {}, "oneTouchServer": { "clientId": 0, "_type_": 3 }, "backupFilesOnOrAfterDate": { "_type_": 55 }, "diskCleanupRules": { "fileModifiedTimeOlderThan": 90, "fileSizeGreaterThan": 1024, "stubPruningOptions": 0, "afterArchivingRule": 1, "stubRetentionDaysOld": 0, "fileCreatedTimeOlderThan": 0, "maximumFileSize": 0, "fileAccessTimeOlderThan": 90, "startCleaningIfLessThan": 50, "patternMatch": "", "stopCleaningIfupto": 80, "rulesToSatisfy": 1, "entityMatch": "", "diskCleanupFileTypes": {} }, "ocsUserName": {} }, "planEntity": {}, "nfsSubclientProp": { "serverInfo": { "userIds": [ "*" ], "groupIds": [ "*" ], "nfsServer": {} } }, "cassandraProps": {}, "content": [ { "path": "\\%Desktop%" }, { "path": "\\%Documents%" }, { "path": "\\%Office%" }, { "path": "\\%Pictures%" }, { "path": "\\%Image%" }, { "excludePath": "\\%Temporary Files (Windows)%" }, { "excludePath": "C:\\Program Files" }, { "excludePath": "C:\\Program Files (x86)" }, { "excludePath": "C:\\Windows" } ], "commonProperties": { "numberOfBackupStreams": 1, "nextBackupTime": 0, "isTurboSubclient": true, "isKeepItemPastExpiryTime": true, "runTrueUpJobAfterDays": 30, "totalBackupSize": 0, "isAdAppAwareSubclient": false, "isDefaultSubclient": true, "lastBackupTime": 0, "indexingBackupSubClient": false, "isTrueUpOptionEnabled": false, "subClientPropertiesFlag": 0, "lastBackupSize": 0, "allowVssForSnapbackup": false, "enableBackupAfterDelay": false, "runAs": 0, "enableBackup": true, "securityAssociations": { "ownerAssociations": {} }, "enableBackupAtDateTime": { "TimeZoneID": 0, "time": 0 }, "turboNASClient": { "clientId": 0, "_type_": 3 }, "associatedSnapShotSCId": { "_type_": 7 }, "snapCopyInfo": { "backupCopyInterface": 0, "IsOracleSposDriverEnabled": false, "isRMANEnableForTapeMovement": false, "useProxyForSQLIntegrity": {}, "sybaseUser": {}, "snapToTapeSelectedEngine": { "_type_": 110 }, "sqlUser": {}, "vmApplicationUser": {}, "snapToTapeProxyToUse": { "_type_": 3 }, "quiesceImpersonateUser": {}, "separateProxyForSnapToTape": { "_type_": 3 }, "sshKey": {}, "configuredSybaseInstance": { "_type_": 5 } }, "prepostProcess": { "runPostScan": 0, "runPostBackup": 0, "runPostLog": 0, "prepostUserName": {} }, "security": { "clientOwners": [ "admin" ], "associatedUserGroups": [ { "userGroupId": 1, "_type_": 15, "userGroupName": "master" }, { "userGroupId": 3, "_type_": 15, "userGroupName": "View All" } ], "ownerCapabilities": {} }, "storageDevice": { "networkAgents": 1, "softwareCompression": 2, "throttleNetworkBandwidth": 0, "dataBackupStoragePolicy": { "_type_": 17, "storagePolicyName": "edge drive plan", "storagePolicyId": 13 }, "deDuplicationOptions": { "enableDeduplication": true, "generateSignature": 1 }, "logBackupStoragePolicy": { "_type_": 17 }, "performanceMode": { "perfSPName": "edge drive plan", "multiplexingValid": false, "enableMultiplexing": false, "perfCopyName": "Primary", "perfClientName": "winter", "streamsOverMux": false, "pipelineBufferSize": 64, "numOfPipelineBuffers": 90, "muxFactor": 0, "lookAheadReaderSlots": 4, "perfCRCDetails": [ { "crcOverMedia": true, "perfMaId": 3, "crcOverNetwork": true, "perfMa": "winterma" } ] } }, "prepostCredentialinfo": { "credentialId": 0, "credentialName": "" }, "associatedPolicy": { "subclientPolicyId": 0 }, "impersonateUserCredentialinfo": { "credentialId": 0, "credentialName": "" } }, "analyticsSubclientProp": {} } ] } }, { "idatype": 3, "subClientPolicy": { "backupSetEntity": { "backupsetId": 12, "_type_": 6, "backupsetName": "edge drive plan Linux subclient policy" }, "subClientList": [ { "hcSubclientProp": {}, "impersonateUser": {}, "proxyClient": {}, "subClientEntity": { "clientName": "winter", "instanceName": "DefaultInstanceName", "backupsetId": 12, "_type_": 7, "instanceId": 1, "subclientGUID": "F0cccc3B-cccc-47D0-8509-5EAEcccc7B8F", "subclientId": 12, "clientId": 2, "appName": "Subclient Policy", "backupsetName": "edge drive plan Linux subclient policy", "applicationId": 1030, "subclientName": "default" }, "dfsSubclientProp": { "distributedDataAccessNodes": {} }, "fsSubClientProp": { "catalogACL": true, "useGlobalFilters": 2, "forcedArchiving": false, "checkArchiveBit": false, "olderFileVersionsMode": 2, "backupRetentionMode": 1, "unixCtime": true, "keepVersions": 5, "backupRetention": true, "scanOption": 1, "afterDeletionKeepItemsForNDays": 730, "unixMtime": true, "runTrueUpJobAfterJobsForFS": 0, "catalogAdditional": false, "oneTouchSubclient": false, "extendRetentionForNDays": -1, "customSubclientFlag": true, "isTrueUpOptionEnabledForFS": false, "enableContentIndexing": false, "retentionPolicy": 0, "contentIndexingPolicy": 0, "archiverRetentionMode": 2, "enableOnePass": true, "runTrueUpJobAfterDaysForFS": 30, "useVSS": true, "isSynthfullRunAfterOnePassEnabledOnSubclient": false, "extendStoragePolicyRetention": true, "keepOlderVersionsForNDays": 0, "ibmiSubclientprop": {}, "backupConfiguration": {}, "oneTouchServer": { "clientId": 0, "_type_": 3 }, "backupFilesOnOrAfterDate": { "_type_": 55 }, "diskCleanupRules": { "fileModifiedTimeOlderThan": 90, "fileSizeGreaterThan": 1024, "stubPruningOptions": 0, "afterArchivingRule": 1, "stubRetentionDaysOld": 0, "fileCreatedTimeOlderThan": 0, "maximumFileSize": 0, "fileAccessTimeOlderThan": 90, "startCleaningIfLessThan": 50, "patternMatch": "", "stopCleaningIfupto": 80, "rulesToSatisfy": 1, "entityMatch": "", "diskCleanupFileTypes": {} }, "ocsUserName": {} }, "planEntity": {}, "nfsSubclientProp": { "serverInfo": { "userIds": [ "*" ], "groupIds": [ "*" ], "nfsServer": {} } }, "cassandraProps": {}, "content": [ { "path": "/%Desktop%" }, { "path": "/%Documents%" }, { "path": "/%Office%" }, { "path": "/%Pictures%" }, { "path": "/%Image%" }, { "excludePath": "/%Temporary Files (Linux)%" } ], "commonProperties": { "numberOfBackupStreams": 1, "nextBackupTime": 0, "isTurboSubclient": true, "isKeepItemPastExpiryTime": true, "runTrueUpJobAfterDays": 30, "totalBackupSize": 0, "isAdAppAwareSubclient": false, "isDefaultSubclient": true, "lastBackupTime": 0, "indexingBackupSubClient": false, "isTrueUpOptionEnabled": false, "subClientPropertiesFlag": 0, "lastBackupSize": 0, "allowVssForSnapbackup": false, "enableBackupAfterDelay": false, "runAs": 0, "enableBackup": true, "securityAssociations": { "ownerAssociations": {} }, "enableBackupAtDateTime": { "TimeZoneID": 0, "time": 0 }, "turboNASClient": { "clientId": 0, "_type_": 3 }, "associatedSnapShotSCId": { "_type_": 7 }, "snapCopyInfo": { "backupCopyInterface": 0, "IsOracleSposDriverEnabled": false, "isRMANEnableForTapeMovement": false, "useProxyForSQLIntegrity": {}, "sybaseUser": {}, "snapToTapeSelectedEngine": { "_type_": 110 }, "sqlUser": {}, "vmApplicationUser": {}, "snapToTapeProxyToUse": { "_type_": 3 }, "quiesceImpersonateUser": {}, "separateProxyForSnapToTape": { "_type_": 3 }, "sshKey": {}, "configuredSybaseInstance": { "_type_": 5 } }, "prepostProcess": { "runPostScan": 0, "runPostBackup": 0, "runPostLog": 0, "prepostUserName": {} }, "security": { "clientOwners": [ "admin" ], "associatedUserGroups": [ { "userGroupId": 1, "_type_": 15, "userGroupName": "master" }, { "userGroupId": 3, "_type_": 15, "userGroupName": "View All" } ], "ownerCapabilities": {} }, "storageDevice": { "networkAgents": 1, "softwareCompression": 2, "throttleNetworkBandwidth": 0, "dataBackupStoragePolicy": { "_type_": 17, "storagePolicyName": "edge drive plan", "storagePolicyId": 13 }, "deDuplicationOptions": { "enableDeduplication": true, "generateSignature": 1 }, "logBackupStoragePolicy": { "_type_": 17 }, "performanceMode": { "perfSPName": "edge drive plan", "multiplexingValid": false, "enableMultiplexing": false, "perfCopyName": "Primary", "perfClientName": "winter", "streamsOverMux": false, "pipelineBufferSize": 64, "numOfPipelineBuffers": 90, "muxFactor": 0, "lookAheadReaderSlots": 4, "perfCRCDetails": [ { "crcOverMedia": true, "perfMaId": 3, "crcOverNetwork": true, "perfMa": "winterma" } ] } }, "prepostCredentialinfo": { "credentialId": 0, "credentialName": "" }, "associatedPolicy": { "subclientPolicyId": 0 }, "impersonateUserCredentialinfo": { "credentialId": 0, "credentialName": "" } }, "analyticsSubclientProp": {} } ] } }, { "idatype": 4, "subClientPolicy": { "backupSetEntity": { "backupsetId": 13, "_type_": 6, "backupsetName": "edge drive plan Mac subclient policy" }, "subClientList": [ { "hcSubclientProp": {}, "impersonateUser": {}, "proxyClient": {}, "subClientEntity": { "clientName": "winter", "instanceName": "DefaultInstanceName", "backupsetId": 13, "_type_": 7, "instanceId": 1, "subclientGUID": "14bbbbE2-4F0E-bbbb-B721-3E9bbbb197F4", "subclientId": 13, "clientId": 2, "appName": "Subclient Policy", "backupsetName": "edge drive plan Mac subclient policy", "applicationId": 1030, "subclientName": "default" }, "dfsSubclientProp": { "distributedDataAccessNodes": {} }, "fsSubClientProp": { "catalogACL": true, "useGlobalFilters": 2, "forcedArchiving": false, "checkArchiveBit": false, "olderFileVersionsMode": 2, "backupRetentionMode": 1, "unixCtime": true, "keepVersions": 5, "backupRetention": true, "scanOption": 1, "afterDeletionKeepItemsForNDays": 730, "unixMtime": true, "runTrueUpJobAfterJobsForFS": 0, "catalogAdditional": false, "oneTouchSubclient": false, "extendRetentionForNDays": -1, "customSubclientFlag": true, "isTrueUpOptionEnabledForFS": false, "enableContentIndexing": false, "retentionPolicy": 0, "contentIndexingPolicy": 0, "archiverRetentionMode": 2, "enableOnePass": true, "runTrueUpJobAfterDaysForFS": 30, "useVSS": true, "isSynthfullRunAfterOnePassEnabledOnSubclient": false, "extendStoragePolicyRetention": true, "keepOlderVersionsForNDays": 0, "ibmiSubclientprop": {}, "backupConfiguration": {}, "oneTouchServer": { "clientId": 0, "_type_": 3 }, "backupFilesOnOrAfterDate": { "_type_": 55 }, "diskCleanupRules": { "fileModifiedTimeOlderThan": 90, "fileSizeGreaterThan": 1024, "stubPruningOptions": 0, "afterArchivingRule": 1, "stubRetentionDaysOld": 0, "fileCreatedTimeOlderThan": 0, "maximumFileSize": 0, "fileAccessTimeOlderThan": 90, "startCleaningIfLessThan": 50, "patternMatch": "", "stopCleaningIfupto": 80, "rulesToSatisfy": 1, "entityMatch": "", "diskCleanupFileTypes": {} }, "ocsUserName": {} }, "planEntity": {}, "nfsSubclientProp": { "serverInfo": { "userIds": [ "*" ], "groupIds": [ "*" ], "nfsServer": {} } }, "cassandraProps": {}, "content": [ { "path": "/%Desktop%" }, { "path": "/%Documents%" }, { "path": "/%Office%" }, { "path": "/%Pictures%" }, { "path": "/%Image%" }, { "excludePath": "/%Temporary Files (Mac)%" } ], "commonProperties": { "numberOfBackupStreams": 1, "nextBackupTime": 0, "isTurboSubclient": true, "isKeepItemPastExpiryTime": true, "runTrueUpJobAfterDays": 30, "totalBackupSize": 0, "isAdAppAwareSubclient": false, "isDefaultSubclient": true, "lastBackupTime": 0, "indexingBackupSubClient": false, "isTrueUpOptionEnabled": false, "subClientPropertiesFlag": 0, "lastBackupSize": 0, "allowVssForSnapbackup": false, "enableBackupAfterDelay": false, "runAs": 0, "enableBackup": true, "securityAssociations": { "ownerAssociations": {} }, "enableBackupAtDateTime": { "TimeZoneID": 0, "time": 0 }, "turboNASClient": { "clientId": 0, "_type_": 3 }, "associatedSnapShotSCId": { "_type_": 7 }, "snapCopyInfo": { "backupCopyInterface": 0, "IsOracleSposDriverEnabled": false, "isRMANEnableForTapeMovement": false, "useProxyForSQLIntegrity": {}, "sybaseUser": {}, "snapToTapeSelectedEngine": { "_type_": 110 }, "sqlUser": {}, "vmApplicationUser": {}, "snapToTapeProxyToUse": { "_type_": 3 }, "quiesceImpersonateUser": {}, "separateProxyForSnapToTape": { "_type_": 3 }, "sshKey": {}, "configuredSybaseInstance": { "_type_": 5 } }, "prepostProcess": { "runPostScan": 0, "runPostBackup": 0, "runPostLog": 0, "prepostUserName": {} }, "security": { "clientOwners": [ "admin" ], "associatedUserGroups": [ { "userGroupId": 1, "_type_": 15, "userGroupName": "master" }, { "userGroupId": 3, "_type_": 15, "userGroupName": "View All" } ], "ownerCapabilities": {} }, "storageDevice": { "networkAgents": 1, "softwareCompression": 2, "throttleNetworkBandwidth": 0, "dataBackupStoragePolicy": { "_type_": 17, "storagePolicyName": "edge drive plan", "storagePolicyId": 13 }, "deDuplicationOptions": { "enableDeduplication": true, "generateSignature": 1 }, "logBackupStoragePolicy": { "_type_": 17 }, "performanceMode": { "perfSPName": "edge drive plan", "multiplexingValid": false, "enableMultiplexing": false, "perfCopyName": "Primary", "perfClientName": "winter", "streamsOverMux": false, "pipelineBufferSize": 64, "numOfPipelineBuffers": 90, "muxFactor": 0, "lookAheadReaderSlots": 4, "perfCRCDetails": [ { "crcOverMedia": true, "perfMaId": 3, "crcOverNetwork": true, "perfMa": "winterma" } ] } }, "prepostCredentialinfo": { "credentialId": 0, "credentialName": "" }, "associatedPolicy": { "subclientPolicyId": 0 }, "impersonateUserCredentialinfo": { "credentialId": 0, "credentialName": "" } }, "analyticsSubclientProp": {} } ] } } ], "definesSubclientWin": { "definesEntity": true, "overrideEntity": 0 }, "definesSubclientMac": { "definesEntity": true, "overrideEntity": 0 }, "definesSubclientLin": { "definesEntity": true, "overrideEntity": 0 } }, "users": {}, "definesFeatures": { "definesEntity": true, "overrideEntity": 0 } }, "definesDCPolicy": { "definesEntity": false, "overrideEntity": 0 }, "operationWindow": { "ruleId": 0 }, "alerts": { "alerts": [ { "alertName": "No backup for last 4 days", "alertId": 7 }, { "alertName": "Restore Job failed", "alertId": 8 }, { "alertName": "Edge drive quota alert", "alertId": 9 }, { "alertName": "Edge drive/share operations alert", "alertId": 14 } ] }, "replicationTargets": {}, "schedule": { "associations": [ { "srmReportSet": 0, "srmTemplateId": 0, "subclientId": 0, "clientGroupId": 9, "storagePolicyId": 0, "copyId": 0, "applicationId": 0, "backupsetId": 0, "instanceId": 0, "sidbStoreId": 0, "clientId": 0, "srmTemplateName": "", "agentlessPolicyId": 0, "mediaAgentId": 0, "workflowId": 0, "clientGroupName": "edge drive plan clients", "_type_": 28, "trackingPolicyId": 0, "flags": { "exclude": false } } ], "task": { "description": "", "ownerId": 1, "runUserId": 1, "taskType": 4, "ownerName": "Administrator", "alertId": 0, "GUID": "b504accc-42b1-4977-91ac-33d14ccc3b78", "policyType": 0, "associatedObjects": 0, "taskName": "edge drive plan", "taskId": 70, "securityAssociations": { "associations": [ { "userOrGroup": [ { "userId": 1, "_type_": 13, "userName": "admin" } ], "properties": { "isCreatorAssociation": true, "role": { "_type_": 120, "roleId": 9, "roleName": "Schedule Policy Creator" } } } ], "ownerAssociations": {} }, "originalCC": { "commCellId": 2 }, "taskSecurity": { "associatedUserGroups": [ { "userGroupId": 1, "_type_": 15, "userGroupName": "master" }, { "userGroupId": 3, "_type_": 15, "userGroupName": "View All" } ], "ownerCapabilities": {} }, "createAs": { "user": { "user": { "userName": "admin", "userId": 1 } } }, "taskFlags": { "isEdgeDrive": false, "isEZOperation": false, "forDDB": false, "uninstalled": false, "isSystem": false, "disabled": false }, "task": { "taskName": "edge drive plan", "taskId": 70 } }, "appGroup": {}, "subTasks": [ { "subTask": { "subTaskOrder": 0, "subTaskName": "Incremental Automatic schedule", "subTaskType": 2, "flags": 65536, "operationType": 2, "subTaskId": 79, "subTask": { "subtaskId": 79, "subtaskName": "Incremental Automatic schedule" } }, "pattern": { "active_end_occurence": 0, "freq_subday_interval": 0, "freq_type": 1024, "patternId": 34, "flags": 0, "description": "", "active_end_time": 0, "active_end_date": 0, "skipOccurence": 0, "skipDayNumber": 0, "active_start_time": 0, "freq_restart_interval": 0, "active_start_date": 1522886400, "freq_interval": 0, "freq_relative_interval": 0, "name": "Incremental Automatic schedule", "freq_recurrence_factor": 0, "calendar": { "calendarName": "Standard", "calendarId": 1 }, "timeZone": { "TimeZoneID": 1000 } }, "options": { "backupOpts": { "backupLevel": 2, "incLevel": 1, "runIncrementalBackup": true, "cdrOptions": { "incremental": true }, "dataOpt": { "useCatalogServer": true, "followMountPoints": true, "daysBetweenSyntheticBackup": 0 } }, "commonOpts": { "automaticSchedulePattern": { "maxBackupInterval": 24, "ignoreOpWindowPastMaxInterval": false, "minBackupIntervalMinutes": 0, "maxBackupIntervalMinutes": 0, "minSyncInterval": 0, "minBackupInterval": 13, "minSyncIntervalMinutes": 2, "stopIfOnBattery": { "enabled": false }, "acPower": { "enabled": false }, "specfificNetwork": { "enabled": false, "ipAddress": { "subnet": 24, "address": "0.0.0.0" } }, "stopSleepIfBackUp": { "enabled": false }, "newOrModifiedFile": { "enabled": true }, "wiredNetworkConnection": { "enabled": false }, "minNetworkBandwidth": { "enabled": false } } } } }, { "subTask": { "subTaskOrder": 0, "subTaskName": "Space Reclamation", "subTaskType": 2, "flags": 0, "operationType": 2, "subTaskId": 80, "subTask": { "subtaskId": 80, "subtaskName": "Space Reclamation" } }, "pattern": { "active_end_occurence": 0, "freq_subday_interval": 0, "freq_type": 1024, "patternId": 35, "flags": 0, "description": "", "active_end_time": 0, "active_end_date": 0, "skipOccurence": 0, "skipDayNumber": 0, "active_start_time": 0, "freq_restart_interval": 0, "active_start_date": 1522886400, "freq_interval": 0, "freq_relative_interval": 0, "name": "Space Reclamation", "freq_recurrence_factor": 0, "calendar": { "calendarName": "Standard", "calendarId": 1 }, "timeZone": { "TimeZoneID": 1000 } }, "options": { "backupOpts": { "truncateLogsOnSource": false, "backupLevel": 4, "incLevel": 0, "runIncrementalBackup": false, "doNotTruncateLog": false, "vsaBackupOptions": { "backupFailedVMsOnly": false }, "dataOpt": { "useCatalogServer": true, "followMountPoints": true, "enforceTransactionLogUsage": false, "skipConsistencyCheck": false, "createNewIndex": true, "daysBetweenSyntheticBackup": 90, "autoCopy": true } }, "commonOpts": { "automaticSchedulePattern": { "maxBackupInterval": 72, "ignoreOpWindowPastMaxInterval": true, "minBackupIntervalMinutes": 15, "maxBackupIntervalMinutes": 0, "minSyncInterval": 0, "minBackupInterval": 0, "minSyncIntervalMinutes": 0, "stopIfOnBattery": { "enabled": false }, "acPower": { "enabled": false }, "specfificNetwork": { "enabled": false, "ipAddress": { "subnet": 24, "address": "0.0.0.0" } }, "stopSleepIfBackUp": { "enabled": false }, "newOrModifiedFile": { "enabled": false }, "wiredNetworkConnection": { "enabled": false }, "minNetworkBandwidth": { "enabled": false } } } } } ] }, "database": { "slaInMinutes": 0, "rpoInMinutes": 0, "scheduleLog": { "task": {} }, "storageLog": { "storagePolicy": {} }, "definesScheduleLog": { "definesEntity": false, "overrideEntity": 0 }, "definesStorageLog": { "definesEntity": false, "overrideEntity": 0 } }, "autoCreatedEntities": { "clientGroup": { "clientGroupId": 9, "clientGroupName": "edge drive plan clients" }, "localUserGroup": { "userGroupId": 14, "userGroupName": "edge drive plan users" } }, "eDiscoveryInfo": { "definesContentAnalyzerCloud": { "definesEntity": false, "overrideEntity": 0 }, "definesAnalyticsIndexServer": { "definesEntity": false, "overrideEntity": 0 } }, "options": { "forcedArchiving": false, "quota": 19, "network": { "enableThrottle": true, "throttle": { "shareBandwidth": true, "throttle": [ { "sendRate": 223, "recvRate": -1 } ] } } }, "exchange": { "definesMBRetention": { "definesEntity": false, "overrideEntity": 0 }, "definesMBCleanup": { "definesEntity": false, "overrideEntity": 0 }, "definesMBArchiving": { "definesEntity": false, "overrideEntity": 0 }, "definesMBJournal": { "definesEntity": false, "overrideEntity": 0 } }, "definition": { "possible": [ 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 65537, 65538, 65539, 65540, 65541, 65542 ], "required": [ 1, 4, 8, 16, 256, 512, 1024, 2048 ] } }, "errors": [ { "entity": {}, "status": { "errorMessage": "", "errorCode": 0 } } ]
}