...
- Navigate to {protocol}://{host:port}/DeviceManager/swagger-ui.html.
- Navigate to Device API and try to execute POST /device/add API to adds new device to the Device Manager database by providing valid input parameters for deviceDetailsRequest as defined in Device Manager API Documentation#DeviceDetailsRequest.
- POST /deviceModel/add API will return response as "SUCCESS" on successfully adding the device details to the device manager database.G
- Refer Device Manager API Documentation#Device page to get more details on the parameters provided and type of responses received for POST /device/add API.
- SSH login details can be configured through POST/device/add API .It is possible to add ssh connection details in extraproperties section of this API.
- The SSH connection details configured of particular ipAddress can be obtained by POST/device/sshDetailsByIpAddress API .
- Refer Device Manager API Documentation#Device page to get more details on the parameters provided and type of responses received for POST /device/sshDetailsByIpAddress API.
2. Configure Connected Client device details in Device Manager
...
Property Required | Description |
---|
username | User name to login to client device |
password | Password to login to client device |
connectionType | Expected valuevalues: "Wi-Fi" or "Ethernet" |
wifiCapability | Wifi Capability eg: Dual Band |
wifiMacAddress | Wifi Mac Address |
ethernetMacAddress | Ethernet mac address, which is same as value configured in field ecm mac address/estb mac address |
deviceIp | Ip address of the device, which is same as value configured in field estb ip address/ecm ip address |
devicePort | Tests can connect to client using deviceIp and devicePort |
osType | OS running in client. Eg: Linux, Windows |
nodePort | Node Port used for selenium connection |
![](/download/attachments/208046056/image2022-7-29_13-10-48.png?version=1&modificationDate=1659080448000&api=v2)
3. Configure device group in Automatics Orchestration.
...
- Steps to Configure device group in Automatics Orchestration is available at Automatics Orchestration Configure DeviceGroup.
- Steps to map device groups to user Automatics Orchestration User Manual#ManageUserGroupAccess
The steps for configuring connected clients is same as configuring standalone device except that it requires additional data like device login details etc.. to be included while adding the device.
- For connected clients, the additional data should be configured in extraProperties section while adding the client device.
Extra properties can be configured in 2 ways as shown below.
- Using Swagger UI
- The additional data related to device like serial port, login credentials etc... can be configured in extra properties section of the device.
- Please use the swagger API /device/update to update extra properties.
Image Added
- Update extraProperties filed with device extra properties as shown below.
Eg: “username”:”root”
Image Added
- Using Device Manager UI
- Following page will provide the steps to add or edit extra properties for a device using Device Manager UI tool.
Device Manager UI User Manual#EditDeviceExtraProperties