Execute QCommand

[Deprecation notice]

Starting from FR36, this API will no longer be supported and will be deprecated. Instead, kindly utilize /qcommand/qoperation as a substitute.

Commvault REST APIs support sending QCommands as a request.

QCommands:
- For a list of available CommServe QCommands, see Command Line Interface - CommServe QCommands.
- For a list of MediaAgent QCommands, see Command Line Interface - MediaAgent - QCommands.
QCommands using XML files (qoperation execute):
- For a list of CommServe XML files, see CommServe XML Files on the Command Line.
- For a list of MediaAgent XML files, see Command Line Interface - MediaAgent - XML Files.
- Other areas of the application offer XML files, for example, Command Line Configuration - Virtual Server Agent for VMware. Go to the command line documentation for the specific agent to view the available XML files.
- For information on creating XML files using Save As Script, see Save as Script Overview.
QScripts (qoperation execscript): for a list of available QScripts, see Command Line Operations Using QScripts.

More Details

Header Parameters

Content-Type string required
Possible values: [application/x-www-form-urlencoded]

application/x-www-form-urlencoded

Request Body

command string
inputRequestXML string

Responses

application/json

Schema
Example (from schema)
Execute Q Command

Schema

installPackageInfo object[]
displayName string
isPackageAlreadyInstalled boolean
parentPath string
packageId integer
description string
packageName string
requiredPackageIds integer[]
excludePackages integer[]

{
  "installPackageInfo": [
    {
      "displayName": "string",
      "isPackageAlreadyInstalled": true,
      "parentPath": "string",
      "packageId": 0,
      "description": "string",
      "packageName": "string",
      "requiredPackageIds": [
        0
      ]
    }
  ],
  "excludePackages": [
    0
  ]
}

{
  "installPackageInfo": [
    {
      "displayName": "MediaAgent",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 51,
      "description": "Administers the data protection and recovery operations between the client programs and the storage resources.",
      "packageName": "MediaAgent",
      "requiredPackageIds": [
        381,
        554,
        504,
        252,
        257,
        755
      ]
    },
    {
      "displayName": "Index Store",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 55,
      "description": "Supports various features for analyzing clients in the CommCell environment.",
      "packageName": "Index Store",
      "requiredPackageIds": [
        733
      ]
    },
    {
      "displayName": "Commcell Console",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 701,
      "description": "User Interface to administer the activities of a CommCell.",
      "packageName": "Commcell Console",
      "requiredPackageIds": [
        21,
        20
      ]
    },
    {
      "displayName": "Command Center",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 726,
      "packageName": "Command Center",
      "requiredPackageIds": [
        732
      ]
    },
    {
      "displayName": "File System Core",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 1,
      "description": "Common software base providing basic core functionalities.",
      "packageName": "File System Core",
      "requiredPackageIds": [
        758,
        504,
        727,
        713,
        354,
        257,
        554,
        751,
        734,
        55,
        252,
        352,
        24,
        732,
        715,
        952,
        356,
        259,
        202,
        382,
        451,
        551,
        363,
        957,
        703,
        729,
        204,
        755,
        353,
        707,
        453,
        733,
        719,
        151,
        54,
        702,
        351,
        23,
        360,
        263,
        954,
        726,
        21,
        455,
        201,
        358,
        752,
        730,
        25,
        362,
        51,
        725,
        20,
        160,
        711,
        203,
        754,
        255,
        158,
        452,
        355,
        101,
        552,
        381
      ]
    },
    {
      "displayName": "File System",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 702,
      "description": "Provides backup and recovery operations of the File System data.",
      "packageName": "File System",
      "requiredPackageIds": [
        202,
        727,
        755,
        24,
        703,
        252,
        957,
        734,
        551,
        354,
        382,
        356,
        453,
        707,
        358,
        21,
        726,
        363,
        351,
        451,
        353,
        201,
        455,
        158,
        101,
        552,
        355,
        203,
        360,
        23,
        151,
        713,
        362,
        730,
        504,
        381,
        732,
        452,
        255,
        352,
        554,
        257,
        20,
        51
      ]
    },
    {
      "displayName": "VSS Provider",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 453,
      "description": "Provider for Volume Shadow Services.",
      "packageName": "VSS Provider",
      "requiredPackageIds": [
        755
      ]
    },
    {
      "displayName": "VSS Hardware Provider",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 455,
      "packageName": "VSS Hardware Provider"
    },
    {
      "displayName": "Virtual Server",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 713,
      "description": "Provides backup and recovery for guest machines in the VMware ESX Server and Microsoft System Center Virtual Machine Manager.",
      "packageName": "VirtualServer Agent"
    },
    {
      "displayName": "Web Server",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 252,
      "description": "Provides multi-purpose flexible search capabilities for indexed data.",
      "packageName": "Web Server"
    },
    {
      "displayName": "Content Extractor",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 259,
      "packageName": "Content Extractor",
      "requiredPackageIds": [
        257,
        729,
        733
      ]
    },
    {
      "displayName": "Content Analyzer",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 729,
      "packageName": "Content Analyzer"
    },
    {
      "displayName": "Commserve DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 801,
      "packageName": "Commserve DB"
    },
    {
      "displayName": "DM2 Web services DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 803,
      "packageName": "DM2 Web services DB",
      "requiredPackageIds": [
        252
      ]
    },
    {
      "displayName": "Workflow Engine DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 808,
      "packageName": "Workflow Engine DB",
      "requiredPackageIds": [
        23
      ]
    },
    {
      "displayName": "Metrics Reporting DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 809,
      "packageName": "Metrics Reporting DB",
      "requiredPackageIds": [
        20,
        727,
        21
      ]
    },
    {
      "displayName": "Commserve History DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 810,
      "packageName": "Commserve History DB"
    },
    {
      "displayName": "Commserve ResourceMgr DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 811,
      "packageName": "Commserve ResourceMgr DB"
    },
    {
      "displayName": "Commserve Audit DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 812,
      "packageName": "Commserve Audit DB"
    },
    {
      "displayName": "Commserve Cache DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 813,
      "packageName": "Commserve Cache DB"
    },
    {
      "displayName": "Commserve Template DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 814,
      "packageName": "Commserve Template DB"
    },
    {
      "displayName": "Commserve AppStudio DB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 815,
      "packageName": "Commserve AppStudio DB"
    },
    {
      "displayName": "MongoDB",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 952,
      "packageName": "MongoDB",
      "requiredPackageIds": [
        252
      ]
    },
    {
      "displayName": "CommServe",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 20,
      "description": "Centralized Server to initiate and administer the operations of the CommCell.",
      "packageName": "CommServe",
      "requiredPackageIds": [
        21
      ]
    },
    {
      "displayName": "Work Flow",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 23,
      "packageName": "Workflow Engine"
    },
    {
      "displayName": "Metrics Reporting",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 727,
      "packageName": "Metrics Reporting",
      "requiredPackageIds": [
        21,
        20
      ]
    },
    {
      "displayName": "High Availability Computing",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 725,
      "packageName": "High Availability Computing",
      "requiredPackageIds": [
        24,
        733
      ]
    },
    {
      "displayName": "Storage Accelerator",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 54,
      "description": "Administers the data protection and recovery operations between the client programs and the storage resources.",
      "packageName": "MediaAgent Core",
      "requiredPackageIds": [
        263,
        733,
        51,
        381,
        554,
        252,
        257,
        504,
        755
      ]
    },
    {
      "displayName": "Message Queue",
      "isPackageAlreadyInstalled": true,
      "parentPath": "Packages/Windows",
      "packageId": 954,
      "packageName": "Message Queue",
      "requiredPackageIds": [
        729,
        252
      ]
    }
  ],
  "excludePackages": [
    6001,
    6002,
    6003,
    6004,
    6005,
    6006
  ]
}

POST /executeqcommand

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

Content-Type — header required

Body

command

inputRequestXML

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/ExecuteQCommand' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Execute QCommand​

Authorization

Request

Execute QCommand