Looking Glass Command Set
RFC 8522
| Document | Type |
RFC - Informational
(February 2019; No errata)
Was draft-mst-lgapi (individual)
|
|
|---|---|---|---|
| Last updated | 2019-02-05 | ||
| Stream | ISE | ||
| Formats | plain text pdf htmlized bibtex | ||
| IETF conflict review | conflict-review-mst-lgapi | ||
| Stream | ISE state | Published RFC | |
| Consensus Boilerplate | Unknown | ||
| Document shepherd | Adrian Farrel | ||
| Shepherd write-up | Show (last changed 2018-09-16) | ||
| IESG | IESG state | RFC 8522 (Informational) | |
| Telechat date | |||
| Responsible AD | (None) | ||
| Send notices to | Adrian Farrel <rfc-ise@rfc-editor.org> | ||
| IANA | IANA review state | Version Changed - Review Needed | |
| IANA action state | RFC-Ed-Ack | ||
Independent Submission M. Stubbig
Request for Comments: 8522 Independent
Category: Informational February 2019
ISSN: 2070-1721
Looking Glass Command Set
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 a 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 document is not an Internet Standards Track specification; it is
published for informational purposes.
This is a contribution to the RFC Series, independently of any other
RFC stream. The RFC Editor has chosen to publish this document at
its discretion and makes no statement about its value for
implementation or deployment. Documents approved for publication by
the RFC Editor are not candidates for any level of Internet Standard;
see Section 2 of RFC 7841.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
https://www.rfc-editor.org/info/rfc8522.
Copyright Notice
Copyright (c) 2019 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.
Stubbig Informational [Page 1]
RFC 8522 Looking Glass Command Set February 2019
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Background . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Syntax Notation . . . . . . . . . . . . . . . . . . . . . 3
1.3. Examples . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Operation . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Method Parameters . . . . . . . . . . . . . . . . . . . . 4
2.2. Query Parameters . . . . . . . . . . . . . . . . . . . . 5
2.3. Response . . . . . . . . . . . . . . . . . . . . . . . . 6
3. Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1. Diagnostic Commands . . . . . . . . . . . . . . . . . . . 9
3.2. Informational Commands . . . . . . . . . . . . . . . . . 10
3.3. Organizational Commands . . . . . . . . . . . . . . . . . 14
3.4. Extensible Commands . . . . . . . . . . . . . . . . . . . 16
4. Miscellaneous . . . . . . . . . . . . . . . . . . . . . . . . 16
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17
5.1. Well-Known URIs Registry . . . . . . . . . . . . . . . . 17
6. Security Considerations . . . . . . . . . . . . . . . . . . . 17
6.1. Abuse Potential . . . . . . . . . . . . . . . . . . . . . 17
6.2. Authentication . . . . . . . . . . . . . . . . . . . . . 17
6.3. Minimal Information . . . . . . . . . . . . . . . . . . . 17
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 18
7.1. Normative References . . . . . . . . . . . . . . . . . . 18
7.2. Informative References . . . . . . . . . . . . . . . . . 19
Appendix A. JSend . . . . . . . . . . . . . . . . . . . . . . . 20
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 20
1. Introduction
Many Internet service providers (ISPs) and Internet exchange points
(IXPs) offer a complimentary web-based service to their customers and
the general public that gives insights to the backbone routing table,
BGP neighbor information, or offered routes. This service is known
as a "Network Looking Glass". Because they utilize a web-based
interface, it is hard to automate access to the services and make
that automation transferable between different service
implementations.
This document describes a common command set to provide application
programmers uniform access to Looking Glass services.
The commands are intended to provide the same level of information as
available via web-based interfaces, but to do so in a computer-
readable format. The intention is that multiple implementers of
Looking Glass services can provide access through these commands so
that an application can make use of the different implementations.
Stubbig Informational [Page 2]
RFC 8522 Looking Glass Command Set February 2019
The command set is split into the following categories: mandatory to
Show full document text