Skip to main content

Install MySQL Database Server​

This operation is used to install a MySQL Database Server

Request Body
  • taskInfo object
  • associations object[]
  • commCellId integer
  • task object
  • taskType integer
  • subTasks object[] required
  • subTask object required
  • subTaskType string

    Default value: ADMIN

  • operationType string

    Default value: INSTALL_CLIENT

  • options object
  • backupOpts object
  • backupLevel integer
  • commonOpts object
  • notifyUserOnJobCompletion boolean
  • jobMetadata object[]
  • adminOpts object
  • clientInstallOption object required
  • installerOption object
  • User object
  • userId integer

    Default value: 1

  • userName string

    Default value: ADMIN

  • CommServeHostName string required

    The CommServe HostName

  • installFlags object
  • allowMultipleInstances boolean
  • install32Base boolean
  • disableOSFirewall boolean
  • addToFirewallExclusion boolean
  • forceReboot boolean
  • killBrowserProcesses boolean
  • ignoreJobsRunning boolean
  • stopOracleServices boolean
  • skipClientsOfCS boolean
  • restoreOnlyAgents boolean
  • overrideClientInfo boolean
  • firewallInstall object
  • enableFirewallConfig boolean
  • firewallConnectionType integer
  • portNumber integer
  • unixGroup string

    Database unix group used for database operations

  • unixGroupAccess integer
  • unixOtherAccess integer
  • overrideUnixGroupAndPermissions boolean
  • clientComposition object[]
  • components object

    Packages to be installed

  • componentInfo object[] required
  • ComponentName string

    Default value: MySQL

  • ComponentId integer

    Default value: 1208

    ComponentId for MySQL is 1208

  • osType

    Possible values: [Unix, Windows]

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

    ClientId of client on which MySQL agent is being installed. It is set to 0 for new clients.

  • clientName string

    Client name

  • hostName string

    Host name of client

  • displayName string

    Display name of client

  • discoveryType integer
  • clientAuthForJob object required
  • userName string

    Operating System user name of client

  • password string

    Base 64 encoded string of Operating system user's password

  • updateOption object
  • rebootClient boolean
  • plan object required
  • planName string

    Plan name to be associated to the client

Responses

OK

Response Headers
    Schema
    • taskId integer
    • jobIds string[]

      JobId of install job triggered

    POST /createtask

    Authorization

    type: apiKeyname: Authtokenin: header

    Request

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

      "taskInfo": {

        "associations": [

          {

            "commCellId": 0

          }

        ],

        "task": {

          "taskType": 0

        },

        "subTasks": [

          {

            "subTask": {

              "subTaskType": "ADMIN",

              "operationType": "INSTALL_CLIENT"

            },

            "options": {

              "backupOpts": {

                "backupLevel": 0

              },

              "commonOpts": {

                "notifyUserOnJobCompletion": true,

                "jobMetadata": [

                  {}

                ]

              },

              "adminOpts": {

                "clientInstallOption": {

                  "installerOption": {

                    "User": {

                      "userId": 1,

                      "userName": "ADMIN"

                    },

                    "CommServeHostName": "string",

                    "installFlags": {

                      "allowMultipleInstances": true,

                      "install32Base": true,

                      "disableOSFirewall": true,

                      "addToFirewallExclusion": true,

                      "forceReboot": true,

                      "killBrowserProcesses": true,

                      "ignoreJobsRunning": true,

                      "stopOracleServices": true,

                      "skipClientsOfCS": true,

                      "restoreOnlyAgents": true,

                      "overrideClientInfo": true,

                      "firewallInstall": {

                        "enableFirewallConfig": true,

                        "firewallConnectionType": 0,

                        "portNumber": 0

                      },

                      "unixGroup": "string",

                      "unixGroupAccess": 0,

                      "unixOtherAccess": 0,

                      "overrideUnixGroupAndPermissions": true

                    },

                    "clientComposition": [

                      {

                        "components": {

                          "componentInfo": [

                            {

                              "ComponentName": "MySQL",

                              "ComponentId": 1208

                            }

                          ]

                        },

                        "clientInfo": {

                          "client": {

                            "evmgrcPort": 0,

                            "cvdPort": 0

                          }

                        }

                      }

                    ]

                  },

                  "clientDetails": [

                    {

                      "clientEntity": {

                        "clientId": 0,

                        "clientName": "string",

                        "hostName": "string",

                        "displayName": "string"

                      }

                    }

                  ],

                  "discoveryType": 0,

                  "clientAuthForJob": {

                    "userName": "string",

                    "password": "string"

                  }

                },

                "updateOption": {

                  "rebootClient": true,

                  "plan": {

                    "planName": "string"

                  }

                }

              }

            }

          }

        ]

      }

    }

    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": {
        "associations": [
          {
            "commCellId": 0
          }
        ],
        "task": {
          "taskType": 0
        },
        "subTasks": [
          {
            "subTask": {
              "subTaskType": "ADMIN",
              "operationType": "INSTALL_CLIENT"
            },
            "options": {
              "backupOpts": {
                "backupLevel": 0
              },
              "commonOpts": {
                "notifyUserOnJobCompletion": true,
                "jobMetadata": [
                  {}
                ]
              },
              "adminOpts": {
                "clientInstallOption": {
                  "installerOption": {
                    "User": {
                      "userId": 1,
                      "userName": "ADMIN"
                    },
                    "CommServeHostName": "string",
                    "installFlags": {
                      "allowMultipleInstances": true,
                      "install32Base": true,
                      "disableOSFirewall": true,
                      "addToFirewallExclusion": true,
                      "forceReboot": true,
                      "killBrowserProcesses": true,
                      "ignoreJobsRunning": true,
                      "stopOracleServices": true,
                      "skipClientsOfCS": true,
                      "restoreOnlyAgents": true,
                      "overrideClientInfo": true,
                      "firewallInstall": {
                        "enableFirewallConfig": true,
                        "firewallConnectionType": 0,
                        "portNumber": 0
                      },
                      "unixGroup": "string",
                      "unixGroupAccess": 0,
                      "unixOtherAccess": 0,
                      "overrideUnixGroupAndPermissions": true
                    },
                    "clientComposition": [
                      {
                        "components": {
                          "componentInfo": [
                            {
                              "ComponentName": "MySQL",
                              "ComponentId": 1208
                            }
                          ]
                        },
                        "clientInfo": {
                          "client": {
                            "evmgrcPort": 0,
                            "cvdPort": 0
                          }
                        }
                      }
                    ]
                  },
                  "clientDetails": [
                    {
                      "clientEntity": {
                        "clientId": 0,
                        "clientName": "string",
                        "hostName": "string",
                        "displayName": "string"
                      }
                    }
                  ],
                  "discoveryType": 0,
                  "clientAuthForJob": {
                    "userName": "string",
                    "password": "string"
                  }
                },
                "updateOption": {
                  "rebootClient": true,
                  "plan": {
                    "planName": "string"
                  }
                }
              }
            }
          }
        ]
      }
    }'