TechLibrary

Table of Contents

Guide That Contains This Content

[+] Expand All

[-] Collapse All

Get Information About a Device

Use this API to retrieve information such as serial number, hostname, and associated organization, of a specific device.

URI

https://[host]/api/juniper/servicenow/device-management/devices/{id} (HTTP method = GET)

URI Parameters

Parameter	Type	Required	Description
id	Integer	Yes	ID of the device for which information is to be retrieved

Consumes

None

Produces

application/vnd.juniper.servicenow.device-management.device+xml;version=7
application/vnd.juniper.servicenow.device-management.device+json;version=7

Response Elements

Element	Type	Description
uri	String	URI of the device
hostName	String	Hostname of the device
serialNumber	String	Serial number of the device
product	String	Product name of the device
softwareRelease	String	Release number of the Junos OS software installed on the device
scriptBundle	String	Version of the script bundle installed on the device
routingEngine	String	Routing Engine model used in the device
osPlatform	String	Operating system installed on the device
eventProfileInstalltionStatus	String	Status of event profile installation on the device For an end customer, this element is set to Not Applicable.
connectionStatus	String	Status of the connection between device and Juniper Support Systems (JSS) For an end-customer device, this element is set to Not Applicable.
ipAddr	String	IP address of the device
deviceFamily	String	Device family to which the device belongs
domain-id	Integer	ID of the Junos Space domain to which the device belongs
domain-name	String	Domain to which the device belongs
rsiFileCollectionConfiguration	String	Request Support Information (RSI) file collection configuration on the device
logFileCollectionConfiguration	String	Log file collection configuration on the device
organization	String	Organization to which the device belongs
deviceGroup	String	Device group to which the device belongs
message	String	Error messages generated on the device; for example, message when there is an error in deleting JMB files from the device while copying the JMB files to Service Now
installed-profile	String	Event profile installed on the device
device-analysis	String	Specifies details such as of Routing Engine, status of BIOS validation, and the time BIOS validation was performed
method	String	A method applicable to the device

Sample Output

Sample XML Output

<device uri="/api/juniper/servicenow/device-management/devices/65545">
   <hostName>mx-480-sn2</hostName>
   <serialNumber>JN11742FFAFB</serialNumber>
   <product>MX480</product>
   <softwareRelease>12.3R6.6</softwareRelease>
   <scriptBundle>4.1R2.4</scriptBundle>
   <routingEngine>Dual RE</routingEngine>
   <eventProfileInstalltionStatus>Event profile successfully installed on both Routing Engines</eventProfileInstalltionStatus>
   <osPlatform>junos</osPlatform>
   <ipAddr>192.0.2.127</ipAddr>
   <deviceFamily>junos</deviceFamily>
   <domain-id>2</domain-id>
   <domain-name>Global</domain-name>
   <rsiFileCollectionConfiguration>Collect, if not collected within 5 minutes.</rsiFileCollectionConfiguration>
   <logFileCollectionConfiguration>Always collect</logFileCollectionConfiguration>
   <organization href="/api/juniper/servicenow/organization-management/organization/65541">
      <id>65541</id>
      <name>TestOrg</name>
   </organization>
   <deviceGroup href="/api/juniper/servicenow/device-group-management/deviceGroup/65542">
      <id>65542</id>
      <name>Default for TestOrg</name>
   </deviceGroup>
   <installed-profile href="/api/juniper/servicenow/event-profile-management/eventProfiles/33654">
      <id>33654</id>
      <profileName>Base_Profile_4_1R2_4</profileName>
      <scriptBundleName>jais-4.1R2.4-signed.tgz</scriptBundleName>
      <scriptBundleVersion>4.1R2.4</scriptBundleVersion>
   </installed-profile>
   <device-analysis>
      <bios-validations uri="/api/juniper/servicenow/device-management/devices/65545/BIOSValidations" size="1">
         <biosValidation href="/api/juniper/servicenow/device-analysis/BIOSValidations/786446" key="786446">
            <entity>re0</entity>
            <status>Case Created</status>
            <occurred>2014-12-17 20:37:37 IST</occurred>
         </biosValidation>
      </bios-validations>
   </device-analysis>
   <id>65545</id>
   <method href="/api/juniper/servicenow/device-management/devices/65545/installEventProfile"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/uninstallEventProfile"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/exportDevice"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/associateDeviceGroup"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/exportDeviceInventory"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/requestRMAIncident"/>
   <domain href="/api/space/domain-management/domains/2"/>
   <method href="/api/juniper/servicenow/device-management/devices/65545/configureFileCollection"/>
<method href="/api/juniper/servicenow/device-management/devices/65545/ configureBIOSValidation"/></device>

Sample JSON Output

{
  "device": {
    "@uri": "/api/juniper/servicenow/device-management/devices/65545",
    "hostName": "mx-480-sn2",
    "serialNumber": "JN11742FFAFB",
    "product": "MX480",
    "softwareRelease": "12.3R6.6",
    "scriptBundle": "4.1R2.4",
    "routingEngine": "Dual RE",
    "eventProfileInstalltionStatus": "Event profile successfully installed on both Routing Engines",
    "osPlatform": "junos",
    "ipAddr": "192.0.2.127",
    "deviceFamily": "junos",
    "domain-id": 2,
    "domain-name": "Global",
    "rsiFileCollectionConfiguration": "Collect, if not collected within 5 minutes.",
    "logFileCollectionConfiguration": "Always collect",
    "organization": {
      "@href": "/api/juniper/servicenow/organization-management/organization/65541",
      "id": 65541,
      "name": "TestOrg"
    },
    "deviceGroup": {
      "@href": "/api/juniper/servicenow/device-group-management/deviceGroup/65542",
      "id": 65542,
      "name": "Default for TestOrg"
    },
    "installed-profile": {
      "@href": "/api/juniper/servicenow/event-profile-management/eventProfiles/33654",
      "id": 33654,
      "profileName": "Base_Profile_4_1R2_4",
      "scriptBundleName": "jais-4.1R2.4-signed.tgz",
      "scriptBundleVersion": "4.1R2.4"
    },
    "device-analysis": {
      "bios-validations": {
        "@uri": "/api/juniper/servicenow/device-management/devices/65545/BIOSValidations",
        "@size": "2",
        "biosValidation": [
          {
            "@href": "/api/juniper/servicenow/device-analysis/BIOSValidations/786446",
            "@key": "786446",
            "entity": "re0",
            "status": "Case Created",
            "occurred": "2014-12-17 20:37:37 IST"
          },
          {
            "@href": "/api/juniper/servicenow/device-analysis/BIOSValidations/786473",
            "@key": "786473",
            "entity": "re1",
            "status": "Pending Submission",
            "occurred": "2014-12-17 20:37:06 IST"
          }
        ]
      }
    },
    "id": 65545,
    "method": [
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/installEventProfile"
      },
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/uninstallEventProfile"
      },
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/exportDevice"
      },
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/associateDeviceGroup"
      },
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/exportDeviceInventory"
      },
      {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/requestRMAIncident"
      },
     "domain": {
      "@href": "/api/space/domain-management/domains/2"
    }
    {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/configureFileCollection"
      }
    {
        "@href": "/api/juniper/servicenow/device-management/devices/65545/configureBIOSValidation"
      }

  }
}

Error Codes

Message	Description
204 No Content	No devices found

TechLibrary

Related Documentation

Get Information About a Device

Related Documentation

Modified: 2016-08-09