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

    View Commands Used for Collecting Additional Information for an Incident

    Use this API to view the commands executed for collecting additional information for an incident in Junos Space Service Now.

    URI

    https://[host]/api/juniper/servicenow/incident-management/incidents/{incidentId}/ viewAdditionalInformation (HTTP method = GET)

    URI Parameters

    Element

    Type

    Required

    Description

    incidentId

    Integer

    Yes

    ID of the incident for which you want to view the commands used for collecting additional information

    Consumes

    None

    Produces

    • application/vnd.juniper.servicenow.incident-management.incident. viewAdditionalInformation+xml;version=1
    • application/vnd.juniper.servicenow.incident-management.incident. viewAdditionalInformation+json;version=1

    Response Elements

    Element

    Type

    Description

    cliCommand

    String

    CLI commands executed to collect additional information

    jobInstanceId

    Integer

    ID of the collect additional information job

    jobStatus

    Boolean

    Status of the collect additional information job

    Possible values

    • Success
    • Failed

    owner

    String

    User who initiated or configured the collect additional information job

    fileName

    String

    Name of the file in which additional information is collected

    scheduledTime

    String

    Date and Time (in the yyyy-mm-dd hh:mm:ss format) additional information was collected for an incident

    Sample Output

    Sample XML Output

    <viewAdditionalCommands>
    <viewAdditionalCommand>
    <cliCommand>
    show system processes extensive no-forwarding show pfe statistics error show system virtual-memory no-forwarding show system queues no-forwarding show system statistics no-forwarding
    </cliCommand>
    <jobInstanceId>1343518</jobInstanceId>
    <jobStatus>Success</jobStatus>
    <owner>super</owner>
    <fileName>
    additional_cli_information_sn-space-mx240-sys_20170613-063247278.txt
    </fileName>
    <scheduledTime>2017-06-13 06:32:46.546</scheduledTime>
    </viewAdditionalCommand>
    </viewAdditionalCommands>

    Sample JSON Output

    {
      "viewAdditionalCommands": {
        "viewAdditionalCommand": {
          "cliCommand": "show system processes extensive no-forwarding show system statistics no-forwarding",
          "jobInstanceId": 1343518,
          "jobStatus": "Success",
          "owner": "super",
          "fileName": "additional_cli_information_sn-space-mx240-sys_20170613-063247278.txt",
          "scheduledTime": "2017-06-13 06:32:46.546"
        }
      }
    }

    Modified: 2017-07-18