Modify Log File properties
This API can be used to change the log file level, file version and the file size remotely on a client .
Path Parameters
- ClientID string required
- LogFileName string required
Header Parameters
- Accept string required
- application/json
Request Body required
- fileSizeInMB integer
- fileVersions integer
- debugLevel integer
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1 Client Check Readiness - Quick
Schema
response object
{
"response": {}
}
{
"summary": [
{
"entityStatus": 0,
"status": "Ready.",
"entity": {
"entityType": 3,
"entityName": "Client",
"_type_": 0
}
},
{
"entityStatus": 0,
"status": "Ready.",
"entity": {
"entityType": 3,
"entityName": "MediaAgent",
"_type_": 0
}
}
],
"IndexCache": [
{
"ReadinessStatus": "Ready.\n",
"IndexCachePath": "C:/Program Files/Commvault/ContentStore/IndexCache"
}
],
"detail": [
{
"Compression": "Off",
"MediaAgent": "N/A",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "N/A",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/53287_backupset/default",
"_type_": 0
}
},
{
"Compression": "Off",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "CommServeDR(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "CommServe Management/DR-BackupSet/DR Subclient",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/default",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Server plan snap copy)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/default",
"_type_": 0
}
},
{
"Compression": "Off",
"MediaAgent": "dm2perf3",
"Deduplication": "Off",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/DDBBackup",
"_type_": 0
}
},
{
"Compression": "Off",
"MediaAgent": "dm2perf3",
"Deduplication": "Off",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Server plan snap copy)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/DDBBackup",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/small",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Server plan snap copy)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/small",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/backedup_test",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Server plan snap copy)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/defaultBackupSet/backedup_test",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Primary)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/53287_backupset/53287_subclient",
"_type_": 0
}
},
{
"Compression": "On Client",
"MediaAgent": "dm2perf3",
"Deduplication": "On Client",
"ReadinessStatus": "Ready.\n",
"StoragePolicy": "Server plan(Server plan snap copy)",
"Subclient": {
"entityType": 7,
"entityName": "Windows File System/53287_backupset/53287_subclient",
"_type_": 0
}
}
]
}
POST /client/:clientid/log/:logfilename
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Client/:ClientID/Log/:LogFileName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"fileSizeInMB": 0,
"fileVersions": 0,
"debugLevel": 0
}'