Looking Glass API
draft-mst-lgapi-05

Document Type Active Internet-Draft (individual)
Last updated 2016-11-14
Stream ISE
Intended RFC status Informational
Formats plain text xml pdf html bibtex
Stream ISE state Finding Reviewers
Consensus Boilerplate Unknown
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         M. Stubbig
Internet-Draft                                               Independent
Intended status: Informational                         November 14, 2016
Expires: May 18, 2017

                           Looking Glass API
                           draft-mst-lgapi-05

Abstract

   This document introduces an application programming interface (API)
   to the web-based "Network Looking Glass" software.  Its purpose is to
   provide application programmers uniform access to the Looking Glass
   service and to analyze standardized response.

   The API interface is supposed to provide the same level of
   information as web-based interfaces, but in a computer-readable
   format.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on May 18, 2017.

Copyright Notice

   Copyright (c) 2016 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must

Stubbig                   Expires May 18, 2017                  [Page 1]
Internet-Draft              Looking Glass API              November 2016

   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Background  . . . . . . . . . . . . . . . . . . . . . . .   3
     1.2.  Terminology . . . . . . . . . . . . . . . . . . . . . . .   3
     1.3.  Syntax Notation . . . . . . . . . . . . . . . . . . . . .   3
     1.4.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Operation . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     2.1.  Method Parameters . . . . . . . . . . . . . . . . . . . .   4
     2.2.  Query Parameters  . . . . . . . . . . . . . . . . . . . .   4
     2.3.  Response  . . . . . . . . . . . . . . . . . . . . . . . .   6
   3.  API functions . . . . . . . . . . . . . . . . . . . . . . . .   8
     3.1.  Diagnostic commands . . . . . . . . . . . . . . . . . . .   8
     3.2.  Informational commands  . . . . . . . . . . . . . . . . .   9
     3.3.  Administrative commands . . . . . . . . . . . . . . . . .  10
     3.4.  Extensible commands . . . . . . . . . . . . . . . . . . .  13
   4.  Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . .  13
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  13
   6.  Security Consideration  . . . . . . . . . . . . . . . . . . .  13
     6.1.  Abuse Potential . . . . . . . . . . . . . . . . . . . . .  13
     6.2.  Authentication  . . . . . . . . . . . . . . . . . . . . .  14
     6.3.  Minimal information . . . . . . . . . . . . . . . . . . .  14
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  14
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  14
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  15
   Appendix A.  JSend  . . . . . . . . . . . . . . . . . . . . . . .  15
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  16

1.  Introduction

   Many Internet service providers (ISPs) and Internet exchange points
   (IXPs) offer a complimentary web page to the general public, which
   gives insights to the backbone routing table, BGP neighbor
   information, or offered routes.

   The visitor may also execute a ping or traceroute command to a random
   target address.  Some ISPs even offer information about their
   multicast routing table including the mtrace command.  The amount and
   type of offered information is not limited.

   The service is mostly used for the purpose of troubleshooting and is
   known under the term of "Looking Glass".  The development of various
Show full document text