Install Oracle agent on database server
Select
This operation is used to install Oracle agent on database server
- application/json
Request Body
taskInfo object
task object
taskTypePossible values: [
IMMEDIATE
,SCHEDULE
,SAVED_REPORT
,SCHEDULE_POLICY
]Default value:
IMMEDIATE
subtasks object[] required
subtask object required
subTaskType stringDefault value:
ADMIN
operationType stringDefault value:
INSTALL_CLIENT
options object
adminOpts object
clientInstallation object required
installerOption object
User object
userId integerDefault value:
1
userName stringDefault value:
ADMIN
CommservehostName string requiredThe Commserve HostName
installFlags object
Internal Fields
allowMultipleInstance 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 booleanSet to True for Windows servers
restoreOnlyAgents booleanDefault value:
false
skipClientsofCS booleanDefault value:
false
overrideClientInfo booleanDefault value:
true
unixGroup stringDatabase unix group used for database operations.
unixGroupAccess integerDefault value:
7
unixOtherAccess integerDefault value:
5
overrideUnixGroupaAndPermissions booleanDefault value:
true
firewallInstall object
enableFirewallConfig booleanDefault value:
false
firewallConnectionType integerportNumber integerClientComposition object[]
components object
Packages to be installed
componentInfo object[] required
ComponentName stringDefault value:
Oracle
ComponentId integerDefault value:
1204
ComponentId for oracle is 1204
osTypePossible values: [
Windows
,Unix
]clientInfo object
Internal Fields
client object
evmgrcPort integercvdPort integerclientDetails object[]
clientEntity object
clientName stringClient name
hostName stringHost name of client
displayame stringHost name of client
installOSType integerPossible values: [
0- Windows
,1- Unix
]discoveryType integerClientAuthForJob object
userName stringOS User name of Client
password stringBase64 encoded string of OS password
updateOption object
plan object
planId integerPlanID of plan to be associated to the client
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
- taskId integer
- jobIds string[]
JobIds of install jobs triggered
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 1110009,
"jobIds": [
"44725"
]
}
Bad Request
- application/json
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}