This URL adds a new device in the specified domain.
Resource URL
POST /domain/<domain_id>/device
Request Parameters
Payload Parameters:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| deviceId | Unique device id, not required for POST | String | Yes |
| deviceName | Device name | String | Yes |
| deviceType | Device type can be IPSNACSensor/ virtualHIPSensor/ NTBAAppliance/ loadBalancer | Object | Yes |
| contactInformation | Contact information for the device | String | No |
| location | Device location | String | No |
| lastModifiedTime | Last modified time of the device | String | No |
Details of IPSNACSensor:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| sharedSecret | Device shared secret key | String | Yes |
| confirmSharedSecret | Device confirmed shared secret key | String | Yes |
| updatingMode | Update mode can be ONLINE/ OFFLINE/ UNKNOWN | String | Yes |
Details of virtualHIPSensor:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| sharedSecret | Device shared secret key | String | Yes |
| confirmSharedSecret | Device confirmed shared secret key | String | Yes |
Details of NTBAAppliance:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| sharedSecret | Device shared secret key | String | Yes |
| confirmSharedSecret | Device confirmed shared secret key | String | Yes |
Details of loadBalancer:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| ipAddress | IP address | String | Yes |
| SNMPv3User | SNMP user name. Required for XC-240 | String | No |
| authenticationPassword | Authentication password. required for XC-240 | String | No |
| privacyPassword | Privacy password. Required for XC-240 | String | No |
| model | Load balancer model. Values can be XC-240 or XC-640 | String | Yes |
| user | Device username. Required for XC-640 | String | No |
| password | Device password. Required for XC-640 | String | No |
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
| Field Name | Description | Data Type |
|---|---|---|
| createdResourceId | Unique id of the created device | Number |
Example
Request
POST https://%3CNSM_IP%3E/sdkapi/domain/0/device
{
"deviceName": "Load_BALANCER",
"deviceType": {
"virtualHIPSensor": null,
"loadBalancer": {
"ipAddress": "1.1.1.1",
"SNMPv3User": "SNMP",
"authenticationPassword": "admin123",
"privacyPassword": "admin123"
"model": "XC-240"
}
},
"contactInformation": "Contact_Infor",
"location": "Location",
"LastModifiedTime": "Mon Jul 22 20:05:00 IST 2013"
} Response
{
"createdResourceId":1006
} Error Information
Following error codes are returned by this URL:
| S.No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
| 1 | 404 | 1105 | Invalid domain |
| 2 | 400 | 4601 | Device name is required |
| 3 | 400 | 4602 | Device name should not be greater than 25 chars |
| 4 | 400 | 4603 | Shared secret is required |
| 5 | 400 | 4604 | Confirm shared secret is required |
| 6 | 400 | 4605 | Shared secret does not match |
| 7 | 400 | 4609 | SNMPv3 username is required |
| 8 | 400 | 4610 | Authentication password is required |
| 9 | 400 | 4611 | Privacy password is required |
| 10 | 400 | 4612 | Password should not be less than 8 chars |
| 11 | 400 | 4613 | Name must contain only letters, numerical, dot, hyphens or underscore |
| 12 | 400 | 4614 | Device name already exists |
| 13 | 400 | 4615 | IP address already exists |
| 14 | 400 | 4616 | Device profile provided is not up to date |
| 15 | 400 | 4617 | Location should not be greater than 25 chars |
| 16 | 400 | 4618 | Location must contain only letters, numerical, dot, hyphens or underscore |
| 17 | 400 | 4619 | Contact should not be greater than 25 chars |
| 18 | 400 | 4620 | Location must contain only letters, numerical, dot, hyphens or underscore |
| 19 | 400 | 4621 | Shared secret should not be greater than 25 chars |