Looking Glass command set
draft-mst-lgapi-09

Document Type Active Internet-Draft (individual)
Last updated 2018-07-11 (latest revision 2018-06-25)
Stream ISE
Intended RFC status Informational
Formats plain text xml pdf html bibtex
Stream ISE state In ISE Review
Consensus Boilerplate Unknown
Document shepherd Adrian Farrel
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to Adrian Farrel <rfc-ise@rfc-editor.org>
Network Working Group                                         M. Stubbig
Internet-Draft                                               Independent
Intended status: Informational                             June 25, 2018
Expires: December 27, 2018

                       Looking Glass command set
                           draft-mst-lgapi-09

Abstract

   This document introduces a command set standard 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 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 https://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 December 27, 2018.

Copyright Notice

   Copyright (c) 2018 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
   (https://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
   include Simplified BSD License text as described in Section 4.e of

Stubbig                 Expires December 27, 2018               [Page 1]
Internet-Draft          Looking Glass command set              June 2018

   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.  Syntax Notation . . . . . . . . . . . . . . . . . . . . .   3
     1.3.  Examples  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Operation . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Method Parameters . . . . . . . . . . . . . . . . . . . .   4
     2.2.  Query Parameters  . . . . . . . . . . . . . . . . . . . .   4
     2.3.  Response  . . . . . . . . . . . . . . . . . . . . . . . .   6
   3.  Functions . . . . . . . . . . . . . . . . . . . . . . . . . .   8
     3.1.  Diagnostic commands . . . . . . . . . . . . . . . . . . .   8
     3.2.  Informational commands  . . . . . . . . . . . . . . . . .  10
     3.3.  Organizational commands . . . . . . . . . . . . . . . . .  14
     3.4.  Extensible commands . . . . . . . . . . . . . . . . . . .  16
   4.  Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . .  16
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  17
   6.  Security Consideration  . . . . . . . . . . . . . . . . . . .  17
     6.1.  Abuse Potential . . . . . . . . . . . . . . . . . . . . .  17
     6.2.  Authentication  . . . . . . . . . . . . . . . . . . . . .  17
     6.3.  Minimal information . . . . . . . . . . . . . . . . . . .  17
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  17
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  17
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  18
   Appendix A.  JSend  . . . . . . . . . . . . . . . . . . . . . . .  19
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  19

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 any
   target address of their choice.  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
   Looking Glass software packages has led to differences in the syntax,
   style, and information that are available.  The difference is of
   minor interest to human users, but accessing a Looking Glass web page
   by script is complicated, inefficient, and error-prone.
Show full document text