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

    Get Upload Status of Device Snapshot Attachments

    Use this API to retrieve details of all attachments of a device snapshot or iJMB and the upload status of the attachments.

    URI

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

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    String

    Yes

    ID of the iJMB for which details of attachments are to be retrieved

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.devicesnapshot-management.devicesnapshot+ xml;version=2
    • application/vnd.juniper.servicenow.devicesnapshot-management.devicesnapshot+ json;version=2

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the iJMB

    id

    Integer

    ID of the iJMB

    connectedMemberName

    String

    Name of end customer from whom the iJMB was received if Service Now is operating in Partner Proxy mode

    status

    String

    Status of uploading the iJMB to Juniper Support System (JSS) or Service Now partner (if operating in Partner Proxy mode

    Possible values:

    • Uploaded—The iJMB is uploaded
    • In Progress—The iJMB is in the process of being uploaded
    • Not Submitted—The iJMB is not yet uploaded
    • Skipped—Upload of iJMB to JSS or Service Now partner is skipped
    • Failed—The iJMB failed to be uploaded

    eventType

    String

    Event type of the iJMB

    defectType

    String

    Type of defect that generated the iJMB.

    problemSynopsis

    String

    Synopsis of the iJMB

    caseCreationUserName

    String

    User who submitted the iJMB for creating a case to JSS

    siteId

    String

    Site ID in JSS with which the iJMB is associated

    followUpMethod

    String

    Follow-up method for the iJMB submitted

    Possible Values:

    • EMAIL_FULL_TEXT
    • EMAIL_SECURE_LINK
    • PHONE_CALL

    customerTrackingNumber

    String

    Tracking number assigned to the case created for the iJMB submitted

    incidentType

    String

    Type of Incident

    Possible values:

    • Event—Case created for events that occurred on devices
    • Event RMA—Case created for Return Materials Authorization (RMA) events that occurred on devices
    • On-demand—Case created for on-demand incidents
    • On-demand RMA—Case created for on-demand RMA incidents
    • BIOS Health Check—Case created for analyzing BIOS running on devices
    • AIS Health Check—Case created for AIS health check event on devices
    • Event (Low End)—Case created for events that occurred on low end devices, such as SRX100 and SRX220
    • Other—Case created for events not reported through Service Now

    priority

    String

    Priority of the case created for the submitted iJMB

    Possible values:

    • 1 - Critical
    • 2 - High
    • 3 - Medium
    • 4 - Low

    severity

    String

    Severity of the case created for the submitted iJMB

    Possible values:

    • Critical
    • High
    • Medium
    • Low

    owner

    String

    User assigned to the case for ownership

    policy

    String

    Auto submit policy used for submitting the iJMB

    autoSubmitted

    String

    Flag to specify if the iJMB was submitted by using an auto submit policy

    Possible values

    • true—The iJMB was submitted automatically to JSS or Service Now partner
    • false—The iJMB was not submitted automatically to JSS or Service Now partner

    flaggedUsers

    String

    Users to whom the information about the iJMB is flagged

    filterLevel

    String

    Filter applied to JMB before sending to JSS.

    Possible Values:

    • Do not send—Device configuration information is not sent.
    • Send all information except configuration—All device information except the configuration information is sent.
    • Send all information with IP Addresses overwritten—Device information is sent with IP addresses overwritten by asterisk (*).
    • Send all information—All information retrieved from a device is sent to JSS as is.
    • Only send list of features used—Only the device configuration information is sent.

    caseCCList

    email

    Collection of e-mail IDs of users to whom the information about the iJMB is copied

    problemDescription

    String

    Problem description in the iJMB

    organizationName

    String

    Name of the organization associated with the iJMB

    deviceGroupName

    String

    Name of the device group associated with the iJMB

    prbIdentifier

    String

    ID of the event that led to the creation of the iJMB

    KBArticle

    String

    KB article associated with the iJMB

    link

    String

    Link to the case in Case Manager

    id

    Integer

    ID of the iJMB

    attachmentName

    String

    Name of the attachment file of the iJMB

    command

    String

    show command

    The attachment file contains the output of the show command

    size

    long

    Size of the attachment in Bytes

    readStatus

    String

    Read status of the attachment file

    Possible values:

    • Not Received—The attachment file is not yet read by Service Now
    • Success—Service Now collected the attachment file successfully
    • Failure—Service Now failed to read the attachment file on the device
    • No Longer Available—The attachment file is no longer available on the device

    uploadStatus

    String

    Upload status of the attachment file

    Possible values:

    • Not Uploaded—The attachment file is not uploaded to JSS.
    • Uploading—The attachment file is in the process of uploading to JSS.
    • Success—The attachment file is successfully uploaded to JSS.
    • Failure—Upload of the attachment file to JSS failed.

    readFailReason

    String

    Reason for failure to read the attachment from the device

    Id

    Integer

    ID of the device from the iJMB was collected

    serialNumber

    String

    Serial Number of the device from which the iJMB was collected

    ipAddr

    String

    IP address of the device

    product

    String

    Product type of the device

    platform

    String

    Operating OS used on the device

    hostName

    String

    Hostname of the device

    release

    String

    Junos OS release installed on the device

    version

    String

    Version of the Junos OS release installed on the device

    method

    String

    Method applicable to the iJMB

    Sample Output

    Sample XML Output

    <devicesnapshot uri="/api/juniper/servicenow/devicesnapshot-management/ devicesnapshots/68739">
      <id>68739</id>
      <status>Not Submitted(Not submitted:  Device Snapshots are submitted every seven days)</status>
      <siteId>0100000151</siteId>
      <filterLevel>Send all information with IP addresses overwritten</filterLevel>
      <organizationName>Test-Organization-PBN</organizationName>
      <deviceGroupName>Device Group for Test-Organization-PBN</deviceGroupName>
      <prbIdentifier>mx-480-sn2-998-20151011-221433-998</prbIdentifier>
      <attachments>
        <attachment>
          <attachmentName>/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach _AISESI</attachmentName>
          <command>multiple</command>
          <size>77586</size>
          <readStatus>Not Received</readStatus>
          <uploadStatus>Not Uploaded</uploadStatus>
        </attachment>
        <attachment>
          <attachmentName>/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach _3_cfg_xml</attachmentName>
          <command>show configuration | display inheritance | display xml | except password | except secret | except -key | except ssh-rsa | except community-name</command>
          <size>-1</size>
          <readStatus>Not Received</readStatus>
          <uploadStatus>Not Uploaded</uploadStatus>
        </attachment>
        <attachment>
          <attachmentName>/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach  _4_shd_xml</attachmentName>
          <command>show chassis hardware (detail) | display xml</command>
          <size>7924</size>
          <readStatus>Success</readStatus>
          <uploadStatus>Not Uploaded</uploadStatus>
          <readFailReason>
          </readFailReason>
        </attachment>
        <attachment>
          <attachmentName>/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach _5_ver_xml</attachmentName>
          <command>show version | display xml</command>
          <size>7974</size>
          <readStatus>Success</readStatus>
          <uploadStatus>Not Uploaded</uploadStatus>
          <readFailReason>
          </readFailReason>
        </attachment>
        <attachment>
          <attachmentName>/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach _statusmsgs</attachmentName>
          <command>N/A</command>
          <size>27</size>
          <readStatus>Not Received</readStatus>
          <uploadStatus>Not Uploaded</uploadStatus>
        </attachment>
      </attachments>
      <device href="/api/juniper/servicenow/device-management/devices/65546">
        <id>65546</id>
        <serialNumber>JN11742FFAFB</serialNumber>
        <ipAddr>192.0.2.127</ipAddr>
        <product>MX480</product>
        <platform>junos</platform>
        <hostName>mx-480-sn2</hostName>
        <release>12.3R6.6</release>
        <version>R6</version>
      </device>
      <method href="/api/juniper/servicenow/devicesnapshot-management/devicesnapshots /68739/export"/>
      <method href="/api/juniper/servicenow/devicesnapshot-management/devicesnapshots /68739/downloadAllAttachments"/>
    </devicesnapshot>
    

    Sample JSON Output

    {
      "devicesnapshot": {
        "@uri": "/api/juniper/servicenow/devicesnapshot-management/devicesnapshots/68739",
        "id": 68739,
        "    "status": "Not Submitted(Not submitted:  Device Snapshots are submitted every seven days",
        "siteId": "0100000151",
        "filterLevel": "Send all information with IP addresses overwritten",
        "organizationName": "Test-Organization",
        "deviceGroupName": "Device Group for Test-Organization-PBN",
        "prbIdentifier": "	mx-480-sn2-998-20151011-221433-998",
        "attachments": {
          "attachment": [
            {
              "attachmentName": "/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach_AISESI",
              "command": "multiple",
              "size": 77586,
              "readStatus": "Not Received",
              "uploadStatus": "Not Uploaded",
              "readFailReason": ""
            },
            {
              "attachmentName": "/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach_3_cfg_xml",
              "command": "show configuration | display inheritance | display xml | except password | except secret | except -key | except ssh-rsa | except community-name",
              "size": -1,
               "readStatus": "Not Received",
              "uploadStatus": "Not Uploaded",
    
              "readFailReason": ""
            },
    {
              "attachmentName": "/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach_4_shd_xml",
              "command": "show chassis hardware (detail) | display xml",
              "size": 7924,
               "readStatus": "Success",
              "uploadStatus": "Uploaded",
    
              "readFailReason": ""
            },
    {
              "attachmentName": "/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach_5_ver_xml",
              "command": "36.	show version | display xml",
              "size": 7974,
               "readStatus": "Success",
              "uploadStatus": "Not Uploaded",
    
              "readFailReason": ""
            },
    {
              "attachmentName": "/var/tmp/mx-480-sn2-998-20151011-221433_ais_attach_statusmsgs",
              "command": "N/A",
              "size": 27,
               "readStatus": "Not Received",
              "uploadStatus": "Not Uploaded",
    
              "readFailReason": ""
            },
        "device": {
          "@href": "/api/juniper/servicenow/device-management/devices/65546",
          "id": 65546,
          "serialNumber": "	JN11742FFAFB",
          "ipAddr": "192.0.2.127",
          "product": "MX460",
          "platform": "junos",
          "hostName": "mx-460-sn2",
          "release": "12.3R6.6"
    	     “version” “R6”,
        },
        "method": {
          "@href": "/api/juniper/servicenow/devicesnapshot-management/devicesnapshots/	68739/export"
        }
     "method": {
          "@href": "/api/juniper/servicenow/devicesnapshot-management/devicesnapshots/68739/downloadAllAttachments"
        }
      }
    }
    
    

    Modified: 2016-08-11