Push install MSSQL agent on a Windows server
Select
This operation is used to install the MSSQL agent on a server
- application/json
Request Body
taskInfo object
task object
taskTypePossible values: [
IMMEDIATE
,SCHEDULE
]Default value:
IMMEDIATE
subTasks object[]
subTask object
subTaskType integeroperationType stringDefault value:
INSTALL_CLIENT
options object
adminOpts object
clientInstallOption object
installerOption object
User object
userId integerDefault value:
1
userName stringDefault value:
ADMIN
CommServeHostName string requiredHostname of the commserver
installFlags object
Internal fields required for install
allowMultipleInstances booleanDefault value:
false
install32Base booleanDefault value:
false
disableOSFirewall booleanDefault value:
false
addToFirewallExclusion booleanDefault value:
true
forceReboot booleanDefault value:
false
killBrowserProcesses booleanDefault value:
true
ignoreJobsRunning booleanDefault value:
false
stopOracleServices booleanDefault value:
false
skipClientsOfCS booleanDefault value:
false
restoreOnlyAgents booleanDefault value:
false
overrideClientInfo booleanDefault value:
true
firewallInstall object
enableFirewallConfig booleanDefault value:
false
firewallConnectionType integerportNumber integerclientComposition object[]
components object
componentInfo object[] required
ComponentName stringDefault value:
SQL Server
ComponentId integerDefault value:
353
osType stringDefault value:
windows
sqlAgent object required
instanceAutoDiscovery booleanDefault value:
true
MSSQLCredentialinfo object
Info of the credential record used for SQL impersonation
credentialId integerID of the credential record
clientInfo object
client object
evmgrcPort integercvdPort integerclientDetails object[]
clientEntity object required
clientId integerClient id of the server where MSSQL agent is installed. For new clients, set this to zero
clientName stringClient name
hostName stringHost name of the client
displayName stringName to be displayed on commcell console/command centre
installOSType integerdiscoveryType integerclientAuthForJob object required
Credential record for install
savedCredential object
credentialId integerID of the credential record to sign in to client to perform install
updateOption object
rebootClient booleanDefault value:
true
plan object required
planId integerPlan id of the plan to be associated with client
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
Install Job ID(s)
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 30450,
"jobIds": [
"149481"
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid.
Unauthorized
- application/json
- application/xml
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid.
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
Default value:
Access denied
- errorCode integer
Default value:
5
<root>
<errorMessage>Access denied</errorMessage>
<errorCode>5</errorCode>
</root>
{
"errorMessage": "Access denied",
"errorCode": 5
}