Install SAP HANA Agent on Database server

Select

SaaS

Customer Managed

SAP HANA Agent Installtion

application/json

Request Body

taskInfo object
task object
taskType string
Default value: IMMEDIATE
Possible values: [IMMEDIATE, SCHEDULE, SCHEDULE_POLICY]
associations object[]
commCellId integer
Default value: 2
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
Default value: false
clientInstallOption object required
clientDetails object[]
clientEntity object
clientName string required
Client HOST name
commCellId integer
Default value: 2
installOSType string
Possible values: [1- Unix]
installerOption object
User object
userId integer
Default value: 1
userName string
Default value: ADMIN
CommServeHostName string required
The Commserve HostName
clientComposition object[]
overrideSoftwareCache boolean
Default value: false
clientInfo object
client object required
cvdPort integer
evmgrcPort integer
components object
componentInfo object[] required
osType string
Default value: Unix
ComponentId integer
Default value: 1210
ComponentId for SAP HANA
installFlags object
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
unixGroup string
Default value: sapsys
Database unix group used for database operations.
unixGroupAccess integer
Default value: 7
unixOtherAccess integer
Default value: 5
overrideUnixGroupAndPermissions boolean
Default value: true
restoreOnlyAgents boolean
Default value: false
overrideClientInfo boolean
Default value: true
firewallInstall object
enableFirewallConfig boolean
Default value: false
firewallConnectionType integer
portNumber integer
clientAuthForJob object required
userName string required
OS User name of Client
password string required
Base64 encoded string of OS password
reuseADCredentials boolean
Default value: false
commonOpts object
notifyUserOnJobCompletion boolean
Default value: false

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

taskId integer
jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 2019,
  "jobIds": [
    "2399"
  ]
}

Bad Request

application/json

Schema
Example 1

Schema

string

Request body is empty or format is invalid

Unauthorized

application/json

Schema
Example (from schema)
Example 1

Schema

errorMessage string
errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/commandcenter/api

Security Scheme

token

Body

Default
Example 1

{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "IMMEDIATE"
    },
    "associations": [
      {
        "commCellId": 2
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "ADMIN",
          "operationType": "INSTALL_CLIENT"
        },
        "options": {
          "adminOpts": {
            "updateOption": {
              "rebootClient": false
            },
            "clientInstallOption": {
              "clientDetails": [
                {
                  "clientEntity": {
                    "clientName": "string",
                    "commCellId": 2
                  }
                }
              ],
              "installOSType": "string",
              "installerOption": {
                "User": {
                  "userId": 1,
                  "userName": "ADMIN"
                },
                "CommServeHostName": "string",
                "clientComposition": [
                  {
                    "overrideSoftwareCache": false,
                    "clientInfo": {
                      "client": {
                        "cvdPort": 0,
                        "evmgrcPort": 0
                      }
                    },
                    "components": {
                      "componentInfo": [
                        {
                          "osType": "Unix",
                          "ComponentId": 1210
                        }
                      ]
                    }
                  }
                ],
                "installFlags": {
                  "install32Base": false,
                  "disableOSFirewall": false,
                  "addToFirewallExclusion": true,
                  "forceReboot": false,
                  "killBrowserProcesses": true,
                  "ignoreJobsRunning": false,
                  "stopOracleServices": false,
                  "skipClientsOfCS": false,
                  "unixGroup": "sapsys",
                  "unixGroupAccess": 7,
                  "unixOtherAccess": 5,
                  "overrideUnixGroupAndPermissions": true,
                  "restoreOnlyAgents": false,
                  "overrideClientInfo": true,
                  "firewallInstall": {
                    "enableFirewallConfig": false,
                    "firewallConnectionType": 0,
                    "portNumber": 0
                  }
                }
              },
              "clientAuthForJob": {
                "userName": "string",
                "password": "string"
              },
              "reuseADCredentials": false
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": false
          }
        }
      }
    ]
  }
}'

Install SAP HANA Agent on Database server​

Authorization

Request

Install SAP HANA Agent on Database server