Skip to main content

Install Oracle agent on database server​

Select

SaaS
Customer Managed

This operation is used to install Oracle agent on database server

Request Body
  • taskInfo object
  • task object
  • taskType

    Possible values: [IMMEDIATE, SCHEDULE, SAVED_REPORT, SCHEDULE_POLICY]

    Default value: IMMEDIATE

  • subtasks object[] required
  • subtask object required
  • subTaskType string

    Default value: ADMIN

  • operationType string

    Default value: INSTALL_CLIENT

  • options object
  • adminOpts object
  • clientInstallation object required
  • installerOption object
  • User object
  • userId integer

    Default value: 1

  • userName string

    Default value: ADMIN

  • CommservehostName string required

    The Commserve HostName

  • installFlags object

    Internal Fields

  • allowMultipleInstance boolean

    Default value: false

  • install32Base boolean

    Default value: false

  • disableOSFirewall boolean

    Default value: false

  • addToFirewallExclusion boolean

    Default value: true

  • forceReboot boolean

    Default value: false

  • killBrowserProcesses boolean

    Default value: true

  • ignoreJobsRunning boolean

    Default value: false

  • stopOracleServices boolean

    Set to True for Windows servers

  • restoreOnlyAgents boolean

    Default value: false

  • skipClientsofCS boolean

    Default value: false

  • overrideClientInfo boolean

    Default value: true

  • unixGroup string

    Database unix group used for database operations.

  • unixGroupAccess integer

    Default value: 7

  • unixOtherAccess integer

    Default value: 5

  • overrideUnixGroupaAndPermissions boolean

    Default value: true

  • firewallInstall object
  • enableFirewallConfig boolean

    Default value: false

  • firewallConnectionType integer
  • portNumber integer
  • ClientComposition object[]
  • components object

    Packages to be installed

  • componentInfo object[] required
  • ComponentName string

    Default value: Oracle

  • ComponentId integer

    Default value: 1204

    ComponentId for oracle is 1204

  • osType

    Possible values: [Windows, Unix]

  • clientInfo object

    Internal Fields

  • client object
  • evmgrcPort integer
  • cvdPort integer
  • clientDetails object[]
  • clientEntity object
  • clientName string

    Client name

  • hostName string

    Host name of client

  • displayame string

    Host name of client

  • installOSType integer

    Possible values: [0- Windows, 1- Unix]

  • discoveryType integer
  • ClientAuthForJob object
  • userName string

    OS User name of Client

  • password string

    Base64 encoded string of OS password

  • updateOption object
  • plan object
  • planId integer

    PlanID of plan to be associated to the client

Responses

OK

Schema
  • taskId integer
  • jobIds string[]

    JobIds of install jobs triggered

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "task": {},

    "subtasks": [

      {

        "subtask": {

          "subTaskType": "ADMIN",

          "operationType": "INSTALL_CLIENT"

        },

        "options": {

          "adminOpts": {

            "clientInstallation": {

              "installerOption": {

                "User": {

                  "userId": 1,

                  "userName": "ADMIN"

                },

                "CommservehostName": "string",

                "installFlags": {

                  "allowMultipleInstance": false,

                  "install32Base": false,

                  "disableOSFirewall": false,

                  "addToFirewallExclusion": true,

                  "forceReboot": false,

                  "killBrowserProcesses": true,

                  "ignoreJobsRunning": false,

                  "stopOracleServices": true,

                  "restoreOnlyAgents": false,

                  "skipClientsofCS": false,

                  "overrideClientInfo": true,

                  "unixGroup": "string",

                  "unixGroupAccess": 7,

                  "unixOtherAccess": 5,

                  "overrideUnixGroupaAndPermissions": true,

                  "firewallInstall": {

                    "enableFirewallConfig": false,

                    "firewallConnectionType": 0,

                    "portNumber": 0

                  }

                },

                "ClientComposition": [

                  {

                    "components": {

                      "componentInfo": [

                        {

                          "ComponentName": "Oracle",

                          "ComponentId": 1204

                        }

                      ]

                    },

                    "clientInfo": {

                      "client": {

                        "evmgrcPort": 0,

                        "cvdPort": 0

                      }

                    }

                  }

                ]

              },

              "clientDetails": [

                {

                  "clientEntity": {

                    "clientName": "string",

                    "hostName": "string",

                    "displayame": "string"

                  }

                }

              ],

              "installOSType": "0- Windows",

              "discoveryType": 0,

              "ClientAuthForJob": {

                "userName": "string",

                "password": "string"

              }

            },

            "updateOption": {

              "plan": {

                "planId": 0

              }

            }

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {},
    "subtasks": [
      {
        "subtask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "clientInstallation": {
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommservehostName": "string",
                "installFlags": {
                  "allowMultipleInstance": false,
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": true,
                  "restoreOnlyAgents": false,
                  "skipClientsofCS": false,
                  "overrideClientInfo": true,
                  "unixGroup": "string",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupaAndPermissions": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                },
                "ClientComposition": [
                  {
                    "components": {
                      "componentInfo": [
                        {
                          "ComponentName": "Oracle",
                          "ComponentId": 1204
                        }
                      ]
                    },
                    "clientInfo": {
                      "client": {
                        "evmgrcPort": 0,
                        "cvdPort": 0
                      }
                    }
                  }
                ]
              },
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "hostName": "string",
                    "displayame": "string"
                  }
                }
              ],
              "installOSType": "0- Windows",
              "discoveryType": 0,
              "ClientAuthForJob": {
                "userName": "string",
                "password": "string"
              }
            },
            "updateOption": {
              "plan": {
                "planId": 0
              }
            }
          }
        }
      }
    ]
  }
}'