post_systems

(POST)/system

Description

Adds a remote system to be managed by the caller, and included in its management "grid". The API handles all management of the hosts file so that the caller does not have to add the host file entry of the system before calling this API.

The caller must specify the username/password of the remote system before it can be added. If the user on the managed system has provided credentials to the manager, this API will succeed but the credentials will not be saved. Access privileges to the remote system are defined by the user privilege levels here. A user adding a manager must provide credentials with a user with at least administrative rights on the managed appliance.

Request

Syntax

POST api/systems
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Name	Description	Type	Required
name	system name	string	always
host	system hostname (probably the same as 'name')	string	always
ip	ip address of the system	string	optional

• | if provided, add/update the entry in the hosts file to associate the host with this ip address |
• | if not provided, the host must be resolvable | customer_id (1) | customer_id of the system | long | if not default customer location_id (1) | location_id of the system | long | if not default location credentials | use this credential entry when adding the system | array | optional | username | string | system username | password | string | system password

Note: Items marked by (1) are not in Release 1.0, nor are the customers resource and APIs to manage them. The UI will pass in a location id of 1 (the default) until multiple customers/locations are supported.

Response

Parameters

Examples

Sample Request

POST /api/systems
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

{
  "name": "AndrewXenUEB3-181-223",
  "ip": "192.168.181.223",
  "host": "AndrewXenUEB3-181-223",
  "credentials": {
    "username": "root",
    "password": "unitrends1"
  }
}

Sample Response

Successful creation of the new system:

HTTP Status: 201 (Created)

Failed system creation will return HTTP Status 500 with a result object with an error message and KB link as defined [here](API-Document#result-format)