Skip to main content

Add Sybase Server​

Select

SaaS
Customer Managed

This operation is used to install Sybase Agent on database servers

Request Body
  • taskInfo object
  • task object
  • taskFlags object
  • disabled boolean required
  • taskType string required

    Default value: IMMEDIATE

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

  • initiatedFrom string required

    Default value: GUI

  • associations object[]
  • commCellId integer required
  • subTasks object[]
  • subTask object
  • subTaskType string required

    Default value: ADMIN

  • operationType string required

    Default value: INSTALL_CLIENT

  • options object
  • adminOpts object
  • updateOption object
  • rebootClient boolean required
  • clientInstallOption object
  • clientDetails object[]
  • clientEntity object
  • clientName string required

    Hostname or IP address of the client

  • commCellId integer required
  • installOSType string required

    UNIX or WINDOWS

  • discoveryType string required

    Default value: MANUAL

  • installerOption object
  • RemoteClient boolean required
  • requestType string required

    Default value: PRE_DECLARE_CLIENT

  • User object
  • userId integer required

    Default value: 1

  • userName string required

    Default value: admin

  • Operationtype string required

    Default value: INSTALL_CLIENT

  • CommServeHostName string required

    Hostname of the Commserver

  • clientComposition object[]
  • clientInfo object
  • client object
  • cvdPort integer required
  • evmgrcPort integer required
  • components object
  • componentInfo object[]
  • ComponentName string required

    Name of the Package to be installed

  • osType string required
  • ComponentId integer
  • installFlags object
  • install32Base boolean required
  • disableOSFirewall boolean required
  • addToFirewallExclusion boolean required
  • forceReboot boolean
  • killBrowserProcesses boolean
  • ignoreJobsRunning boolean
  • unixGroup string

    Unix group f

  • unixGroupAccess integer required
  • unixOtherAccess integer required
  • overrideUnixGroupAndPermissions boolean required
  • restoreOnlyAgents boolean required
  • overrideClientInfo boolean required
  • firewallInstall object
  • enableFirewallConfig boolean
  • firewallConnectionType integer

    Firewall Connection Type

  • portNumber integer
  • clientAuthForJob object
  • userName string

    Username used to login to the client

  • password string

    Base64 encoded password

  • reuseADCredentials boolean
  • commonOpts object
  • notifyUserOnJobCompletion boolean required
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "taskInfo": {

    "task": {

      "taskFlags": {

        "disabled": true

      },

      "taskType": "IMMEDIATE",

      "initiatedFrom": "GUI"

    },

    "associations": [

      {

        "commCellId": 0

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "ADMIN",

          "operationType": "INSTALL_CLIENT"

        },

        "options": {

          "adminOpts": {

            "updateOption": {

              "rebootClient": true

            },

            "clientInstallOption": {

              "clientDetails": [

                {

                  "clientEntity": {

                    "clientName": "string",

                    "commCellId": 0

                  }

                }

              ],

              "installOSType": "string",

              "discoveryType": "MANUAL",

              "installerOption": {

                "RemoteClient": true,

                "requestType": "PRE_DECLARE_CLIENT",

                "User": {

                  "userId": 1,

                  "userName": "admin"

                },

                "Operationtype": "INSTALL_CLIENT",

                "CommServeHostName": "string",

                "clientComposition": [

                  {

                    "clientInfo": {

                      "client": {

                        "cvdPort": 0,

                        "evmgrcPort": 0

                      }

                    },

                    "components": {

                      "componentInfo": [

                        {

                          "ComponentName": "string",

                          "osType": "string",

                          "ComponentId": 0

                        }

                      ]

                    }

                  }

                ],

                "installFlags": {

                  "install32Base": true,

                  "disableOSFirewall": true,

                  "addToFirewallExclusion": true,

                  "forceReboot": true,

                  "killBrowserProcesses": true,

                  "ignoreJobsRunning": true,

                  "unixGroup": "string",

                  "unixGroupAccess": 0,

                  "unixOtherAccess": 0,

                  "overrideUnixGroupAndPermissions": true,

                  "restoreOnlyAgents": true,

                  "overrideClientInfo": true,

                  "firewallInstall": {

                    "enableFirewallConfig": true,

                    "firewallConnectionType": 0,

                    "portNumber": 0

                  }

                }

              },

              "clientAuthForJob": {

                "userName": "string",

                "password": "string"

              },

              "reuseADCredentials": true

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true

          }

        }

      }

    ]

  }

}

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": {
      "taskFlags": {
        "disabled": true
      },
      "taskType": "IMMEDIATE",
      "initiatedFrom": "GUI"
    },
    "associations": [
      {
        "commCellId": 0
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": true
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 0
                  }
                }
              ],
              "installOSType": "string",
              "discoveryType": "MANUAL",
              "installerOption": {
                "RemoteClient": true,
                "requestType": "PRE_DECLARE_CLIENT",
                "User": {
                  "userId": 1,
                  "userName": "admin"
                },
                "Operationtype": "INSTALL_CLIENT",
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "ComponentName": "string",
                          "osType": "string",
                          "ComponentId": 0
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": true,
                  "disableOSFirewall": true,
                  "addToFirewallExclusion": true,
                  "forceReboot": true,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": true,
                  "unixGroup": "string",
                  "unixGroupAccess": 0,
                  "unixOtherAccess": 0,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": true,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": true,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'