Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Specifying Information About a Remote Device

    You use the Device Management Service API on the central server to add information about each device that Network Activator initially provisions. Specify information for devices when you:

    • First set up Network Activator.
    • Deliver a new device to an end user.

    This procedure uses the following Device Management Service API:
    https://server-IP-address/dms-central/add_model_device

    Table 1 shows the fields that you must specify for this procedure.

    Table 1: Required Fields for Specifying Information About a Device to Network Activator

    Field

    Description

    Example

    region

    Name of the network region in which the device resides.

    regionOne

    device_info: name

    Hostname of device

    device-4

    device_info: activation_info: booting_uuid

    UUID of Image, which the Image Management Service API returns when you upload the image.

    f0a044a0-48f9-4de4-b125-9da6ea1006cb

    device_info: activation_info: activation_code_enabled

    Requirement for password authentication:

    • True—device must submit a password (equal to the activation code) for each request it makes to the regional server.
    • False—regional server does not require device to use a password when it sends requests.

    True

    device_info: activation_info: activation_code

    Generated password that device must submit for authentication when it sends requests to the regional server. If this field is empty, and you set the activation_code_enabled field to True, the API call returns an activation code that you must give to the end user.

    -code

    device_info: activation_info: serial

    Serial number of the device, which can be found on its hardware label.

    device-sn-4

    device_info: activation_info: family

    Product family associated with the image.

    srx

    device_info: activation_info: vendor

    Name of vendor for the image.

    juniper

    device_info: activation_info: stageone_config: concrete_type: concrete_config

    Description of initial configuration in XML format.

    <device default configuration/>

    To add a device:

    • On the central server, issue a REST call to add a device.

      The API returns a message indicating whether the operation was successful.
      For example:

      user@host:~$ curl -k -H "Content-Type: application/json" -X POST -d '{"input":{"region":"regionOne",
      "device_info":[{"name":"device-4","activation_info":{"bootimg_uuid":"f0a044a0-48f9-4de4-b125-9da6ea1006cb",
      "activation_code_enabled":"True","activation_code":"right-code"},"serial":"device-sn-4","family":"srx","platform":
      "srx","vendor":"juniper","stageone_config":{"config_type":{"concrete_type":{"concrete_config":"<device default configuration/>"}}}}]}}'
      H "X-AUTH-TOKEN:$OS_TOKEN" https://10.155.90.203/dms-central/add_model_device
      {"output": {"device_ids": [{"fqname": ["default-domain", "default-project", "device-4"], "reason": null, "response": "SUCCESS"}]}}

    Caution: When you have completed the setup tasks, you must also add the device to the Redirect tool and assign a regional server to it. Otherwise, initial provisioning of the remote device fails.

    Modified: 2016-10-19