Skip to main content

Push install MSSQL agent on a Windows server​

This operation is used to install the MSSQL agent on a server

Request Body
  • taskInfo object
  • task object
  • taskType

    Possible values: [IMMEDIATE, SCHEDULE]

    Default value: IMMEDIATE

  • subTasks object[]
  • subTask object
  • subTaskType integer
  • operationType string

    Default value: INSTALL_CLIENT

  • options object
  • adminOpts object
  • clientInstallOption object
  • installerOption object
  • User object
  • userId integer

    Default value: 1

  • userName string

    Default value: ADMIN

  • CommServeHostName string required

    Hostname of the commserver

  • installFlags object

    Internal fields required for install

  • allowMultipleInstances 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

    Default value: false

  • skipClientsOfCS boolean

    Default value: false

  • restoreOnlyAgents boolean

    Default value: false

  • overrideClientInfo boolean

    Default value: true

  • firewallInstall object
  • enableFirewallConfig boolean

    Default value: false

  • firewallConnectionType integer
  • portNumber integer
  • clientComposition object[]
  • components object
  • componentInfo object[] required
  • ComponentName string

    Default value: SQL Server

  • ComponentId integer

    Default value: 353

  • osType string

    Default value: windows

  • sqlAgent object required
  • instanceAutoDiscovery boolean

    Default value: true

  • MSSQLCredentialinfo object

    Info of the credential record used for SQL impersonation

  • credentialId integer

    ID of the credential record

  • clientInfo object
  • client object
  • evmgrcPort integer
  • cvdPort integer
  • clientDetails object[]
  • clientEntity object required
  • clientId integer

    Client id of the server where MSSQL agent is installed. For new clients, set this to zero

  • clientName string

    Client name

  • hostName string

    Host name of the client

  • displayName string

    Name to be displayed on commcell console/command centre

  • installOSType integer
  • discoveryType integer
  • clientAuthForJob object required

    Credential record for install

  • savedCredential object
  • credentialId integer

    ID of the credential record to sign in to client to perform install

  • updateOption object
  • rebootClient boolean

    Default value: true

  • plan object required
  • planId integer

    Plan id of the plan to be associated with client

Responses

OK

Schema
  • taskId integer
  • jobIds string[]

    Install Job ID(s)

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": 0,

          "operationType": "INSTALL_CLIENT"

        },

        "options": {

          "adminOpts": {

            "clientInstallOption": {

              "installerOption": {

                "User": {

                  "userId": 1,

                  "userName": "ADMIN"

                },

                "CommServeHostName": "string",

                "installFlags": {

                  "allowMultipleInstances": false,

                  "install32Base": false,

                  "disableOSFirewall": false,

                  "addToFirewallExclusion": true,

                  "forceReboot": false,

                  "killBrowserProcesses": true,

                  "ignoreJobsRunning": false,

                  "stopOracleServices": false,

                  "skipClientsOfCS": false,

                  "restoreOnlyAgents": false,

                  "overrideClientInfo": true,

                  "firewallInstall": {

                    "enableFirewallConfig": false,

                    "firewallConnectionType": 0,

                    "portNumber": 0

                  }

                },

                "clientComposition": [

                  {

                    "components": {

                      "componentInfo": [

                        {

                          "ComponentName": "SQL Server",

                          "ComponentId": 353,

                          "osType": "windows"

                        }

                      ],

                      "sqlAgent": {

                        "instanceAutoDiscovery": true,

                        "MSSQLCredentialinfo": {

                          "credentialId": 0

                        }

                      }

                    },

                    "clientInfo": {

                      "client": {

                        "evmgrcPort": 0,

                        "cvdPort": 0

                      }

                    }

                  }

                ]

              },

              "clientDetails": [

                {

                  "clientEntity": {

                    "clientId": 0,

                    "clientName": "string",

                    "hostName": "string",

                    "displayName": "string"

                  }

                }

              ],

              "installOSType": 0,

              "discoveryType": 0,

              "clientAuthForJob": {

                "savedCredential": {

                  "credentialId": 0

                }

              }

            },

            "updateOption": {

              "rebootClient": true,

              "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": 0,
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "clientInstallOption": {
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "installFlags": {
                  "allowMultipleInstances": false,
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                },
                "clientComposition": [
                  {
                    "components": {
                      "componentInfo": [
                        {
                          "ComponentName": "SQL Server",
                          "ComponentId": 353,
                          "osType": "windows"
                        }
                      ],
                      "sqlAgent": {
                        "instanceAutoDiscovery": true,
                        "MSSQLCredentialinfo": {
                          "credentialId": 0
                        }
                      }
                    },
                    "clientInfo": {
                      "client": {
                        "evmgrcPort": 0,
                        "cvdPort": 0
                      }
                    }
                  }
                ]
              },
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientId": 0,
                    "clientName": "string",
                    "hostName": "string",
                    "displayName": "string"
                  }
                }
              ],
              "installOSType": 0,
              "discoveryType": 0,
              "clientAuthForJob": {
                "savedCredential": {
                  "credentialId": 0
                }
              }
            },
            "updateOption": {
              "rebootClient": true,
              "plan": {
                "planId": 0
              }
            }
          }
        }
      }
    ]
  }
}'