Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

The steps for configuring connected clients is same as configuring standalone device as mentioned in section 1. Configure device details in Device Manager, except that it requires additional data like device login details etc to be included while adding the device.

  1. While adding connected client devices, ensure that all devices under the same setup are mapped with same account id. During connected client test execution, devices are fetched based on account id and this can be used to identify each connected client setup.
  2. For connected clients, the additional data should be configured in extraProperties section while adding the client device.

For eg: For wifi clients, the extra properties should have following fields.

Wifi Clients

Property RequiredDescription
usernameUser name to login to client device
passwordPassword to login to client device
connectionTypeExpected values: "Wi-Fi" or "Ethernet"
wifiCapabilityWifi Capability eg: Dual Band
wifiMacAddressWifi Mac Address
ethernetMacAddressEthernet mac address, which is same as value configured in field ecm mac address/estb mac address
deviceIpIp address of the device, which is same as value configured in field estb ip address/ecm ip address
devicePortTests can connect to client using deviceIp and devicePort
osTypeOS running in client. Eg: Linux, Windows
nodePortPort used for selenium connection


Image Added

3. Configure device group in Automatics Orchestration.

For Automatics to use devices from partner's inventory, device groups have to be configured. The device group name in inventory should be added here so that user can execute tests on devices within these groups only. Admin user can map device groups to users so that only those users mapped to device group can execute tests on device.


Device Extra Properties Configuration

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